Differences

This shows you the differences between two versions of the page.

--- scripting:reference:system_functions:buildinginformationfunctions [2020/01/29 05:21] – mit
+++ scripting:reference:system_functions:buildinginformationfunctions [2023/08/22 10:42] (current) – [Building Information Functions] mit
@@ Line 2: / Line 2: @@
 System functions that provide information about a building and its contents, and allow you to control the building UI.
+Unless otherwise stated, these functions refer to the building currently being accessed by the player. (This can be overriden using SetBuildingContext).
 ==== sysAmountInStocks ====
-^ Format | sysAmountInStocks( [Item_Name or Num] )|
+^ Format | sysAmountInStocks( Item_Name_or_Num )|
 ^ Description | Returns the amount of the item currently in the building's stocks |
-^ Parameters | Item Name or number |
 ^ Example | ''**$amountInBuilding = sysAmountInStocks("Wood")**'' |
+==== sysMaxAmountInStocks ====
+^ Format | sysMaxAmountInStocks ( Item_Name_or_Num )|
+^ Description | Returns the maximum amount of the item currently allowed in the building's stocks. (This value is set in the building editor tool, or can be manually lowered by the building owner) |
+^ Example | ''**$maxAmountInBuilding = sysMaxAmountInStocks("Wood")**'' |
 ==== sysGetBuyPrice ====
-^ Format | sysGetBuyPrice [Item] ) |
+^ Format | sysGetBuyPrice( Item ) |
 ^ Description | Returns the 'Buy Price' set for this item in the currently accessed building |
-^ Parameters | Item name or number  |
 ^ Returns | 'Buy Price' of the item in denari |
 ^ Notes | Related commands: *setbuyprice [BuildingID] [Item] [Price] |
@@ Line 22: / Line 27: @@
     osdcreate( OSDBUILDING, "BakeryOSD", "Bakery" )
-    osdaddat( 200, 100, 200, 40, "Sell|Flour", "Buying flour ($buyPriceText)" )
+    osdadd( 200, 100, 200, 40, "Sell|Flour", "Buying flour ($buyPriceText)" )
     osdactivate()
 }
@@ Line 29: / Line 34: @@
 ==== sysGetSellPrice ====
-^ Format | sysGetSellPrice( [Item_Name or Num] )|
+^ Format | sysGetSellPrice( Item_Name_or_Num )|
-^ Description | Returns the price that the item is currently set for sale at (Or 0 if it is not currently for sale) |
+^ Description | Returns the price that the item is currently set for sale at (Or 0 if it is not currently for sale)
-^ Parameters | Item Name or number |
+^ Returns | Price of the item in denari |
 //Example//:
 <note>
@@ Line 40: / Line 45: @@
     if ( $woodSellPrice == 0 )
     {
-        osdaddat( TEXT, 100, 100, 400, 0, "", "Not currently selling wood" )
+        osdadd( TEXT, 100, 100, 400, 0, "", "Not currently selling wood" )
     }
     else
     {
         $woodSellPriceText = sysGetPriceText( $woodSellPrice )
-        osdaddat( TEXT, 100, 100, 400, 0, "", "Currently selling wood at $woodSellPriceText" )
+        osdadd( TEXT, 100, 100, 400, 0, "", "Currently selling wood at $woodSellPriceText" )
     }
     osdactivate()
@@ Line 52: / Line 57: @@
 </note>
 ==== sysGetEmployeeID ====
-^ Format | sysGetEmployeeID( [Index] ) |
+^ Format | sysGetEmployeeID( Index ) |
 ^ Description | Returns the employee player ID for the currently accessed building. Buildings can have up to 16 employees. |
-^ Parameters | Index (0 - 15) |
 ^ Returns | PlayerID of the employee or 0 if none is set for this index |
+^ Notes | Buildings currently have 16 possible slots for employees, index parameter is 0 - 15 |
 //Example//:<note>
 <code>Event( "AccessBuilding", "13" )
@@ Line 64: / Line 69: @@
     {
         $employeeName = sysGetPlayerName( $employeeID )
-        osdaddat( TEXT, 100, 100, 400, 0, "", "Employee : $employeeName" )
+        osdadd( TEXT, 100, 100, 400, 0, "", "Employee : $employeeName" )
     }
     else
     {
-        osdaddat( TEXT, 100, 100, 400, 0, "", "There is no-one currently employed at this building" )
+        osdadd( TEXT, 100, 100, 400, 0, "", "There is no-one currently employed at this building" )
     }
     osdactivate()
