FMAR.Internal.Procedures.ProcedureManager Class Reference

The procedure manager. Handles procedure flow, as well as stopping and starting procedures. More...

Inheritance diagram for FMAR.Internal.Procedures.ProcedureManager:

Public Member Functions
void	StartProcedure (Procedure procedure)
	Begins the procedure.
void	EndProcedure ()
	Ends the current procedure.
void	AssumeStack (List< Procedure > procedures, List< StepBase > steps)
	Assumes a stack of procedures and steps.
void	GoNextStep (bool forceNext=false)
	Moves to the next step.
void	TakeBranchPath (Path path)
	Takes a branch path.

Static Public Member Functions
static string	GetBranchText (int i)
static Color	GetBranchColor (int i)
static string	GetHierachyText ()
	Gets the current procedure hierarchy as a string.

Public Attributes
List< Procedure >	procedureDatabase = new()

Properties
static ProcedureManager	Instance [get]
static List< Procedure >	CurrentProcedures [get]
	The current procedure stack.
static List< StepBase >	CurrentSteps [get]
	The current steps within the current procedure.
static List< StepBase >	CompletedSteps [get]
	The steps that have been completed.

Events
static Action	OnBaseProcedureChanged
	Called when the base procedure changes.
static Action	OnProcedureChanged
	Called when the procedure changes.
static Action	OnStepChanged
	Called when the step changes.
static Action	OnProcedureEnded
	Called when the procedure ends.

Detailed Description

The procedure manager. Handles procedure flow, as well as stopping and starting procedures.

Member Function Documentation

AssumeStack()

void FMAR.Internal.Procedures.ProcedureManager.AssumeStack ( List< Procedure > procedures, List< StepBase > steps )

inline

Assumes a stack of procedures and steps.

Parameters

procedures	The procedures to assume.
steps	The steps to assume.

EndProcedure()

void FMAR.Internal.Procedures.ProcedureManager.EndProcedure ( )

inline

Ends the current procedure.

GetBranchColor()

static Color FMAR.Internal.Procedures.ProcedureManager.GetBranchColor ( int i )

inlinestatic

GetBranchText()

static string FMAR.Internal.Procedures.ProcedureManager.GetBranchText ( int i )

inlinestatic

GetHierachyText()

static string FMAR.Internal.Procedures.ProcedureManager.GetHierachyText ( )

inlinestatic

Gets the current procedure hierarchy as a string.

Returns

The current procedure hierarchy as a string.

GoNextStep()

void FMAR.Internal.Procedures.ProcedureManager.GoNextStep ( bool forceNext = false )

inline

Moves to the next step.

Parameters

forceNext

If true, will move to the next step regardless of the current step.

StartProcedure()

void FMAR.Internal.Procedures.ProcedureManager.StartProcedure ( Procedure procedure )

inline

Begins the procedure.

Parameters

procedure

The procedure to begin.

TakeBranchPath()

void FMAR.Internal.Procedures.ProcedureManager.TakeBranchPath ( Path path )

inline

Takes a branch path.

Parameters

path	The path to take.

Member Data Documentation

procedureDatabase

List<Procedure> FMAR.Internal.Procedures.ProcedureManager.procedureDatabase = new()

Property Documentation

CompletedSteps

List<StepBase> FMAR.Internal.Procedures.ProcedureManager.CompletedSteps

staticget

The steps that have been completed.

CurrentProcedures

List<Procedure> FMAR.Internal.Procedures.ProcedureManager.CurrentProcedures

staticget

The current procedure stack.

CurrentSteps

List<StepBase> FMAR.Internal.Procedures.ProcedureManager.CurrentSteps

staticget

The current steps within the current procedure.

Instance

ProcedureManager FMAR.Internal.Procedures.ProcedureManager.Instance

staticget

Event Documentation

OnBaseProcedureChanged

Action FMAR.Internal.Procedures.ProcedureManager.OnBaseProcedureChanged

static

Called when the base procedure changes.

OnProcedureChanged

Action FMAR.Internal.Procedures.ProcedureManager.OnProcedureChanged

static

Called when the procedure changes.

OnProcedureEnded

Action FMAR.Internal.Procedures.ProcedureManager.OnProcedureEnded

static

Called when the procedure ends.

OnStepChanged

Action FMAR.Internal.Procedures.ProcedureManager.OnStepChanged

static

Called when the step changes.

---

The documentation for this class was generated from the following file:

• /github/workspace/Packages/FMAR/Internal/Procedures/Runtime/Scripts/ProcedureManager.cs