JoyAxis

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.JoyAxis
Namespace	Electron2D
Kind	enum
Category	Input

Overview

Identifies a normalized gamepad axis.

Syntax

public enum Electron2D.JoyAxis : System.IComparable, System.IConvertible, System.IFormattable, System.ISpanFormattable

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: JoyAxis

Standardized gamepad axis values for motion events, action bindings and Input.GetJoyAxis().

Remarks

Axis values are reported through Electron2D.InputEventJoypadMotion and queried through Electron2D.Input.GetJoyAxis(System.Int32,Electron2D.JoyAxis). Stick axes use a signed range from -1.0 to 1.0; trigger axes use the same storage range and are expected to report non-negative values on common gamepad mappings.

Thread Safety

Enumeration values are immutable and may be used from any thread.

Since

This enum is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Input.GetJoyAxis(System.Int32,Electron2D.JoyAxis)
• Electron2D.InputEventJoypadMotion

Members

Member	Kind	Summary
Invalid	Enum value	Represents an invalid or unmapped gamepad axis.
LeftX	Enum value	Represents the horizontal axis of the left stick.
LeftY	Enum value	Represents the vertical axis of the left stick.
RightX	Enum value	Represents the horizontal axis of the right stick.
RightY	Enum value	Represents the vertical axis of the right stick.
TriggerLeft	Enum value	Represents the left trigger axis.
TriggerRight	Enum value	Represents the right trigger axis.

Member Details

Invalid

Kind: Enum value

public const Electron2D.JoyAxis Invalid

Summary

Represents an invalid or unmapped gamepad axis.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis

LeftX

Kind: Enum value

public const Electron2D.JoyAxis LeftX

Summary

Represents the horizontal axis of the left stick.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis

LeftY

Kind: Enum value

public const Electron2D.JoyAxis LeftY

Summary

Represents the vertical axis of the left stick.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis

RightX

Kind: Enum value

public const Electron2D.JoyAxis RightX

Summary

Represents the horizontal axis of the right stick.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis

RightY

Kind: Enum value

public const Electron2D.JoyAxis RightY

Summary

Represents the vertical axis of the right stick.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis

TriggerLeft

Kind: Enum value

public const Electron2D.JoyAxis TriggerLeft

Summary

Represents the left trigger axis.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis

TriggerRight

Kind: Enum value

public const Electron2D.JoyAxis TriggerRight

Summary

Represents the right trigger axis.

Remarks

Use this value with APIs that accept JoyAxis.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyAxis