Building
Browse its members and the signatures that accept or return this type.
Members
46Expand a member to read its notes or open its full entry. Each overload keeps its own identity.
| Member | Signature and description |
|---|---|
| Obj Building::BestTarget()Selects a target from a spatial search around a Building and returns its CKS handle. |
| bool Building::Attack(Obj)Executes a guarded, possibly waiting Building attack that spawns an arrow shot on its firing path. |
| point Building::GetEnterPoint(Unit)calculates the entrance point coordinates of a building relative to an approaching unit. |
| point Building::GetExitPoint(Obj, point)Resolves an exit point from a Building, an Obj template category, and an incoming point. |
| point Building::GetExitPoint(point, bool)Resolves an exit point from a Building, an incoming point, and a boolean mode. |
| Building | point Building::GetPoint(int, int)Description pendingDescription pending. |
| Settlement Building::settlement()Resolves a Building's own Settlement-link field into a CKS Settlement reference. |
| bool Building::IsBroken()Generic CKS-exposed Building::IsBroken, true when the shared broken-status field equals 3. |
| bool Building::IsCentralBuliding()Reads the template-level is_central_building flag through the object's own template pointer. |
| void Building::RRepair()Conditionally repairs a broken Building to a health percentage above the broken threshold and refreshes its damage visuals. |
| point Building::GetExitVector()Building GetExitVector returns template dwords at [field] and [field], with (-1,-1) for a sentinel first dword. |
| void Building::PopTransportationUI()Resolves the Building, checks its class descriptor and converts an embedded interface to a town hall interface before passing it to a UI allocation operation. |
| int Building::GetGlobalSpell()Looks up the first global-spell vector entry associated with a resolved town hall and pushes its initial dword. |
| void Building::GlobalSpellStart(int, int)Starts a global-spell operation for a town hall when the first integer is in the range zero through five. |
| void Building::GlobalSpellStart(int, int, int)Starts a global-spell operation for a town hall with three script integers when the first is in the range zero through five. |
| void Building::GlobalSpellStop()Stops a town hall's global-spell entry by delegating to the global spell manager. |
| void Building::SetGlobalSpellData(int)Passes a town hall and an integer to a global-spell vector updater. |
| void Building::WindOfWisdom(int)Stonehenge-gated Building primitive with two-path candidate collection and capped signed level-to-XP dispatch, retaining concrete storage and override prerequisites. |
| void Building::Starvation()Invokes a rectangle scan that reduces a linked object counter and qualifying wagon food. |
| void Building::SoothingRain(int)Scans matching buildings and adds 300 divided by the script argument to linked settlement gold. |
| void Building::DivineSacrifice()Collects eligible Druid objects for a Stonehenge town hall and invokes their divine-sacrifice operation. |
| int Building::GetSoothingRainObjects()Counts buildings found by the SoothingRain map scan while passing zero to its gold mutator. |
| bool Building::IsStonehengeControlable()Tests whether a Stonehenge-centered map scan yields a positive counter. |
| int Building::StonehengeNumControllingMages()Returns a counter from a Stonehenge-centered map scan. |
| Building | str Building::itemtypes()Returns the Building template string registered as Building::itemtypes. |
| Building | int Building::minlevel()Returns the Building template dword registered as Building::minlevel. |
| int Building::levelperitem()Returns the Building template dword registered as Building::levelperitem. |
| void Building::ClearDamageTaken()Building::ClearDamageTaken writes zero to the resolved Building's dword at [field]. |
| int Building::CountMages()Returns a count of eligible script objects in a Stonehenge-centered circle. |
| void Building::SetUITarget(Obj)Building::SetUITarget writes the target object's 16-bit registry slot to Building [field], or 65535 when the target does not resolve. |
| Obj Building::GetUITarget()Building::GetUITarget returns the handle stored at building [field] and returns a null handle when resolution fails. |
| int Building::GetNumSentrySlots()Building::GetNumSentrySlots returns the sentry slot count dword at template [field] and lacks a safe fallback for invalid handles. |
| str Building::GetSentryClassName()Building::GetSentryClassName returns the Building template string stored at [field]. |
| void Building::Research(str)Resolves a named command descriptor and invokes research with temporary command-cost context. |
| point Building::GetEnterExit()Delegates to a random point lookup using point type 12. The meaning of that type is not documented here. |
| point Building::GetWaterSource()Delegates to a random point lookup using point type 13. The meaning of that type is not documented here. |
| point Building::GetGoodsSource()Delegates to a random point lookup using point type 14. The meaning of that type is not documented here. |
| point Building::GetFixSite()Delegates to a random point lookup using point type 15. The meaning of that type is not documented here. |
| bool Building::IsVeryBroken()Building::IsVeryBroken returns true when current health is below integer maximum health divided by twenty. |
| bool Building::IsBarrack()Evaluates a Building through the native barracks-family class predicate and returns a VM boolean. |
| str Building::GetDefenderCls(int)Building::GetDefenderCls returns one of two Building strings for Outpost descendants according to selector 1 or 2. |
| int Building::GetDefendersMax(int)Building::GetDefendersMax returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2. |
| int Building::GetDefendersOut(int)Returns one of two defender-out counters for buildings whose associated object derives from Outpost. |
| int Building::GetStartLevel(int)Building::GetStartLevel returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2. |
| int Building::GetEndLevel(int)Building::GetEndLevel returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2. |
| int Building::GetOutpostFood()Building::GetOutpostFood returns Building field [field] for Outpost descendants and zero otherwise. |
Return this type
14| Member | Signature and description |
|---|---|
Obj::AsBuildingObj | Building Obj::AsBuilding()Returns a Building reference when the object has a compatible building category. |
Unit::GetBuildingUnit | Building Unit::GetBuilding()Returns a Building handle containing the resolved Unit's linked Building slot. |
Settlement::GetCentralBuildingSettlement | Building Settlement::GetCentralBuilding()Returns the registry handle stored in the settlement's central-building field. |
Settlement::FindSettlement | Building Settlement::Find(str)Find consumes str then Settlement, compares template string bytes and returns the first equal member handle. |
Settlement::GetEnterExitSettlement | Building Settlement::GetEnterExit()Delegates to a random building with point lookup using point type 12. The meaning of that type is not documented here. |
Settlement::GetWaterSourceSettlement | Building Settlement::GetWaterSource()Delegates to a random building with point lookup using point type 13. The meaning of that type is not documented here. |
Settlement::GetGoodsSourceSettlement | Building Settlement::GetGoodsSource()Delegates to a random building with point lookup using point type 14. The meaning of that type is not documented here. |
Settlement::GetFixSiteSettlement | Building Settlement::GetFixSite()Delegates to a random building with point lookup using point type 15. The meaning of that type is not documented here. |
Settlement::MostDamagedBuildingSettlement | Building Settlement::MostDamagedBuilding()Selects the first eligible settlement member with the greatest strictly positive signed damage accumulator and template mask 4096. |
Settlement::FindBuildingSettlement | Building Settlement::FindBuilding(str)Returns the first settlement member whose template derives from a requested class name. |
Settlement::FindResearchLabSettlement | Building Settlement::FindResearchLab(str)Finds a unit linked to a named research descriptor and returns its Building handle. |
Settlement::BestArenaSettlement | Building Settlement::BestArena()Selects a settlement member derived from BaseArena by the minimum unsigned adjusted score stored in an implementation field. |
Settlement::BestTempleSettlement | Building Settlement::BestTemple()Chooses the lowest-scoring eligible race-specific temple in a settlement. |
selbGlobal | Building selb()Selects a candidate with a particular flag and returns its encoded building reference. |
Accept this type
8| Member | Signature and description |
|---|---|
Unit::SetBuildingUnit | void Unit::SetBuilding(Building)Unit::SetBuilding writes the Building argument's 16-bit registry slot to Unit [field], or 65535 when the Building does not resolve. |
Druid::SetStonehengeDruid | void Druid::SetStonehenge(Building)Description pendingDescription pending. |
EnvWriteStringGlobal | void EnvWriteString(Building, str, str)Requests a string write under an environment key scoped to the specified building and its settlement. Arguments are the building, the key and the string. |
EnvWriteIntGlobal | void EnvWriteInt(Building, str, int)Formats a building-scoped environment path and delegates an integer value as decimal text to the environment writer. |
EnvReadStringGlobal | str EnvReadString(Building, str)Formats a building-scoped environment path and returns a managed string from its reader helper. |
EnvReadIntGlobal | int EnvReadInt(Building, str)Formats a building-scoped environment path and returns the integer produced by its reader helper. |
EnvWriteObjGlobal | void EnvWriteObj(Building, str, Obj)Formats a building-scoped key and encodes an object identifier for the environment writer. |
EnvReadObjGlobal | Obj EnvReadObj(Building, str)Formats a building-scoped key and writes an Obj result with initialized low16 identifier and zero offset. |
Coverage and limits
45 / 46 members with a published description.
These lists come from published signatures. “Accept” counts explicit parameters, excluding the method receiver; reference variants (&) are included. No inheritance hierarchy is asserted. Undocumented names, units and effects remain unresolved.