Strata - v1.4.10
    Preparing search index...

    Interface GroundSwitchProps

    Props for the GroundSwitch component.

    interface GroundSwitchProps {
        axis?: "x" | "z";
        material?: "steel" | "brass" | "chrome";
        onActivate?: (event: InputEvent) => void;
        onAxisChange?: (axis: InputAxis, worldPosition: Vector3) => void;
        onDeactivate?: (event: InputEvent) => void;
        onPress?: (event: InputEvent) => void;
        onRelease?: (event: InputEvent) => void;
        position?: [number, number, number];
        size?: number;
        throwDistance?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    axis? material? onActivate? onAxisChange? onDeactivate? onPress? onRelease? position? size? throwDistance?

    Properties

    axis?: "x" | "z"

    Primary axis of movement ('x' or 'z'). Default: 'z'.

    material?: "steel" | "brass" | "chrome"

    Visual material style. Default: 'steel'.

    onActivate?: (event: InputEvent) => void

    Fired when the control is first pressed or activated.

    onAxisChange?: (axis: InputAxis, worldPosition: Vector3) => void

    Fired continuously as axis values change.

    onDeactivate?: (event: InputEvent) => void

    Fired when the control is released or deactivated.

    onPress?: (event: InputEvent) => void

    Fired on initial interaction start.

    onRelease?: (event: InputEvent) => void

    Fired when interaction ends.

    position?: [number, number, number]

    World position [x, y, z]. Default: [0, 0, 0].

    size?: number

    Overall scale multiplier. Default: 1.0.

    throwDistance?: number

    Distance the lever travels in each direction. Default: 0.5.

    Settings

    Member Visibility

    On This Page

    Properties