Module Functional.ZoneGoalCoalition
Functional (WIP) - Base class modeling processes to achieve goals involving coalition zones.
ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition. Derived classes implement the ways how the achievements can be realized.
Author: FlightControl
Global(s)
Global ZONE_GOAL_COALITION |
ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition. |
ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
Derived classes implement the ways how the achievements can be realized.
1. ZONE_GOAL_COALITION constructor
- ZONE_GOAL_COALITION.New(): Creates a new ZONE_GOAL_COALITION object.
2. ZONE_GOAL_COALITION is a finite state machine (FSM).
2.1 ZONE_GOAL_COALITION States
2.2 ZONE_GOAL_COALITION Events
2.3 ZONE_GOAL_COALITION State Machine
Type(s)
| Fields and Methods inherited from ZONE_GOAL_COALITION | Description |
|---|---|
|
Get the owning coalition of the zone. |
|
|
Get the owning coalition name of the zone. |
|
|
Get the previous coalition, i.e. |
|
|
ZONE_GOAL_COALITION Constructor. |
|
|
Set the owning coalition of the zone. |
|
|
Set the owning coalition of the zone. |
|
|
Set the owning coalition of the zone. |
|
|
Check status Coalition ownership. |
|
Field(s)
@field #table ZONE_GOAL_COALITION.States
Function(s)
Get the owning coalition of the zone.
Defined in:
ZONE_GOAL_COALITION
Return value:
#number:
Coalition.
Get the owning coalition name of the zone.
Defined in:
ZONE_GOAL_COALITION
Return value:
#string:
Coalition name.
Get the previous coalition, i.e.
the one owning the zone before the current one.
Defined in:
ZONE_GOAL_COALITION
Return value:
#number:
Coalition.
ZONE_GOAL_COALITION Constructor.
Defined in:
ZONE_GOAL_COALITION
Parameters:
Core.Zone#ZONE Zone
A Core.Zone object with the goal to be achieved.
#number Coalition
The initial coalition owning the zone. Default coalition.side.NEUTRAL.
#table UnitCategories
Table of unit categories. See DCS Class Unit. Default {Unit.Category.GROUND_UNIT}.
Return value:
Set the owning coalition of the zone.
Defined in:
ZONE_GOAL_COALITION
Parameter:
#number Coalition
The coalition ID, e.g. coalition.side.RED.
Return value:
Set the owning coalition of the zone.
Defined in:
ZONE_GOAL_COALITION
Parameter:
#table ObjectCategories
Table of unit categories. See DCS Class Object. Default {Object.Category.UNIT, Object.Category.STATIC}, i.e. all UNITS and STATICS.
Return value:
Set the owning coalition of the zone.
Defined in:
ZONE_GOAL_COALITION
Parameter:
#table UnitCategories
Table of unit categories. See DCS Class Unit. Default {Unit.Category.GROUND_UNIT}.
Return value:
Check status Coalition ownership.