Module ZoneGoal

Functional (WIP) -- 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


Global(s)

ZONE_GOAL

ZONE_GOAL class, extends Fsm#FSM

ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone.

Type ZONE_GOAL

ZONE_GOAL:Flare(FlareColor)

Flare the center of the zone.

ZONE_GOAL:GetZone()

Get the Zone

ZONE_GOAL:GetZoneName()

Get the name of the ProtectZone

ZONE_GOAL.Goal
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:Smoke(SmokeColor)

Smoke the center of theh zone.

ZONE_GOAL.SmokeColor
ZONE_GOAL.SmokeScheduler
ZONE_GOAL.SmokeTime
ZONE_GOAL:StatusSmoke()

Check status Smoke.

ZONE_GOAL.Zone
ZONE_GOAL:__Destroyed(EventData)
ZONE_GOAL:onafterGuard()

When started, check the Smoke and the Zone status.

Global(s)

#ZONE_GOAL ZONE_GOAL

ZONE_GOAL class, extends Fsm#FSM

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 ZoneGoal

Type SMOKECOLOR.Color

Type ZONE_GOAL

Extends Core.Fsm#FSM

Field(s)

ZONE_GOAL:Flare(FlareColor)

Flare the center of the zone.

Parameter

ZONE_GOAL:GetZone()

Get the Zone

Return value

Core.Zone#ZONE_BASE:

ZONE_GOAL:GetZoneName()

Get the name of the ProtectZone

Return value

#string:

ZONE_GOAL.Goal
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.

Parameter

Return value

#ZONE_GOAL:

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

DestroyedUnit Handler OnAfter for ZONE_GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

  • Wrapper.Unit#UNIT DestroyedUnit : The destroyed unit.

  • #string PlayerName : The name of the player.

ZONE_GOAL:Smoke(SmokeColor)

Smoke the center of theh zone.

Parameter

ZONE_GOAL.SmokeColor
ZONE_GOAL.SmokeScheduler
ZONE_GOAL.SmokeTime
ZONE_GOAL:StatusSmoke()

Check status Smoke.

Core.Zone#ZONE_BASE ZONE_GOAL.Zone
ZONE_GOAL:__Destroyed(EventData)

Parameter

ZONE_GOAL:onafterGuard()

When started, check the Smoke and the Zone status.