Events.RunCombatSim (Civ5 API)

This page is a part of the Lua and UI Reference (Civ5).

This function is a member of Events. This is a static method, invoke it with a dot.

This event is triggered every time a unit begins combat. The event will trigger off of any type of combat including but not limited to Melee, Ranged, Bombard, Air Missions and Nuclear. It has not yet been tested whether or not the triggering unit needs to be seen by the (human) player.

Usage

void Events.RunCombatSim(PlayerID attackingPlayer, UnitID attackingUnit, int attackingUnitDamage, int attackingUnitFinalDamage, int attackingUnitMaxHitPoints, PlayerID defendingPlayer, UnitID defendingUnit, int defendingUnitDamage, int defendingUnitFinalDamage, int defendingUnitMaxHitPoints)

Event Type

Regular event: you can subscribe to it through Events.RunCombatSim.Add(<function handler>) or invoke it directly through Events.RunCombatSim(<arguments list>).

Parameters

attackingPlayer:	No description available.
attackingUnit:	No description available.
attackingUnitDamage:	No description available.
attackingUnitFinalDamage:	No description available.
attackingUnitMaxHitPoints:	No description available.
defendingPlayer:	No description available.
defendingUnit:	No description available.
defendingUnitDamage:	No description available.
defendingUnitFinalDamage:	No description available.
defendingUnitMaxHitPoints:	No description available.

Source code samples

Redundant occurences have been removed.

TutorialChecks.lua

Tutorial/TutorialChecks.lua

3153	Events.RunCombatSim.Add( CombatStarted );

UnitFlagManager.lua

UI/InGame/UnitFlagManager.lua

1505	Events.RunCombatSim.Add( OnCombatBegin );

The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.