Banner Image

Module Functional.ZoneGoal

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


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


Author: FlightControl

Contributions: funkyfranky, Applevangelist


Global(s)

Global ZONE_GOAL

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

#ZONE_GOAL ZONE_GOAL

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

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

1. ZONE_GOAL constructor

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

2.1 ZONE_GOAL States

  • None: Initial State

2.2 ZONE_GOAL Events

Type(s)

Fields and Methods inherited from ZONE_GOAL Description

ZONE_GOAL:DestroyedUnit()

DestroyedUnit event.

ZONE_GOAL:Flare(FlareColor)

Flare the zone boundary.

ZONE_GOAL:GetZone()

Get the Zone.

ZONE_GOAL:GetZoneName()

Get the name of the Zone.

ZONE_GOAL:MonitorDestroyedUnits()

Activate the event UnitDestroyed to be fired when a unit is destroyed in the zone.

ZONE_GOAL:New(Zone)

ZONE_GOAL Constructor.

ZONE_GOAL:OnAfterDestroyedUnit(From, Event, To, DestroyedUnit, PlayerName)

DestroyedUnit Handler OnAfter for ZONE_GOAL

ZONE_GOAL:SetSmokeZone(switch)

Activate smoking of zone with the color or the current owner.

ZONE_GOAL:Smoke(SmokeColor)

Set the smoke color.

ZONE_GOAL.SmokeColor

ZONE_GOAL.SmokeScheduler

ZONE_GOAL.SmokeTime

ZONE_GOAL.SmokeZone

ZONE_GOAL:StatusSmoke()

Check status Smoke.

ZONE_GOAL:__Destroyed(EventData)

ZONE_GOAL:__DestroyedUnit(delay)

DestroyedUnit delayed event

ZONE_GOAL:onafterGuard()

When started, check the Smoke and the Zone status.

Field(s)

Function(s)

DestroyedUnit event.

Defined in:

ZONE_GOAL

Flare the zone boundary.

Defined in:

ZONE_GOAL

Parameter:

Get the Zone.

Defined in:

ZONE_GOAL

Return value:

Get the name of the Zone.

Defined in:

ZONE_GOAL

Return value:

#string:

Activate the event UnitDestroyed to be fired when a unit is destroyed in the zone.

Defined in:

ZONE_GOAL

ZONE_GOAL Constructor.

Defined in:

ZONE_GOAL

Parameter:

A Core.Zone object with the goal to be achieved. Alternatively, can be handed as the name of late activated group describing a ZONE_POLYGON with its waypoints.

Return value:

DestroyedUnit Handler OnAfter for ZONE_GOAL

Defined in:

ZONE_GOAL

Parameters:

#string From

#string Event

#string To

Wrapper.Unit#UNIT DestroyedUnit

The destroyed unit.

#string PlayerName

The name of the player.

Activate smoking of zone with the color or the current owner.

Defined in:

ZONE_GOAL

Parameter:

#boolean switch

If true or nil activate smoke. If false or nil, no smoke.

Return value:

Set the smoke color.

Defined in:

ZONE_GOAL

Parameter:

Check status Smoke.

Defined in:

ZONE_GOAL

@param #ZONE_GOAL self @param Core.Event#EVENTDATA EventData Event data table.

Defined in:

ZONE_GOAL

Parameter:

EventData

DestroyedUnit delayed event

Defined in:

ZONE_GOAL

Parameter:

#number delay

Delay in seconds.

When started, check the Smoke and the Zone status.

Defined in:

ZONE_GOAL