mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
Found a solution to avoid having to install MOOSE.
Now MOOSE can be copied into the mission file, but you'll need to include a "do file" action of moose.lua in the mission file and copy the rest of the MOOSE files to the MIZ file.
This commit is contained in:
svenvandevelde
453
Moose/Task.lua
Normal file
453
Moose/Task.lua
Normal file
@@ -0,0 +1,453 @@
|
||||
--- 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.
|
||||
-- @classmod TASK
|
||||
|
||||
Include.File( "Routines" )
|
||||
Include.File( "Base" )
|
||||
Include.File( "Mission" )
|
||||
Include.File( "Client" )
|
||||
Include.File( "Stage" )
|
||||
|
||||
TASK = {
|
||||
|
||||
-- Defines the different signal types with a Task.
|
||||
SIGNAL = {
|
||||
COLOR = {
|
||||
RED = { ID = 1, COLOR = trigger.smokeColor.Red, TEXT = "A red" },
|
||||
GREEN = { ID = 2, COLOR = trigger.smokeColor.Green, TEXT = "A green" },
|
||||
BLUE = { ID = 3, COLOR = trigger.smokeColor.Blue, TEXT = "A blue" },
|
||||
WHITE = { ID = 4, COLOR = trigger.smokeColor.White, TEXT = "A white" },
|
||||
ORANGE = { ID = 5, COLOR = trigger.smokeColor.Orange, TEXT = "An orange" }
|
||||
},
|
||||
TYPE = {
|
||||
SMOKE = { ID = 1, TEXT = "smoke" },
|
||||
FLARE = { ID = 2, TEXT = "flare" }
|
||||
}
|
||||
},
|
||||
ClassName = "TASK",
|
||||
Mission = {}, -- Owning mission of the Task
|
||||
Name = '',
|
||||
Stages = {},
|
||||
Stage = {},
|
||||
ActiveStage = 0,
|
||||
TaskDone = false,
|
||||
TaskFailed = false,
|
||||
GoalTasks = {}
|
||||
}
|
||||
|
||||
--- Instantiates a new TASK Base. Should never be used. Interface Class.
|
||||
-- @treturn TASK
|
||||
function TASK:New()
|
||||
trace.f(self.ClassName)
|
||||
|
||||
local self = BASE:Inherit( self, BASE:New() )
|
||||
|
||||
-- assign Task default values during construction
|
||||
self.TaskBriefing = "Task: No Task."
|
||||
self.Time = timer.getTime()
|
||||
self.ExecuteStage = _TransportExecuteStage.NONE
|
||||
|
||||
return self
|
||||
end
|
||||
|
||||
function TASK:SetStage( StageSequenceIncrement )
|
||||
trace.f(self.ClassName, { StageSequenceIncrement } )
|
||||
|
||||
local Valid = false
|
||||
if StageSequenceIncrement ~= 0 then
|
||||
self.ActiveStage = self.ActiveStage + StageSequenceIncrement
|
||||
if 1 <= self.ActiveStage and self.ActiveStage <= #self.Stages then
|
||||
self.Stage = self.Stages[self.ActiveStage]
|
||||
trace.i( self.ClassName, { self.Stage.Name } )
|
||||
self.Frequency = self.Stage.Frequency
|
||||
Valid = true
|
||||
else
|
||||
Valid = false
|
||||
env.info( "TASK:SetStage() self.ActiveStage is smaller or larger than self.Stages array. self.ActiveStage = " .. self.ActiveStage )
|
||||
end
|
||||
end
|
||||
self.Time = timer.getTime()
|
||||
return Valid
|
||||
end
|
||||
|
||||
function TASK:Init()
|
||||
trace.f(self.ClassName)
|
||||
self.ActiveStage = 0
|
||||
self:SetStage(1)
|
||||
self.TaskDone = false
|
||||
self.TaskFailed = false
|
||||
end
|
||||
|
||||
|
||||
--- Get progress of a TASK.
|
||||
-- @treturn string GoalsText
|
||||
function TASK:GetGoalProgress()
|
||||
trace.f(self.ClassName)
|
||||
|
||||
local GoalsText = ""
|
||||
for GoalVerb, GoalVerbData in pairs( self.GoalTasks ) do
|
||||
local Goals = self:GetGoalCompletion( GoalVerb )
|
||||
if Goals and Goals ~= "" then
|
||||
Goals = '(' .. Goals .. ')'
|
||||
else
|
||||
Goals = '( - )'
|
||||
end
|
||||
GoalsText = GoalsText .. GoalVerb .. ': ' .. self:GetGoalCount(GoalVerb) .. ' goals ' .. Goals .. ' of ' .. self:GetGoalTotal(GoalVerb) .. ' goals completed (' .. self:GetGoalPercentage(GoalVerb) .. '%); '
|
||||
end
|
||||
|
||||
if GoalsText == "" then
|
||||
GoalsText = "( - )"
|
||||
end
|
||||
|
||||
return GoalsText
|
||||
end
|
||||
|
||||
--- Show progress of a TASK.
|
||||
-- @tparam MISSION Mission Group structure describing the Mission.
|
||||
-- @tparam CLIENT Client Group structure describing the Client.
|
||||
function TASK:ShowGoalProgress( Mission, Client )
|
||||
trace.f(self.ClassName)
|
||||
|
||||
local GoalsText = ""
|
||||
for GoalVerb, GoalVerbData in pairs( self.GoalTasks ) do
|
||||
if Mission:IsCompleted() then
|
||||
else
|
||||
local Goals = self:GetGoalCompletion( GoalVerb )
|
||||
if Goals and Goals ~= "" then
|
||||
else
|
||||
Goals = "-"
|
||||
end
|
||||
GoalsText = GoalsText .. self:GetGoalProgress()
|
||||
end
|
||||
end
|
||||
|
||||
Client:Message( GoalsText, 10, "/TASKPROGRESS" .. self.ClassName, "Mission Command: Task Status", 30 )
|
||||
end
|
||||
|
||||
--- Sets a TASK to status Done.
|
||||
function TASK:Done()
|
||||
trace.f(self.ClassName)
|
||||
self.TaskDone = true
|
||||
end
|
||||
|
||||
--- Returns if a TASK is done.
|
||||
-- @treturn bool
|
||||
function TASK:IsDone()
|
||||
trace.f(self.ClassName)
|
||||
return self.TaskDone
|
||||
end
|
||||
|
||||
--- Sets a TASK to status failed.
|
||||
function TASK:Failed()
|
||||
trace.f(self.ClassName)
|
||||
self.TaskFailed = true
|
||||
end
|
||||
|
||||
--- Returns if a TASk has failed.
|
||||
-- @return bool
|
||||
function TASK:IsFailed()
|
||||
trace.f(self.ClassName)
|
||||
return self.TaskFailed
|
||||
end
|
||||
|
||||
function TASK:Reset( Mission, Client )
|
||||
trace.f(self.ClassName)
|
||||
self.ExecuteStage = _TransportExecuteStage.NONE
|
||||
end
|
||||
|
||||
--- Returns the Goals of a TASK
|
||||
-- @treturn @table Goals
|
||||
function TASK:GetGoals()
|
||||
return self.GoalTasks
|
||||
end
|
||||
|
||||
--- Returns if a TASK has Goal(s).
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK.
|
||||
-- @treturn bool
|
||||
function TASK:Goal( GoalVerb )
|
||||
trace.f(self.ClassName)
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
if self.GoalTasks[GoalVerb] and self.GoalTasks[GoalVerb].GoalTotal > 0 then
|
||||
return true
|
||||
else
|
||||
return false
|
||||
end
|
||||
end
|
||||
|
||||
--- Sets the total Goals to be achieved of the Goal Name
|
||||
-- @tparam number GoalTotal is the number of times the GoalVerb needs to be achieved.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
function TASK:SetGoalTotal( GoalTotal, GoalVerb )
|
||||
trace.f(self.ClassName, { GoalTotal, GoalVerb } )
|
||||
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
self.GoalTasks[GoalVerb] = {}
|
||||
self.GoalTasks[GoalVerb].Goals = {}
|
||||
self.GoalTasks[GoalVerb].GoalTotal = GoalTotal
|
||||
self.GoalTasks[GoalVerb].GoalCount = 0
|
||||
return self
|
||||
end
|
||||
|
||||
--- Gets the total of Goals to be achieved within the TASK of the GoalVerb.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
function TASK:GetGoalTotal( GoalVerb )
|
||||
trace.f(self.ClassName)
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
if self:Goal( GoalVerb ) then
|
||||
return self.GoalTasks[GoalVerb].GoalTotal
|
||||
else
|
||||
return 0
|
||||
end
|
||||
end
|
||||
|
||||
--- Sets the total of Goals currently achieved within the TASK of the GoalVerb.
|
||||
-- @tparam number GoalCount is the total number of Goals achieved within the TASK.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
-- @treturn TASK
|
||||
function TASK:SetGoalCount( GoalCount, GoalVerb )
|
||||
trace.f(self.ClassName)
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
if self:Goal( GoalVerb) then
|
||||
self.GoalTasks[GoalVerb].GoalCount = GoalCount
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Increments the total of Goals currently achieved within the TASK of the GoalVerb, with the given GoalCountIncrease.
|
||||
-- @tparam number GoalCountIncrease is the number of new Goals achieved within the TASK.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
-- @treturn TASK
|
||||
function TASK:IncreaseGoalCount( GoalCountIncrease, GoalVerb )
|
||||
trace.f(self.ClassName)
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
if self:Goal( GoalVerb) then
|
||||
self.GoalTasks[GoalVerb].GoalCount = self.GoalTasks[GoalVerb].GoalCount + GoalCountIncrease
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Gets the total of Goals currently achieved within the TASK of the GoalVerb.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
-- @treturn TASK
|
||||
function TASK:GetGoalCount( GoalVerb )
|
||||
trace.f(self.ClassName)
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
if self:Goal( GoalVerb ) then
|
||||
return self.GoalTasks[GoalVerb].GoalCount
|
||||
else
|
||||
return 0
|
||||
end
|
||||
end
|
||||
|
||||
--- Gets the percentage of Goals currently achieved within the TASK of the GoalVerb.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
-- @treturn TASK
|
||||
function TASK:GetGoalPercentage( GoalVerb )
|
||||
trace.f(self.ClassName)
|
||||
if not GoalVerb then
|
||||
GoalVerb = self.GoalVerb
|
||||
end
|
||||
if self:Goal( GoalVerb ) then
|
||||
return math.floor( self:GetGoalCount( GoalVerb ) / self:GetGoalTotal( GoalVerb ) * 100 + .5 )
|
||||
else
|
||||
return 100
|
||||
end
|
||||
end
|
||||
|
||||
--- Returns if all the Goals of the TASK were achieved.
|
||||
-- @treturn bool
|
||||
function TASK:IsGoalReached( )
|
||||
trace.f(self.ClassName)
|
||||
|
||||
local GoalReached = true
|
||||
|
||||
for GoalVerb, Goals in pairs( self.GoalTasks ) do
|
||||
trace.i( self.ClassName, { "GoalVerb", GoalVerb } )
|
||||
if self:Goal( GoalVerb ) then
|
||||
local GoalToDo = self:GetGoalTotal( GoalVerb ) - self:GetGoalCount( GoalVerb )
|
||||
trace.i( self.ClassName, "GoalToDo = " .. GoalToDo )
|
||||
if GoalToDo <= 0 then
|
||||
else
|
||||
GoalReached = false
|
||||
break
|
||||
end
|
||||
else
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
return GoalReached
|
||||
end
|
||||
|
||||
--- Adds an Additional Goal for the TASK to be achieved.
|
||||
-- @tparam string GoalVerb is the name of the Goal of the TASK.
|
||||
-- @tparam string GoalTask is a text describing the Goal of the TASK to be achieved.
|
||||
-- @tparam number GoalIncrease is a number by which the Goal achievement is increasing.
|
||||
function TASK:AddGoalCompletion( GoalVerb, GoalTask, GoalIncrease )
|
||||
trace.f( self.ClassName, { GoalVerb, GoalTask, GoalIncrease } )
|
||||
|
||||
if self:Goal( GoalVerb ) then
|
||||
self.GoalTasks[GoalVerb].Goals[#self.GoalTasks[GoalVerb].Goals+1] = GoalTask
|
||||
self.GoalTasks[GoalVerb].GoalCount = self.GoalTasks[GoalVerb].GoalCount + GoalIncrease
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Returns if the additional Goal for the TASK was completed.
|
||||
-- @tparam ?string GoalVerb is the name of the Goal of the TASK. If the GoalVerb is not given, then the default TASK Goals will be used.
|
||||
-- @treturn string Goals
|
||||
function TASK:GetGoalCompletion( GoalVerb )
|
||||
trace.f( self.ClassName, { GoalVerb } )
|
||||
|
||||
if self:Goal( GoalVerb ) then
|
||||
local Goals = ""
|
||||
for GoalID, GoalName in pairs( self.GoalTasks[GoalVerb].Goals ) do Goals = Goals .. GoalName .. " + " end
|
||||
return Goals:gsub(" + $", ""), self.GoalTasks[GoalVerb].GoalCount
|
||||
end
|
||||
end
|
||||
|
||||
function TASK.MenuAction( Parameter )
|
||||
trace.menu("TASK","MenuAction")
|
||||
trace.l( "TASK", "MenuAction", { Parameter } )
|
||||
Parameter.ReferenceTask.ExecuteStage = _TransportExecuteStage.EXECUTING
|
||||
Parameter.ReferenceTask.CargoName = Parameter.CargoName
|
||||
|
||||
end
|
||||
|
||||
function TASK:StageExecute()
|
||||
trace.f(self.ClassName)
|
||||
|
||||
local Execute = false
|
||||
|
||||
if self.Frequency == STAGE.FREQUENCY.REPEAT then
|
||||
Execute = true
|
||||
elseif self.Frequency == STAGE.FREQUENCY.NONE then
|
||||
Execute = false
|
||||
elseif self.Frequency >= 0 then
|
||||
Execute = true
|
||||
self.Frequency = self.Frequency - 1
|
||||
end
|
||||
|
||||
return Execute
|
||||
|
||||
end
|
||||
|
||||
--- Work function to set signal events within a TASK.
|
||||
function TASK:AddSignal( SignalUnitNames, SignalType, SignalColor, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
|
||||
local Valid = true
|
||||
|
||||
if Valid then
|
||||
if type( SignalUnitNames ) == "table" then
|
||||
self.LandingZoneSignalUnitNames = SignalUnitNames
|
||||
else
|
||||
self.LandingZoneSignalUnitNames = { SignalUnitNames }
|
||||
end
|
||||
self.LandingZoneSignalType = SignalType
|
||||
self.LandingZoneSignalColor = SignalColor
|
||||
self.Signalled = false
|
||||
if SignalHeight ~= nil then
|
||||
self.LandingZoneSignalHeight = SignalHeight
|
||||
else
|
||||
self.LandingZoneSignalHeight = 0
|
||||
end
|
||||
|
||||
if self.TaskBriefing then
|
||||
self.TaskBriefing = self.TaskBriefing .. " " .. SignalColor.TEXT .. " " .. SignalType.TEXT .. " will be fired when entering the landing zone."
|
||||
end
|
||||
end
|
||||
|
||||
return Valid
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a RED SMOKE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddSmokeRed( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.RED, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a GREEN SMOKE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddSmokeGreen( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.GREEN, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a BLUE SMOKE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddSmokeBlue( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.BLUE, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a WHITE SMOKE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddSmokeWhite( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.WHITE, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, an ORANGE SMOKE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddSmokeOrange( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.SMOKE, TASK.SIGNAL.COLOR.ORANGE, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a RED FLARE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddFlareRed( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.RED, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a GREEN FLARE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddFlareGreen( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.GREEN, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a BLUE FLARE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddFlareBlue( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.BLUE, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, a WHITE FLARE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddFlareWhite( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.WHITE, SignalHeight )
|
||||
end
|
||||
|
||||
--- When the CLIENT is approaching the landing zone, an ORANGE FLARE will be fired by an optional SignalUnitNames.
|
||||
-- @tparam table|string SignalUnitNames 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.
|
||||
-- @tparam number SignalHeight Altitude that the Signal should be fired...
|
||||
function TASK:AddFlareOrange( SignalUnitNames, SignalHeight )
|
||||
trace.f(self.ClassName)
|
||||
self:AddSignal( SignalUnitNames, TASK.SIGNAL.TYPE.FLARE, TASK.SIGNAL.COLOR.ORANGE, SignalHeight )
|
||||
end
|
||||
Reference in New Issue
Block a user