Enables this node to access the waypoint grid established through ComponentWaypoints and their Connections, find a path through them and even walk down the path.

Author

Lukas Scheuerle, HFU, 2024

Hierarchy (view full)

Constructors

Properties

speed: number = 1

The speed the walker should move with. Corresponds to units/s.

baseClass: typeof Component = 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 isSingleton(): boolean
  • Is true, when only one instance of the component class can be attached to a node

    Returns boolean

  • 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

  • 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

    • _extendable: boolean = false

    Returns Mutator

  • Teleports (moves instantly) to the _target Waypoint.

    Parameters

    Returns Promise<void>

    a Promise that resolves immediately.

  • Moves the walker from the _start to the _end Waypoint. Teleports (moves instantly) to the _start point, then moves through the waypoint connections to the _end point.

    Parameters

    • _start: Waypoint
    • _end: Waypoint
    • Optional _rotate: boolean

      Rotates the walker to look in the direction of the waypoint

    Returns Promise<void>

    a Promise that resolves when the _end point is reached. Rejects if _end can't be reached (no path found).

  • 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
    • _selection: string[] = null
    • _dispatchMutate: boolean = true

    Returns Promise<void>