Differences

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

--- scripting:reference:system_functions:buildinginformationfunctions [2023/07/22 13:21] – mit
+++ scripting:reference:system_functions:buildinginformationfunctions [2025/05/28 18:58] (current) – external edit 127.0.0.1
@@ 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 ====
@@ Line 116: / Line 118: @@
 \\
 \\
-**$gBuildingNum**, **$gBuildingAccessNum**, **$gBuildingScriptParam**, **$gBuildingX**, **$gBuildingY**, **$gBuildingCode**, **$gBuildingOwnerID**, **$gBuildingNumEmployees**, **$gBuildingMaxEmployees**, **$gBuildingSalePrice**, **$gBuildingWage**, **$gBuildingWorldX**, **$gBuildingWorldY**, **$gBuildingInvestment**,
+**$gBuildingX**, **$gBuildingY** : X,Y location of the building in map coords (default 0 -> 255)\\
-**$gBuildingEfficiency**, **$gBuildingScore**, **$gBuildingType**, **$gBuildingDamage**, **$gBuildingTeam**
+**$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 =====