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

    Interface PulsatingBehaviorOptions

    Configuration options for the PulsatingBehavior.

    interface PulsatingBehaviorOptions {
        max?: number;
        maxDuration?: number;
        min?: number;
        minDuration?: number;
        onUpdate: (value: number, targetObj: Object3D) => void;
    }
    Index

    Properties

    max? maxDuration? min? minDuration? onUpdate

    Properties

    max?: number

    Maximum value of the pulsation. Defaults to 1.0.

    maxDuration?: number

    Maximum duration of one full pulsation cycle in seconds. Defaults to 5.0.

    min?: number

    Minimum value of the pulsation. Defaults to 0.0.

    minDuration?: number

    Minimum duration of one full pulsation cycle in seconds. Defaults to 2.0.

    onUpdate: (value: number, targetObj: Object3D) => void

    The callback that applies the pulsating value.

    Settings

    Member Visibility

    On This Page

    Properties