Module `Route`

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.

#ACT_ROUTE FSM class, extends Fsm#FSM_PROCESS

ACT_ROUTE state machine:

This class is a state machine: it manages a process that is triggered by events causing state transitions to occur. All derived classes from this class will start with the class name, followed by a _. See the relevant derived class descriptions below. Each derived class follows exactly the same process, using the same events and following the same state transitions, but will have different implementation behaviour upon each event or state transition.

ACT_ROUTE Events:

These are the events defined in this class:

Start: The process is started. The process will go into the Report state.
Report: The process is reporting to the player the route to be followed.
Route: The process is routing the controllable.
Pause: The process is pausing the route of the controllable.
Arrive: The controllable has arrived at a route point.
More: There are more route points that need to be followed. The process will go back into the Report state.
NoMore: There are no more route points that need to be followed. The process will go into the Success state.

ACT_ROUTE Event methods:

Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process. There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:

Immediate: The event method has exactly the name of the event.
Delayed: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed.

ACT_ROUTE States:

None: The controllable did not receive route commands.
Arrived (*): The controllable has arrived at a route point.
Aborted (*): The controllable has aborted the route path.
Routing: The controllable is understay to the route point.
Pausing: The process is pausing the routing. AI air will go into hover, AI ground will stop moving. Players can fly around.
Success (*): All route points were reached.
Failed (*): The process has failed.

(*) End states of the process.

ACT_ROUTE state transition methods:

State transition functions can be set by the mission designer customizing or improving the behaviour of the state. There are 2 moments when state transition methods will be called by the state machine:

Before the state transition. The state transition method needs to start with the name OnBefore + the name of the state. If the state transition method returns false, then the processing of the state transition will not be done! If you want to change the behaviour of the AIControllable at this event, return false, but then you'll need to specify your own logic using the AIControllable!
After the state transition. The state transition method needs to start with the name OnAfter + the name of the state. These state transition methods need to provide a return value, which is specified at the function description.

1) #ACTROUTEZONE class, extends Fsm.Route#ACT_ROUTE

The ACTROUTEZONE class implements the core functions to route an AIR Controllable player Unit to a Zone. The player receives on perioding times messages with the coordinates of the route to follow. Upon arrival at the zone, a confirmation of arrival is sent, and the process will be ended.

1.1) ACTROUTEZONE constructor:

ACTROUTEZONE.New(): Creates a new ACTROUTEZONE object.

Global(s)

ACT_ROUTE
ACT_ROUTE_POINT
ACT_ROUTE_ZONE

Type `ACT_ROUTE`

ACT_ROUTE.ClassName
ACT_ROUTE.Coordinate
ACT_ROUTE.DisplayCount
ACT_ROUTE:GetRouteText(Controllable)	Get the routing text to be displayed.
ACT_ROUTE:MenuCancel()
ACT_ROUTE:New()	Creates a new routing state machine.
ACT_ROUTE.ProcessUnit
ACT_ROUTE.RouteMode
ACT_ROUTE:SetMenuCancel(MenuGroup, MenuText, ParentMenu, MenuTime)	Set a Cancel Menu item.
ACT_ROUTE:SetRouteMode(RouteMode)	Set the route mode.
ACT_ROUTE.TASK
ACT_ROUTE.Zone
ACT_ROUTE:onafterStart(ProcessUnit, Event, From, To)	StateMachine callback function
ACT_ROUTE:onbeforeRoute(ProcessUnit, Event, From, To)	StateMachine callback function
ACT_ROUTE:onfuncHasArrived(ProcessUnit)	Check if the controllable has arrived.

Type `ACT_ROUTE_POINT`

ACT_ROUTE_POINT.ClassName
ACT_ROUTE_POINT.Coordinate
ACT_ROUTE_POINT.DisplayCount
ACT_ROUTE_POINT.DisplayInterval
ACT_ROUTE_POINT.DisplayMessage
ACT_ROUTE_POINT.DisplayTime
ACT_ROUTE_POINT:GetCoordinate()	Get Coordinate
ACT_ROUTE_POINT:GetRange()	Get Range around Coordinate
ACT_ROUTE_POINT:Init(FsmRoute)	Creates a new routing state machine.
ACT_ROUTE_POINT:New(The, Range, Zone, Coordinate)	Creates a new routing state machine.
ACT_ROUTE_POINT.Range
ACT_ROUTE_POINT:SetCoordinate(Coordinate)	Set Coordinate
ACT_ROUTE_POINT:SetRange(Range)	Set Range around Coordinate
ACT_ROUTE_POINT.TASK
ACT_ROUTE_POINT:onafterReport(ProcessUnit, Event, From, To)	StateMachine callback function
ACT_ROUTE_POINT:onfuncHasArrived(ProcessUnit)	Method override to check if the controllable has arrived.

Type `ACT_ROUTE_ZONE`

ACT_ROUTE_ZONE.Altitude
ACT_ROUTE_ZONE.ClassName
ACT_ROUTE_ZONE.DisplayCount
ACT_ROUTE_ZONE.DisplayInterval
ACT_ROUTE_ZONE.DisplayMessage
ACT_ROUTE_ZONE.DisplayTime
ACT_ROUTE_ZONE:GetZone()	Get Zone
ACT_ROUTE_ZONE.Heading
ACT_ROUTE_ZONE:Init(FsmRoute)
ACT_ROUTE_ZONE:New(Zone)	Creates a new routing state machine.
ACT_ROUTE_ZONE.ProcessUnit
ACT_ROUTE_ZONE:SetZone(Zone, Altitude, Heading)	Set Zone
ACT_ROUTE_ZONE.TASK
ACT_ROUTE_ZONE.Zone
ACT_ROUTE_ZONE:onafterReport(ProcessUnit, Event, From, To)	StateMachine callback function
ACT_ROUTE_ZONE:onfuncHasArrived(ProcessUnit)	Method override to check if the controllable has arrived.