FiniteStateMachine - Documentation

Constructor

new FiniteStateMachine($data)

Description:

Creates a new finite state machine.

Source:

core/finite-state-machine.js, line 29

Example

const toggle = new FiniteStateMachine([

    {
        $state: 'ON',
        $transitions: [{

            $state: 'OFF',
            $condition: ({$timer}) => ($timer >= 1000)
        }]
    },
    {
        $state: 'OFF',
        $transitions: [{

            $state: 'ON',
            $condition: ({$timer}) => ($timer >= 1000)
        }]
    }
]);

toggle.tick(timetick);

Parameters:

Name	Type	Description
`$data`	Array.<TypeState>	The representation of the finite state machine.

Members

initiated :boolean

Description:

Gets the initiated status.

Source:

core/finite-state-machine.js, line 145

Gets the initiated status.

Type:

boolean

state :TypeGeneric

Description:

Gets the name of the current state.

Source:

core/finite-state-machine.js, line 135

Gets the name of the current state.

Type:

TypeGeneric

Methods

initiate($state)

Description:

Initiates the finite state machine.

Source:

core/finite-state-machine.js, line 171

Parameters:

Name	Type	Description
`$state`	TypeGeneric	The name of the state to initiate.

tick($timetick)

Description:

Updates the finite state machine by one tick update.

Source:

core/finite-state-machine.js, line 194

Parameters:

Name	Type	Description
`$timetick`	number	The tick duration (in ms).

Type Definitions

TypeState

Description:

A state.

Source:

core/finite-state-machine.js, line 83

Properties:

Name	Type	Attributes	Description
`TypeState.$state`	TypeGeneric		The name of the state.
`TypeState.$onEnter`	TypeStateHandlerEnter	<optional>	The handler to execute when entering the state.
`TypeState.$onLeave`	TypeStateHandlerLeave	<optional>	The handler to execute when leaving the state.
`TypeState.$onTick`	TypeStateHandlerTick	<optional>	The handler to execute when updating the state.
`TypeState.$transitions`	Array.<TypeStateTransition>	<optional>	The transitions to given states.

A state.

Type:

Object

(protected) TypeStateHandlerEnter($parameters) → {void}

Source:

core/finite-state-machine.js, line 31

Parameters:

Name	Type	Description
`$parameters`	Object	The given parameters.
`$parameters.$previous`	TypeGeneric	The previous state.

Returns:

Type: void

(protected) TypeStateHandlerLeave($parameters) → {void}

Source:

core/finite-state-machine.js, line 41

Parameters:

Name	Type	Description
`$parameters`	Object	The given parameters.
`$parameters.$timer`	number	The timer of the current state.
`$parameters.$next`	TypeGeneric	The next state.

Returns:

Type: void

(protected) TypeStateHandlerTick($parameters) → {void}

Source:

core/finite-state-machine.js, line 52

Parameters:

Name	Type	Description
`$parameters`	Object	The given parameters.
`$parameters.$timetick`	number	The tick duration (in ms).
`$parameters.$timer`	number	The timer of the current state.

Returns:

Type: void

TypeStateTransition

Description:

A transition to a state.

Source:

core/finite-state-machine.js, line 74

Properties:

Name	Type	Description
`TypeStateTransition.$condition`	TypeStateTransitionCondition	The condition to transition to given state.
`TypeStateTransition.$state`	TypeGeneric	The given state to transition to.

A transition to a state.

Type:

Object

(protected) TypeStateTransitionCondition($parameters) → {boolean}

Source:

core/finite-state-machine.js, line 63

Parameters:

Name	Type	Description
`$parameters`	Object	The given parameters.
`$parameters.$previous`	TypeGeneric	The previous state.
`$parameters.$timer`	number	The timer of the current state.

Returns:

Type: boolean