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#FSMZONE_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
- ZONE_GOAL.New(): Creates a new ZONE_GOAL object.
2. ZONE_GOAL is a finite state machine (FSM).
2.1 ZONE_GOAL States
- None: Initial State
2.2 ZONE_GOAL Events
- DestroyedUnit: A Wrapper.Unit is destroyed in the Zone. The event will only get triggered if the method ZONE_GOAL.MonitorDestroyedUnits() is used.
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
-
#SMOKECOLOR.Color FlareColor:
-
- ZONE_GOAL:GetZone()
-
Get the Zone
Return value
- ZONE_GOAL:GetZoneName()
-
Get the name of the ProtectZone
Return value
#string:
- 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
-
Core.Zone#ZONE_BASE Zone: A Zone object with the goal to be achieved.
Return value
-
- 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
-
#SMOKECOLOR.Color SmokeColor:
-
- ZONE_GOAL:StatusSmoke()
-
Check status Smoke.
- ZONE_GOAL:__Destroyed(EventData)
-
Parameter
-
Core.Event#EVENTDATA EventData:
-
- ZONE_GOAL:onafterGuard()
-
When started, check the Smoke and the Zone status.