Module Goal

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

Global(s)

GOAL

GOAL class, extends Fsm#FSM

GOAL models processes that have an objective with a defined achievement.

Type GOAL

GOAL:Achieved()

Achieved Trigger for GOAL
GOAL:AddPlayerContribution(PlayerName)
GOAL:GetPlayerContribution(Player, PlayerName)
GOAL:GetPlayerContributions()
GOAL:GetTotalContributions()
GOAL:IsAchieved()
GOAL:New()

GOAL Constructor.
GOAL:OnAfterAchieved(From, Event, To)

Achieved Handler OnAfter for GOAL
GOAL:OnBeforeAchieved(From, Event, To)

Achieved Handler OnBefore for GOAL
GOAL:OnEnterAchieved(From, Event, To)

Achieved State Handler OnEnter for GOAL
GOAL:OnLeaveAchieved(From, Event, To)

Achieved State Handler OnLeave for GOAL
GOAL.Players
GOAL.TotalContributions
GOAL:__Achieved(Delay)

Achieved Asynchronous Trigger for GOAL

Global(s)

#GOAL GOAL

GOAL class, extends 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.

Type Goal

Type GOAL

Field(s)

GOAL:Achieved()

Achieved Trigger for GOAL

GOAL:AddPlayerContribution(PlayerName)

Parameter

  • #string PlayerName :

GOAL:GetPlayerContribution(Player, PlayerName)

Parameters

  • #number Player : contribution.

  • PlayerName :

GOAL:GetPlayerContributions()
GOAL:GetTotalContributions()
GOAL:IsAchieved()

Return value

#boolean: true if the goal is Achieved

GOAL:New()

GOAL Constructor.

Return value

#GOAL:

GOAL:OnAfterAchieved(From, Event, To)

Achieved Handler OnAfter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnBeforeAchieved(From, Event, To)

Achieved Handler OnBefore for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL:OnEnterAchieved(From, Event, To)

Achieved State Handler OnEnter for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

GOAL:OnLeaveAchieved(From, Event, To)

Achieved State Handler OnLeave for GOAL

Parameters

  • #string From :

  • #string Event :

  • #string To :

Return value

#boolean:

GOAL.Players
GOAL.TotalContributions
GOAL:__Achieved(Delay)

Achieved Asynchronous Trigger for GOAL

Parameter

  • #number Delay :