mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
146 lines
3.4 KiB
Lua
146 lines
3.4 KiB
Lua
--- **Core (WIP)** -- Base class to allow the modeling of processes to achieve Goals.
|
|
--
|
|
-- ===
|
|
--
|
|
-- GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
|
|
--
|
|
-- ===
|
|
--
|
|
-- ### Author: **FlightControl**
|
|
--
|
|
-- ===
|
|
--
|
|
-- @module Core.Goal
|
|
|
|
do -- Goal
|
|
|
|
--- @type GOAL
|
|
-- @extends Core.Fsm#FSM
|
|
|
|
|
|
--- # GOAL class, extends @{Core.Fsm#FSM}
|
|
--
|
|
-- GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
|
|
--
|
|
-- ## 1. GOAL constructor
|
|
--
|
|
-- * @{#GOAL.New}(): Creates a new GOAL object.
|
|
--
|
|
-- ## 2. GOAL is a finite state machine (FSM).
|
|
--
|
|
-- ### 2.1 GOAL States
|
|
--
|
|
-- * **Pending**: The goal object is in progress.
|
|
-- * **Achieved**: The goal objective is Achieved.
|
|
--
|
|
-- ### 2.2 GOAL Events
|
|
--
|
|
-- * **Achieved**: Set the goal objective to Achieved.
|
|
--
|
|
-- @field #GOAL
|
|
GOAL = {
|
|
ClassName = "GOAL",
|
|
}
|
|
|
|
--- @field #table GOAL.Players
|
|
GOAL.Players = {}
|
|
|
|
--- @field #number GOAL.TotalContributions
|
|
GOAL.TotalContributions = 0
|
|
|
|
--- GOAL Constructor.
|
|
-- @param #GOAL self
|
|
-- @return #GOAL
|
|
function GOAL:New()
|
|
|
|
local self = BASE:Inherit( self, FSM:New() ) -- #GOAL
|
|
self:F( {} )
|
|
|
|
--- Achieved State for GOAL
|
|
-- @field GOAL.Achieved
|
|
|
|
--- Achieved State Handler OnLeave for GOAL
|
|
-- @function [parent=#GOAL] OnLeaveAchieved
|
|
-- @param #GOAL self
|
|
-- @param #string From
|
|
-- @param #string Event
|
|
-- @param #string To
|
|
-- @return #boolean
|
|
|
|
--- Achieved State Handler OnEnter for GOAL
|
|
-- @function [parent=#GOAL] OnEnterAchieved
|
|
-- @param #GOAL self
|
|
-- @param #string From
|
|
-- @param #string Event
|
|
-- @param #string To
|
|
|
|
|
|
self:SetStartState( "Pending" )
|
|
self:AddTransition( "*", "Achieved", "Achieved" )
|
|
|
|
--- Achieved Handler OnBefore for GOAL
|
|
-- @function [parent=#GOAL] OnBeforeAchieved
|
|
-- @param #GOAL self
|
|
-- @param #string From
|
|
-- @param #string Event
|
|
-- @param #string To
|
|
-- @return #boolean
|
|
|
|
--- Achieved Handler OnAfter for GOAL
|
|
-- @function [parent=#GOAL] OnAfterAchieved
|
|
-- @param #GOAL self
|
|
-- @param #string From
|
|
-- @param #string Event
|
|
-- @param #string To
|
|
|
|
--- Achieved Trigger for GOAL
|
|
-- @function [parent=#GOAL] Achieved
|
|
-- @param #GOAL self
|
|
|
|
--- Achieved Asynchronous Trigger for GOAL
|
|
-- @function [parent=#GOAL] __Achieved
|
|
-- @param #GOAL self
|
|
-- @param #number Delay
|
|
|
|
self:SetEventPriority( 5 )
|
|
|
|
return self
|
|
end
|
|
|
|
|
|
--- @param #GOAL self
|
|
-- @param #string PlayerName
|
|
function GOAL:AddPlayerContribution( PlayerName )
|
|
self.Players[PlayerName] = self.Players[PlayerName] or 0
|
|
self.Players[PlayerName] = self.Players[PlayerName] + 1
|
|
self.TotalContributions = self.TotalContributions + 1
|
|
end
|
|
|
|
|
|
--- @param #GOAL self
|
|
-- @param #number Player contribution.
|
|
function GOAL:GetPlayerContribution( PlayerName )
|
|
return self.Players[PlayerName] or 0
|
|
end
|
|
|
|
|
|
--- @param #GOAL self
|
|
function GOAL:GetPlayerContributions()
|
|
return self.Players or {}
|
|
end
|
|
|
|
|
|
--- @param #GOAL self
|
|
function GOAL:GetTotalContributions()
|
|
return self.TotalContributions or 0
|
|
end
|
|
|
|
|
|
|
|
--- @param #GOAL self
|
|
-- @return #boolean true if the goal is Achieved
|
|
function GOAL:IsAchieved()
|
|
return self:Is( "Achieved" )
|
|
end
|
|
|
|
end |