Banner Image

Module Functional.ZoneGoalCargo

Functional - Base class that models processes to achieve goals involving a Zone and Cargo.


ZONE_GOAL_CARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.
Derived classes implement the ways how the achievements can be realized.

Developer Note

Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated


Author: FlightControl


Global(s)

Global ZONE_GOAL_CARGO

Models processes that have a Goal with a defined achievement involving a Zone and Cargo.

#ZONE_GOAL_CARGO ZONE_GOAL_CARGO

Models processes that have a Goal with a defined achievement involving a Zone and Cargo.

Derived classes implement the ways how the achievements can be realized.

1. ZONE_GOAL_CARGO constructor

2. ZONE_GOAL_CARGO is a finite state machine (FSM).

2.1 ZONE_GOAL_CARGO States

  • Deployed: The Zone has been captured by an other coalition.
  • Airborne: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
  • Loaded: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
  • Empty: The Zone is empty. There is not valid unit in the Zone.

2.2 ZONE_GOAL_CARGO Events

  • Capture: The Zone has been captured by an other coalition.
  • Attack: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
  • Guard: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
  • Empty: The Zone is empty. There is not valid unit in the Zone.

2.3 ZONE_GOAL_CARGO State Machine

Type(s)

Fields and Methods inherited from ZONE_GOAL_CARGO Description

ZONE_GOAL_CARGO:Attack()

Attack Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:Capture()

Capture Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO.Coalition

ZONE_GOAL_CARGO:Empty()

Empty Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:GetCoalition()

Get the owning coalition of the zone.

ZONE_GOAL_CARGO:GetCoalitionName()

Get the owning coalition name of the zone.

ZONE_GOAL_CARGO:Guard()

Guard Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:IsAttacked()

ZONE_GOAL_CARGO:IsCaptured()

ZONE_GOAL_CARGO:IsEmpty()

ZONE_GOAL_CARGO:IsGuarded()

ZONE_GOAL_CARGO:Mark()

Mark.

ZONE_GOAL_CARGO.MarkBlue

ZONE_GOAL_CARGO.MarkRed

ZONE_GOAL_CARGO:New(Zone, Coalition)

ZONE_GOAL_CARGO Constructor.

ZONE_GOAL_CARGO:OnAfterAttack(From, Event, To)

Attack Handler OnAfter for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnAfterCapture(From, Event, To)

Capture Handler OnAfter for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnAfterEmpty(From, Event, To)

Empty Handler OnAfter for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnAfterGuard(From, Event, To)

Guard Handler OnAfter for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnBeforeAttack(From, Event, To)

Attack Handler OnBefore for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnBeforeCapture(From, Event, To)

Capture Handler OnBefore for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnBeforeEmpty(From, Event, To)

Empty Handler OnBefore for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:OnBeforeGuard(From, Event, To)

Guard Handler OnBefore for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO.ScheduleStatusZone

ZONE_GOAL_CARGO:SetCoalition(Coalition)

Set the owning coalition of the zone.

ZONE_GOAL_CARGO.SmokeScheduler

ZONE_GOAL_CARGO.States

ZONE_GOAL_CARGO:StatusZone()

Check status Coalition ownership.

ZONE_GOAL_CARGO:__Attack(Delay)

Attack Asynchronous Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:__Capture(Delay)

Capture Asynchronous Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:__Empty(Delay)

Empty Asynchronous Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:__Guard(Delay)

Guard Asynchronous Trigger for ZONE_GOAL_CARGO

ZONE_GOAL_CARGO:onafterGuard()

When started, check the Coalition status.

ZONE_GOAL_CARGO:onenterAttacked()

ZONE_GOAL_CARGO:onenterCaptured()

ZONE_GOAL_CARGO:onenterEmpty()

ZONE_GOAL_CARGO:onenterGuarded()

Bound.

Field(s)

#table ZONE_GOAL_CARGO.States

@field #table ZONE_GOAL_CARGO.States

Function(s)

Attack Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Capture Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Empty Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Get the owning coalition of the zone.

Defined in:

ZONE_GOAL_CARGO

Return value:

#number:

Coalition.

Get the owning coalition name of the zone.

Defined in:

ZONE_GOAL_CARGO

Return value:

#string:

Coalition name.

Guard Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Mark.

Defined in:

ZONE_GOAL_CARGO

ZONE_GOAL_CARGO Constructor.

Defined in:

ZONE_GOAL_CARGO

Parameters:

A Core.Zone object with the goal to be achieved.

#number Coalition

The initial coalition owning the zone.

Return value:

Attack Handler OnAfter for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Capture Handler OnAfter for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Empty Handler OnAfter for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Guard Handler OnAfter for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Attack Handler OnBefore for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Capture Handler OnBefore for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Empty Handler OnBefore for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Guard Handler OnBefore for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Set the owning coalition of the zone.

Defined in:

ZONE_GOAL_CARGO

Parameter:

#number Coalition

Check status Coalition ownership.

Defined in:

ZONE_GOAL_CARGO

Attack Asynchronous Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameter:

#number Delay

Capture Asynchronous Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameter:

#number Delay

Empty Asynchronous Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameter:

#number Delay

Guard Asynchronous Trigger for ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Parameter:

#number Delay

When started, check the Coalition status.

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Defined in:

ZONE_GOAL_CARGO

Bound.

Defined in:

ZONE_GOAL_CARGO