VirtualJoystick

public VirtualJoystick();

Creates a touch joystick. Add to UI and configure its Control area/actions before touches. Construction does not create Input Map actions.

public StringName ActionDown { get; set; }

Input Map action for the positive Y component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public StringName ActionLeft { get; set; }

Input Map action for the negative X component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public StringName ActionRight { get; set; }

Input Map action for the positive X component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public StringName ActionUp { get; set; }

Input Map action for the negative Y component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public float ClampzoneRatio { get; set; }

Multiplier of the JoystickSize / 2 radius where output reaches full amplitude. Must be > zero: zero causes division by zero during input processing. The setter does not clamp programmatic values; configure before holding.

public float DeadzoneRatio { get; set; }

Fraction of clamp radius producing no movement. Use zero <= ratio < one. Beyond it, amplitude is remapped from zero to one; not a screen-width fraction. The setter does not clamp programmatic values.

public Vector2 InitialOffsetRatio { get; set; }

Initial center as Control Size × ratio on each axis; (0.5, 0.5) is the center. Not a pixel offset. Changing it resets touch/actions; resizing the Control also resets the joystick.

public VirtualJoystick.JoystickModeEnum JoystickMode { get; set; }

Fixed uses the original center and accepts touch starts within the base rectangle. Dynamic centers at touch start inside the Control. Following also moves the center when the finger exceeds the clamp radius while inside the Control. Does not set visibility.

public float JoystickSize { get; set; }

Base size in pixels, with control radius based on Size / 2. Use a positive value. Changing it resets the current touch/actions; not the full Control activation area.

public float TipSize { get; set; }

Knob size in pixels rather than output amplitude. Changing it resets the current touch/actions. Use a positive value.

public VirtualJoystick.VisibilityModeEnum VisibilityMode { get; set; }

Always draws the joystick continuously; WhenTouched skips drawing without an active touch during play. A drawing mode rather than Visible false: the input area remains. It stays visible in the editor for configuration.

public StringName GetActionDown();

Input Map action for the positive Y component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public StringName GetActionLeft();

Input Map action for the negative X component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public StringName GetActionRight();

Input Map action for the positive X component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public StringName GetActionUp();

Input Map action for the negative Y component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public float GetClampzoneRatio();

Multiplier of the JoystickSize / 2 radius where output reaches full amplitude. Must be > zero: zero causes division by zero during input processing. The setter does not clamp programmatic values; configure before holding.

public float GetDeadzoneRatio();

Fraction of clamp radius producing no movement. Use zero <= ratio < one. Beyond it, amplitude is remapped from zero to one; not a screen-width fraction. The setter does not clamp programmatic values.

public Vector2 GetInitialOffsetRatio();

Initial center as Control Size × ratio on each axis; (0.5, 0.5) is the center. Not a pixel offset. Changing it resets touch/actions; resizing the Control also resets the joystick.

public VirtualJoystick.JoystickModeEnum GetJoystickMode();

Fixed uses the original center and accepts touch starts within the base rectangle. Dynamic centers at touch start inside the Control. Following also moves the center when the finger exceeds the clamp radius while inside the Control. Does not set visibility.

public float GetJoystickSize();

Base size in pixels, with control radius based on Size / 2. Use a positive value. Changing it resets the current touch/actions; not the full Control activation area.

public float GetTipSize();

Knob size in pixels rather than output amplitude. Changing it resets the current touch/actions. Use a positive value.

public VirtualJoystick.VisibilityModeEnum GetVisibilityMode();

Always draws the joystick continuously; WhenTouched skips drawing without an active touch during play. A drawing mode rather than Visible false: the input area remains. It stays visible in the editor for configuration.

public void SetActionDown(StringName action);

Input Map action for the positive Y component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public void SetActionLeft(StringName action);

Input Map action for the negative X component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public void SetActionRight(StringName action);

Input Map action for the positive X component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public void SetActionUp(StringName action);

Input Map action for the negative Y component, with strength from processed output. Define it before input. Configure before holding: changing the name does not automatically release the old action. Coordinate virtual sources sharing actions because the joystick calls action_press/action_release.

public void SetClampzoneRatio(float ratio);

Multiplier of the JoystickSize / 2 radius where output reaches full amplitude. Must be > zero: zero causes division by zero during input processing. The setter does not clamp programmatic values; configure before holding.

public void SetDeadzoneRatio(float ratio);

Fraction of clamp radius producing no movement. Use zero <= ratio < one. Beyond it, amplitude is remapped from zero to one; not a screen-width fraction. The setter does not clamp programmatic values.

public void SetInitialOffsetRatio(Vector2 ratio);

Initial center as Control Size × ratio on each axis; (0.5, 0.5) is the center. Not a pixel offset. Changing it resets touch/actions; resizing the Control also resets the joystick.

public void SetJoystickMode(VirtualJoystick.JoystickModeEnum mode);

Fixed uses the original center and accepts touch starts within the base rectangle. Dynamic centers at touch start inside the Control. Following also moves the center when the finger exceeds the clamp radius while inside the Control. Does not set visibility.

public void SetJoystickSize(float size);

Base size in pixels, with control radius based on Size / 2. Use a positive value. Changing it resets the current touch/actions; not the full Control activation area.

public void SetTipSize(float size);

Knob size in pixels rather than output amplitude. Changing it resets the current touch/actions. Use a positive value.

public void SetVisibilityMode(VirtualJoystick.VisibilityModeEnum mode);

Always draws the joystick continuously; WhenTouched skips drawing without an active touch during play. A drawing mode rather than Visible false: the input area remains. It stays visible in the editor for configuration.

public event Action FlickCanceled;

Moving from nonzero input back into the deadzone marks the flick canceled. Not an OS touch-cancellation event. Leaving the deadzone again can re-enable a flick.

public event VirtualJoystick.FlickedEventHandler Flicked;

On release after dragging with nonzero output, emits the last processed vector. Does not calculate gesture velocity or throw impulse; calculate those separately if needed.

public event Action Pressed;

An accepted touch starts. The control handles one touch index; extra touches do not become another independent stick in the same control.

public event VirtualJoystick.ReleasedEventHandler Released;

Emits the last deadzone-processed vector on release, before resetting to zero. Final touch output rather than a continuous movement event. Tapped or Flicked may follow immediately.

public event Action Tapped;

Emitted on release without ScreenDrag and without a canceled flick state. Hold duration is not limited; not restricted to a short tap.