Units
A units object is a collection of battle_unit objects. Like the other battle collection objects (battle_alliances and battle_armies), units:count returns the number of objects and units:item returns individual items in the collection.
| Loaded in Campaign |
|
| Loaded in Battle |
|
| Loaded in Frontend |
|
Units objects are derived from battle_army objects in the battle_hierarchy - see the battle_hierarchy page for more information. Preferably, use the script_unit or generated_battle frameworks provided by the script libraries to negate the need to explicitly create units objects.
Once a handle to a units object is obtained, functions may be called on it to query or modify its state in the following form.
Example - Specification:
<object_name>:<function_name>(<args>)
Example - Creation and Usage:
local units_player = bm:alliances():item(1):armies():item(1):units()
out("number of player units: " .. units_player:count()) -- calling a function on the object once created
number of player units: 7
-
units:item(indexnumber) -
Returns the
battle_unitat the specified index in the units list. The list is 1-based, so supplying1as an argument will return the first unit in the army.Parameters:
1
index
Returns:
battle_unit
-
units:count() -
Returns the size of the units list.
Returns:
number
-
units:mountable_artillery_item(indexnumber) -
Returns the
battle_unitat the specified index in the mountable artillery list. The list is also 1-based.Parameters:
1
index
Returns:
battle_unit
-
units:kill_commander() -
Kills the commander of the army.
Returns:
nil