@@ Line 77: / Line 82: @@
 ==== sysGetBuildingName ====
-^ Format | sysGetBuildingName( [BuildingID] ) |
+^ Format | sysGetBuildingName( BuildingID ) |
 ^ Description | Returns the building name for a particular ID |
-^ Parameters | Building ID number  |
 ^ Returns | The building name |
 //Example//:<note>
@@ Line 95: / Line 99: @@
 TBD\\
-==== sysBuildingActivateStockroom ====
+==== sysBuildingGetSoldItem ====
-==== sysBuildingActivateBuyItem ====
+==== sysBuildingGetMadeItem ====
-==== sysBuildingActivateSetPrices ====
+==== sysBuildingGetDemandedItem ====
-==== sysBuildingActivateSellItem ====
+==== sysBuildingGetProducedItem ====
-==== sysBuildingActivateEmployeeList ====
+==== sysBuildingGetTotalSold ====
+^ Format | sysBuildingGetTotalSold ( Item_Name_or_Num )|
+^ Description | Returns the total amount of the item that has been sold (since the count was reset with *buildingresetsoldtotal). If item name is omitted or set to 0, a total of all items is provided. |
+^ Example | ''**$totalSold = sysBuildingGetTotalSold ("Wood")**'' |
+==== sysBuildingGetTotalMade ====
+^ Format | sysBuildingGetTotalMade ( Item_Name_or_Num )|
+^ Description | Returns the total amount of the item that has been made (since the count was reset with *buildingresetmadetotal). If item name is omitted or set to 0, a total of all items is provided. |
+^ Example | ''**$totalMade = sysBuildingGetTotalMade (0)**'' |
+===== Related System Values =====
+Various information the context building is provided through [[scripting:reference:system_values|System Values]] - relevant ones are:
+\\
+\\
+**$gBuildingX**, **$gBuildingY** : X,Y location of the building in map coords (default 0 -> 255)\\
+**$gBuildingCode** : Building type code - the number of the building type in the buildings editor list\\
+**$gBuildingNum**, **$gBuildingAccessNum** : Unique ID number of the specific building being accessed \\
+**$gBuildingWorldX**, **$gBuildingWorldY** : X,Y location of the building in world coords\\
+**$gBuildingTeam** : Team the building belongs to (or 0 if none)\\
+**$gBuildingCapacity** : Capacity value of the building (e.g. for homes)\\
+**$gBuildingSpaceRemaining** : Remaining capacity of the building (e.g. for homes)\\
+**$gBuildingTown** : Town building num of the town the building is in (or 0 if the building is not in a town)\\
+**$gBuildingScriptParam**, , **$gBuildingOwnerID**, **$gBuildingNumEmployees**, **$gBuildingMaxEmployees**, **$gBuildingSalePrice**, **$gBuildingWage**,  **$gBuildingInvestment**,
+**$gBuildingEfficiency**, **$gBuildingScore**, **$gBuildingType**, **$gBuildingDamage**,
+===== Collated Player Building Information =====
+The following functions are somewhat different.. rather than being about a specific building, they return information about all the buildings a player currently owns.
+==== sysPlayerBuildingsGetTotalMade ====
+^ Format | sysPlayerBuildingsGetTotalMade ( PlayerID, Item_Name_or_Num )|
+^ Description | Returns the total amount of the item that has been made in the player's current owned buildings. The total count can be reset using *buildingresetmadetotal [building_num] [item_num]. |
+^ Example | ''**$madeTotal = sysPlayerBuildingsGetTotalMade([PlayerID], "Bread")**'' |
+==== sysPlayerBuildingsGetTotalSold ====
+^ Format | sysPlayerBuildingsGetTotalSold ( PlayerID, Item_Name_or_Num )|
+^ Description | Returns the total amount of the item that has been sold from the player's current owned buildings. The total count can be reset using *buildingresetsoldtotal [building_num] [item_num] |
+^ Example | ''**$madeTotal = sysPlayerBuildingsGetTotalSold([PlayerID], "Bread")**'' |