Class ComponentStateMachine<State>

Core functionality of the state machine, holding solely the current state and, while in transition, the next state, the instructions for the machine and comfort methods to transit and act.

Type Parameters

  • State

Hierarchy (view full)

Implements

Constructors

Properties

stateCurrent: State
stateNext: State
baseClass: typeof Component

refers back to this class from any subclass e.g. in order to find compatible other resources

iSubclass: number

subclasses get a iSubclass number for identification

subclasses: typeof Component[]

list of all the subclasses derived from this class, if they registered properly

Accessors

  • get isActive(): boolean
  • Returns boolean

  • get isSingleton(): boolean
  • Is true, when only one instance of the component class can be attached to a node

    Returns boolean

  • get node(): ƒ.Node
  • Retrieves the node, this component is currently attached to

    Returns ƒ.Node

  • get type(): string
  • Retrieves the type of this mutable subclass as the name of the runtime class

    Returns string

    The type of the mutable

Methods

  • De- / Activate this component. Inactive components will not be processed by the renderer.

    Parameters

    • _on: boolean

    Returns void

  • Tries to attach the component to the given node, removing it from the node it was attached to if applicable

    Parameters

    Returns void

  • Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

    Parameters

    • Optional _extendable: boolean

    Returns Mutator

  • Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses

    Parameters

    • _mutator: Mutator
    • Optional _selection: string[]
    • Optional _dispatchMutate: boolean

    Returns Promise<void>

  • Updates the values of the given mutator according to the current state of the instance

    Parameters

    Returns void