Strata - v1.4.10
    Preparing search index...

    Interface Joystick3DProps

    Props for the Joystick3D component.

    interface Joystick3DProps {
        baseColor?: ColorRepresentation;
        deadzone?: number;
        knobColor?: ColorRepresentation;
        maxTilt?: number;
        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];
        returnSpeed?: number;
        size?: number;
        stalkColor?: ColorRepresentation;
    }

    Hierarchy (View Summary)

    Index

    Properties

    baseColor? deadzone? knobColor? maxTilt? onActivate? onAxisChange? onDeactivate? onPress? onRelease? position? returnSpeed? size? stalkColor?

    Properties

    baseColor?: ColorRepresentation

    Color of the joystick base. Default: '#333333'.

    deadzone?: number

    Deadzone threshold (0-1). Movements below this are ignored. Default: 0.1.

    knobColor?: ColorRepresentation

    Color of the draggable knob. Default: '#ff6600'.

    maxTilt?: number

    Maximum tilt angle in radians. Default: PI / 6.

    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].

    returnSpeed?: number

    Speed at which the joystick returns to center. Default: 8.

    size?: number

    Overall scale multiplier. Default: 1.0.

    stalkColor?: ColorRepresentation

    Color of the joystick stalk. Default: '#555555'.

    Settings

    Member Visibility

    On This Page

    Properties