Assault Equipment

The assault_equipment container object lists vehicle objects that represent vehicles on the battlefield. An assault_equipment list may be retrieved from the battle object by calling battle:assault_equipment.

Loaded in Battle loaded in battle
Back to top

Functionality

assault_equipment:vehicle_count()
Returns the number of vehicles in the collection.

Returns:

  1. number count

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptAssaultEquipment.cpp, line 202

assault_equipment:vehicle_item(number index)

Returns the vehicles at the specified index value in the collection.

Parameters:

1

number

index

Returns:

  1. vehicle vehicle

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptAssaultEquipment.cpp, line 216

Vehicle

Vehicle objects represent vehicles on the battlefield, such as battering rams or siege towers. Vehicle objects can be retrieved from the assault_equipment list, which itself is retrieved from the battle object.

Back to top

Functionality

vehicle:vehicle_key()
Returns the key of the vehicle type, from the battlefield_siege_vehicles table.

Returns:

  1. string vehicle key

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptAssaultEquipment.cpp, line 105

vehicle:position()
Returns the position of the vehicle.

Returns:

  1. battle_vector position

defined in ../../common/EmpireBattle/Source/BattleScript/BattleScriptAssaultEquipment.cpp, line 120

Last updated 25/08/2021 12:07:51