Building
A building script object represents a single building on the battlefield. This might be something as big as a garrisonable building or a section of wall fortification, or it could be as small as a crate or a barrel. Building script objects can be used to query or modify the subject building, and can also be passed to certain functions that take a building as an argument.
| Loaded in Battle |
|
A building script object may be sourced from the buildings list object.
***** WARNING: at time of writing this list object is broken and, if used, will cause crashes. *****
-
building:position() -
Returns a
battle_vectorrepresenting the position of the building. The vector will be positioned at the pivot point of the building, which is not necessarily at its centre.Returns:
battle_vector
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1193
-
building:central_position() -
Returns a
battle_vectorrepresenting the centre position of the building.Returns:
battle_vector
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1211
-
building:alliance_owner_id() -
Returns the number of the
alliancethat owns the building. If nobody owns this building then -1 is returned.Returns:
number
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1231
-
building:name() -
Returns the name of the building.
Returns:
string
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1247
-
building:health() -
Returns the health of the building as a unary value (between 0 and 1).
Returns:
number
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1261
-
building:hide() -
Hides the building, making it invisible.
Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1279
-
building:show() -
Shows the building after it has been hidden with
building:hide.Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1292
-
building:change_on_fire(booleanset on fire) -
Sets the building on fire or not (if it is able to burn).
Parameters:
1
booleanset on fire
Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1308
-
building:change_immune_to_catching_fire(booleanis flammable) -
Sets whether the building can burn or not.
Parameters:
1
booleanis flammable
Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1331
-
building:change_immune_to_fire_damage(booleantakes damage) -
Sets whether the building takes damage from burning or not.
Parameters:
1
booleantakes damage
Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1347
-
building:change_is_destructible(booleantakes damage) -
Sets whether the building takes damage at all.
Parameters:
1
booleantakes damage
Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1363
-
building:destroy() -
Destroys the building.
Returns:
nil
defined in ../../common/EmpireBattle/Source/BattleScript/BattleEditorScriptInterface.cpp, line 1380