Callbacks API Documentation

This page documents the callbacks available in Easy Red 2 for Lua scripting.
Here you will find the Id of the callbacks to use with functions like er2.setCallback, Soldier.setCallback and Vehicle.setCallback in order to register a callback event to a specific lua function.
You will also find the partameters that the lua function will need to implement in order to correctly trigger the callback. Click on the description or the arrow to reveal parameters.

Here's an example of how to register a Lua callback on a function called "MyCustomCallback":

-- Define your Lua callback function
function MyCustomCallback(spawnedUnit)
    print('MyCustomCallback called with parameter: ' .. spawnedUnit)
end

-- Register the callback in Lua.
er2.setCallback("soldier_spawned", MyCustomCallback)
Global

Global callbacks available for general game events. Can be set with er2.setCallback function.

»battle_ended[Copy] - Triggered when the battle ends. Parameters: winning faction (string), forced end flag (boolean).
#TypeDescription
1stringThe winning faction.
2voidTrue if battle ended forcibly.
»phase_changed[Copy] - Triggered when the game phase changes. Parameters: current phase (number), next phase (number).
#TypeDescription
1NumberThe current phase number.
2NumberThe next phase ID.
»soldier_damaged[Copy] - Triggered when a soldier takes damage. Parameters: soldier (explicit), damage (number).
#TypeDescription
1SoldierThe soldier variable (explicit).
2NumberThe damage amount.
»soldier_died[Copy] - Triggered when a soldier dies. Parameter: soldier (explicit).
#TypeDescription
1SoldierThe soldier variable (explicit).
»soldier_finished_order[Copy] - Triggered when a soldier finishes an order. Parameters: explicit soldier, order type.
#TypeDescription
1SoldierThe soldier variable triggering the order.
2stringThe order type (e.g. waypoint_reached, soldier_healed, vehicle_repaired).
»soldier_incapacitated[Copy] - Triggered when a soldier becomes incapacitated. Parameter: soldier (explicit).
#TypeDescription
1SoldierThe soldier variable (explicit).
»soldier_pose_changed[Copy] - Triggered when a soldier changes pose. Parameters: soldier (explicit), new pose (number).
#TypeDescription
1SoldierThe soldier variable (explicit).
2NumberThe new pose (integer).
»soldier_rescued[Copy] - Triggered when a soldier is rescued. Parameter: soldier (explicit).
#TypeDescription
1SoldierThe soldier variable (explicit).
»soldier_spawned[Copy] - Triggered when a soldier is spawned. Parameter: soldier (explicit).
#TypeDescription
1SoldierThe soldier variable that was spawned.
»soldier_spotted[Copy] - Triggered when a soldier got spotted
#TypeDescription
1SoldierThe soldier that got spotted
2SoldierThe soldier that spotted the enemy (Might be nil)
»soldier_suppressed[Copy] - Triggered when a soldier is suppressed. Parameters: soldier (explicit), shooter.
#TypeDescription
1SoldierThe suppressed soldier (explicit).
2SoldierThe shooter soldier.
»soldier_surrendered[Copy] - Triggered when a soldier surrenders. Parameter: soldier (explicit).
#TypeDescription
1SoldierThe soldier variable (explicit).
»soldier_target_inf_acquired[Copy] - Triggered when a soldier acquired a new target
#TypeDescription
1SoldierThe soldier that acquired the new target
2SoldierThe acquired target
»soldier_target_lost[Copy] - Triggered when a soldier loose tracks of the acquired target
#TypeDescription
1SoldierThe soldier that lost the target
»soldier_target_veh_acquired[Copy] - Triggered when a soldier acquired a new vehicle target
#TypeDescription
1SoldierThe soldier that acquired a new target
2VehicleThe new target
»squad_created[Copy] - Triggered when a squad is created. Parameter: squad.
#TypeDescription
1SquadThe new squad variable.
»squad_leader_changed[Copy] - Triggered when a squad changes its leader. Parameters: squad, new leader (soldier).
#TypeDescription
1SquadThe squad variable.
2SoldierThe new leader soldier.
»squad_ready[Copy] - Triggered when a squad is ready. Parameter: squad.
#TypeDescription
1SquadThe squad variable.
»vehicle_damaged_engine[Copy] - Triggered when a vehicle’s engine is damaged. Parameters: vehicle (explicit), damage (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2NumberDamage amount to the engine.
»vehicle_damaged_fueltank[Copy] - Triggered when a vehicle’s fueltank is damaged. Parameters: vehicle (explicit), damage (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2NumberDamage amount to the fueltank.
»vehicle_damaged_hull[Copy] - Triggered when a vehicle’s hull is damaged. Parameters: vehicle (explicit), damage (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2NumberDamage amount to the hull.
»vehicle_damaged_wheels[Copy] - Triggered when a vehicle’s wheels are damaged. Parameters: vehicle (explicit), damage (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2NumberDamage amount to the wheels.
»vehicle_damaged_wing[Copy] - Triggered when a vehicle’s wing is damaged. Parameters: vehicle (explicit), damage (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2NumberDamage amount to the wing.
»vehicle_destroyed[Copy] - Triggered when a vehicle is destroyed. Parameter: vehicle (explicit).
#TypeDescription
1VehicleThe vehicle variable (explicit).
»vehicle_disabled[Copy] - Triggered when a vehicle becomes disabled. Parameter: vehicle (explicit).
#TypeDescription
1VehicleThe vehicle variable (explicit).
»vehicle_entered[Copy] - Triggered when a soldier enters a vehicle. Parameters: vehicle (explicit), soldier, seat position (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2SoldierThe soldier variable.
3NumberThe seat position.
»vehicle_exited[Copy] - Triggered when a soldier exits a vehicle. Parameters: vehicle (explicit), soldier.
#TypeDescription
1VehicleThe vehicle variable (explicit).
2SoldierThe soldier variable.
»vehicle_loose_parts[Copy] - Triggered when a vehicle loses parts. Parameter: vehicle (explicit).
#TypeDescription
1VehicleThe vehicle variable (explicit).
»vehicle_loose_wing[Copy] - Triggered when a vehicle loses a wing. Parameter: vehicle (explicit).
#TypeDescription
1VehicleThe vehicle variable (explicit).
»vehicle_repaired[Copy] - Triggered when a vehicle is repaired. Parameter: vehicle (explicit).
#TypeDescription
1VehicleThe vehicle variable (explicit).
»vehicle_seat_changed[Copy] - Triggered when a seat change occurs in a vehicle. Parameters: vehicle (explicit), soldier, seat position (number).
#TypeDescription
1VehicleThe vehicle variable (explicit).
2SoldierThe soldier variable.
3NumberThe seat position.
»vehicle_spawned[Copy] - Triggered when a vehicle is spawned. Parameter: vehicle (explicit).
#TypeDescription
1VehicleThe vehicle variable (explicit).
Soldier

Callbacks triggered by soldier-related events. Can be set with Soldier.setCallback function.

»soldier_damaged[Copy] - Triggered on the soldier when taking damage. Parameter: damage (number).
#TypeDescription
1NumberThe damage amount.
»soldier_died[Copy] - Triggered on the soldier when dying. No parameter.

No parameters defined for this callback.

»soldier_finished_order[Copy] - Triggered on the soldier when finishing an order. Parameter: order type.
#TypeDescription
1stringThe order type (e.g. waypoint_reached, soldier_healed, vehicle_repaired).
»soldier_incapacitated[Copy] - Triggered on the soldier when incapacitated. No parameter.

No parameters defined for this callback.

»soldier_pose_changed[Copy] - Triggered on the soldier when pose changes. Parameter: new pose (number).
#TypeDescription
1NumberThe new pose (integer).
»soldier_rescued[Copy] - Triggered on the soldier when rescued. No parameter.

No parameters defined for this callback.

»soldier_spotted[Copy] - Triggered on a soldier when a soldier got spotted
#TypeDescription
1SoldierThe soldier that spotted the enemy (might be nil)
»soldier_suppressed[Copy] - Triggered on the soldier when suppressed. Parameter: shooter.
#TypeDescription
1SoldierThe shooter soldier.
»soldier_surrendered[Copy] - Triggered on the soldier when surrendering. No parameter.

No parameters defined for this callback.

»soldier_target_inf_acquired[Copy] - Triggered when a soldier acquired a new target
#TypeDescription
1SoldierThe new target
»soldier_target_lost[Copy] - Triggered when a soldier loose tracks of the acquired target

No parameters defined for this callback.

»soldier_target_veh_acquired[Copy] - Triggered when a soldier acquired a new vehicle target
#TypeDescription
1VehicleThe new target
Vehicle

Callbacks triggered by vehicle-related events. Can be set with Vehicle.setCallback function.

»vehicle_damaged_engine[Copy] - Triggered on the vehicle when its engine is damaged. Parameter: damage (number).
#TypeDescription
1NumberDamage amount to the engine.
»vehicle_damaged_fueltank[Copy] - Triggered on the vehicle when its fueltank is damaged. Parameter: damage (number).
#TypeDescription
1NumberDamage amount to the fueltank.
»vehicle_damaged_hull[Copy] - Triggered on the vehicle when its hull is damaged. Parameter: damage (number).
#TypeDescription
1NumberDamage amount to the hull.
»vehicle_damaged_wheels[Copy] - Triggered on the vehicle when its wheels are damaged. Parameter: damage (number).
#TypeDescription
1NumberDamage amount to the wheels.
»vehicle_damaged_wing[Copy] - Triggered on the vehicle when its wing is damaged. Parameter: damage (number).
#TypeDescription
1NumberDamage amount to the wing.
»vehicle_destroyed[Copy] - Triggered on the vehicle when destroyed. No parameter.

No parameters defined for this callback.

»vehicle_disabled[Copy] - Triggered on the vehicle when disabled. No parameter.

No parameters defined for this callback.

»vehicle_entered[Copy] - Triggered on the vehicle when a soldier enters. Parameters: soldier, seat position (number).
#TypeDescription
1SoldierThe soldier variable.
2NumberThe seat position.
»vehicle_exited[Copy] - Triggered on the vehicle when a soldier exits. Parameter: soldier.
#TypeDescription
1SoldierThe soldier variable.
»vehicle_loose_parts[Copy] - Triggered on the vehicle when parts are lost. No parameter.

No parameters defined for this callback.

»vehicle_loose_wing[Copy] - Triggered on the vehicle when a wing is lost. No parameter.

No parameters defined for this callback.

»vehicle_repaired[Copy] - Triggered on the vehicle when repaired. No parameter.

No parameters defined for this callback.

»vehicle_seat_changed[Copy] - Triggered on the vehicle when a seat change occurs. Parameters: soldier, seat position (number).
#TypeDescription
1SoldierThe soldier variable.
2NumberThe seat position.