Mod API Reference:GameOrderAttackTransferResult: Difference between revisions

Revision as of 13:15, 19 July 2017

GameOrderAttackTransferResult: Subclass of GameOrderResult

ActualArmies Armies: The number of armies from the source territory that actually participated in the attack or transfer.
AttackingArmiesKilled Armies:
DamageToSpecialUnits Table<Guid,integer>:
DefendingArmiesKilled Armies:
DefenseLuck Nullable<number>:
IsAttack boolean: True if this was an attack, false if it was a transfer.
IsNullified boolean:
IsSuccessful boolean: If IsAttack is true and IsSuccessful is true, the territory was captured. If IsAttack is true and IsSuccessful was false, the territory was not captured.
OffenseLuck Nullable<number>:

@@ Line 1: / Line 1: @@
 '''GameOrderAttackTransferResult''':  Subclass of [[Mod API Reference:GameOrderResult|GameOrderResult]]
-* '''ActualArmies''' ''[[Mod API Reference:Armies|Armies]]'':
+* '''ActualArmies''' ''[[Mod API Reference:Armies|Armies]]'': The number of armies from the source territory that actually participated in the attack or transfer.
 * '''AttackingArmiesKilled''' ''[[Mod API Reference:Armies|Armies]]'':
 * '''DamageToSpecialUnits''' ''Table<[[Mod API Reference:Guid|Guid]],integer>'':
 * '''DefendingArmiesKilled''' ''[[Mod API Reference:Armies|Armies]]'':
 * '''DefenseLuck''' ''[[Mod API Reference:Nullable|Nullable]]<number>'':
-* '''IsAttack''' ''boolean'':
+* '''IsAttack''' ''boolean'': True if this was an attack, false if it was a transfer.
 * '''IsNullified''' ''boolean'':
-* '''IsSuccessful''' ''boolean'':
+* '''IsSuccessful''' ''boolean'': If IsAttack is true and IsSuccessful is true, the territory was captured.  If IsAttack is true and IsSuccessful was false, the territory was not captured.
 * '''OffenseLuck''' ''[[Mod API Reference:Nullable|Nullable]]<number>'':