MOOSE

• Index

Contents

• Methods

Classes

• BASE
• CARGO
• CLEANUP
• CLIENT
• DATABASE
• DEPLOYTASK
• DESTROYBASETASK
• DESTROYGROUPSTASK
• DESTROYRADARSTASK
• DESTROYUNITTYPESTASK
• GOHOMETASK
• MENU
• MESSAGE
• MISSION
• MOVEMENT
• NOTASK
• PICKUPTASK
• ROUTETASK
• SEAD
• SLINGLOADHOOKTASK
• SLINGLOADUNHOOKTASK
• SPAWN
• STAGE
• TASK

Modules

• routines
• trace

Scripts

• eStatHandler

Topics

• manual

Class TASK

The TASK Classes define major end-to-end activities within a MISSION.

The TASK Class is the Master Class to orchestrate these activities. From this class, many concrete TASK classes are inherited.

Methods

TASK:New ()	Instantiates a new TASK Base.
TASK:GetGoalProgress ()	Get progress of a TASK.
TASK:ShowGoalProgress (Mission, Client)	Show progress of a TASK.
TASK:Done ()	Sets a TASK to status Done.
TASK:IsDone ()	Returns if a TASK is done.
TASK:Failed ()	Sets a TASK to status failed.
TASK:IsFailed ()	Returns if a TASk has failed.
TASK:GetGoals ()	Returns the Goals of a TASK
TASK:Goal (GoalVerb)	Returns if a TASK has Goal(s).
TASK:SetGoalTotal (GoalTotal, GoalVerb)	Sets the total Goals to be achieved of the Goal Name
TASK:GetGoalTotal (GoalVerb)	Gets the total of Goals to be achieved within the TASK of the GoalVerb.
TASK:SetGoalCount (GoalCount, GoalVerb)	Sets the total of Goals currently achieved within the TASK of the GoalVerb.
TASK:IncreaseGoalCount (GoalCountIncrease, GoalVerb)	Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.
TASK:GetGoalCount (GoalVerb)	Gets the total of Goals currently achieved within the TASK of the GoalVerb.
TASK:GetGoalPercentage (GoalVerb)	Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.
TASK:IsGoalReached ()	Returns if all the Goals of the TASK were achieved.
TASK:AddGoalCompletion (GoalVerb, GoalTask, GoalIncrease)	Adds an Additional Goal for the TASK to be achieved.
TASK:GetGoalCompletion (GoalVerb)	Returns if the additional Goal for the TASK was completed.
TASK:AddSignal (SignalUnitNames, SignalType, SignalColor, SignalHeight)	Work function to set signal events within a TASK.
TASK:AddSmokeRed (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeGreen (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeBlue (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeWhite (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.
TASK:AddSmokeOrange (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.
TASK:AddFlareRed (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareGreen (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareBlue (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareWhite (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.
TASK:AddFlareOrange (SignalUnitNames, SignalHeight)	When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

Methods

TASK:New ()

Instantiates a new TASK Base. Should never be used. Interface Class.

Returns:

TASK

TASK:GetGoalProgress ()

Get progress of a TASK.

Returns:

string GoalsText

TASK:ShowGoalProgress (Mission, Client)

Show progress of a TASK.

Parameters:

• Mission MISSION

      Group structure describing the Mission.
  

• Client CLIENT

          Group structure describing the Client.
  

TASK:Done ()

Sets a TASK to status Done.

TASK:IsDone ()

Returns if a TASK is done.

Returns:

bool

TASK:Failed ()

Sets a TASK to status failed.

TASK:IsFailed ()

Returns if a TASk has failed.

Returns:

bool

TASK:GetGoals ()

Returns the Goals of a TASK

Returns:

Goals

TASK:Goal (GoalVerb)

Returns if a TASK has Goal(s).

Parameters:

• GoalVerb optional string is the name of the Goal of the TASK.

Returns:

bool

TASK:SetGoalTotal (GoalTotal, GoalVerb)

Sets the total Goals to be achieved of the Goal Name

Parameters:

• GoalTotal number is the number of times the GoalVerb needs to be achieved.
• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

TASK:GetGoalTotal (GoalVerb)

Gets the total of Goals to be achieved within the TASK of the GoalVerb.

Parameters:

• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

TASK:SetGoalCount (GoalCount, GoalVerb)

Sets the total of Goals currently achieved within the TASK of the GoalVerb.

Parameters:

• GoalCount number is the total number of Goals achieved within the TASK.
• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

Returns:

TASK

TASK:IncreaseGoalCount (GoalCountIncrease, GoalVerb)

Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.

Parameters:

• GoalCountIncrease number is the number of new Goals achieved within the TASK.
• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

Returns:

TASK

TASK:GetGoalCount (GoalVerb)

Gets the total of Goals currently achieved within the TASK of the GoalVerb.

Parameters:

• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

Returns:

TASK

TASK:GetGoalPercentage (GoalVerb)

Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.

Parameters:

• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

Returns:

TASK

TASK:IsGoalReached ()

Returns if all the Goals of the TASK were achieved.

Returns:

bool

TASK:AddGoalCompletion (GoalVerb, GoalTask, GoalIncrease)

Adds an Additional Goal for the TASK to be achieved.

Parameters:

• GoalVerb string is the name of the Goal of the TASK.
• GoalTask string is a text describing the Goal of the TASK to be achieved.
• GoalIncrease number is a number by which the Goal achievement is increasing.

TASK:GetGoalCompletion (GoalVerb)

Returns if the additional Goal for the TASK was completed.

Parameters:

• GoalVerb optional string is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.

Returns:

string Goals

TASK:AddSignal (SignalUnitNames, SignalType, SignalColor, SignalHeight)

Work function to set signal events within a TASK.

Parameters:

• SignalUnitNames
• SignalType
• SignalColor
• SignalHeight

TASK:AddSmokeRed (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddSmokeGreen (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddSmokeBlue (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddSmokeWhite (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddSmokeOrange (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddFlareRed (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddFlareGreen (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddFlareBlue (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddFlareWhite (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...

TASK:AddFlareOrange (SignalUnitNames, SignalHeight)

When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.

Parameters:

• SignalUnitNames table or string Name of the Group that will fire the signal. If this parameter is NIL, the signal will be fired from the center of the landing zone.
• SignalHeight number Altitude that the Signal should be fired...