nape-js API
    Preparing search index...

    Interface TriggerZoneOptions

    Configuration options for TriggerZone.

    interface TriggerZoneOptions {
        filter?: CbType | OptionType | null;
        interactionType?: InteractionType;
        onEnter?: TriggerHandler | null;
        onExit?: TriggerHandler | null;
        onStay?: TriggerHandler | null;
    }
    Index

    Properties

    filter? interactionType? onEnter? onExit? onStay?

    Properties

    filter?: CbType | OptionType | null

    Filter for which interactors trigger the zone. When null, any interactor triggers the zone.

    null
    interactionType?: InteractionType

    The interaction type to listen for.

    InteractionType.SENSOR
    onEnter?: TriggerHandler | null

    Called once when an interactor enters the zone.

    onExit?: TriggerHandler | null

    Called once when an interactor exits the zone.

    onStay?: TriggerHandler | null

    Called every simulation step while an interactor remains in the zone.

    Settings

    Member Visibility

    On This Page

    Properties