Small World Engine API Reference - v0.78.00
    Preparing search index...

    Class PathFollowerBehavior

    Moves an object along a 3D curve (e.g., CatmullRomSpline) over time. Optionally orients the object to face the direction of travel.

    Hierarchy (View Summary)

    Index
    constructor
    curve duration isActive lookForward pingPong target uuid inspector?
    clone onAttach onDetach update

    • Parameters

      • curve: Curve3D

        The mathematical path to follow.

      • duration: number = 5.0

        Time in seconds to complete the path.

      • lookForward: boolean = true

        If true, aligns the object's rotation with the path's tangent (forward direction).

      • pingPong: boolean = false

        If true, the object reverses direction at the ends of the path. Otherwise it loops back to 0.

      Returns PathFollowerBehavior

    curve: Curve3D
    duration: number
    isActive: boolean = true
    lookForward: boolean
    pingPong: boolean
    target: CameraInterfaceData | Object3D | undefined = undefined

    The object this behavior is attached to. Set automatically.

    uuid: string = ...
    inspector?: Record<string, InspectorField>

    • Returns an independent copy of this behavior (own uuid, target cleared -- the caller is expected to attachBehavior() it onto the new host, which sets target correctly via onAttach()). Used by Object3D.clone() (Maker's Duplicate command).

      Returns Behavior

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods