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

    Interface CameraEffect

    Interface for camera effects that can be applied to a camera. Effects modify the position and target of the camera over time.

    interface CameraEffect {
        isFinished: boolean;
        offset: Vector3D;
        targetOffset: Vector3D;
        type: string;
        update(deltaTime: number): void;
    }

    Implemented by

    Index

    Properties

    isFinished: boolean

    Whether the effect has finished its duration and should be removed.

    offset: Vector3D

    The current position offset generated by this effect.

    targetOffset: Vector3D

    The current target offset generated by this effect.

    type: string

    The unique type identifier of the effect.

    Methods

    • Updates the effect state based on elapsed time.

      Parameters

      • deltaTime: number

        Time elapsed since the last frame in seconds.

      Returns void