JoyButton

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

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

Overview

Identifies a standardized gamepad button.

Syntax

public enum Electron2D.JoyButton : 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: JoyButton

Standardized gamepad button values for button events, action bindings and Input.IsJoyButtonPressed().

Remarks

Button values are used by Electron2D.InputEventJoypadButton, Electron2D.InputMap bindings and Electron2D.Input.IsJoyButtonPressed(System.Int32,Electron2D.JoyButton). The first four face buttons use the common bottom, right, left and top physical layout order.

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.IsJoyButtonPressed(System.Int32,Electron2D.JoyButton)
• Electron2D.InputEventJoypadButton

Members

Member	Kind	Summary
A	Enum value	Represents the bottom face button.
B	Enum value	Represents the right face button.
Back	Enum value	Represents the back or select button.
DpadDown	Enum value	Represents the directional pad down button.
DpadLeft	Enum value	Represents the directional pad left button.
DpadRight	Enum value	Represents the directional pad right button.
DpadUp	Enum value	Represents the directional pad up button.
Guide	Enum value	Represents the guide, home or system button.
Invalid	Enum value	Represents an invalid or unmapped gamepad button.
LeftShoulder	Enum value	Represents the left shoulder button.
LeftStick	Enum value	Represents pressing the left stick.
Misc1	Enum value	Represents the first miscellaneous gamepad button.
Paddle1	Enum value	Represents the first paddle button.
Paddle2	Enum value	Represents the second paddle button.
Paddle3	Enum value	Represents the third paddle button.
Paddle4	Enum value	Represents the fourth paddle button.
RightShoulder	Enum value	Represents the right shoulder button.
RightStick	Enum value	Represents pressing the right stick.
Start	Enum value	Represents the start or menu button.
Touchpad	Enum value	Represents the touchpad click button.
X	Enum value	Represents the left face button.
Y	Enum value	Represents the top face button.

Member Details

A

Kind: Enum value

public const Electron2D.JoyButton A

Summary

Represents the bottom face button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

B

Kind: Enum value

public const Electron2D.JoyButton B

Summary

Represents the right face button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Back

Kind: Enum value

public const Electron2D.JoyButton Back

Summary

Represents the back or select button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

DpadDown

Kind: Enum value

public const Electron2D.JoyButton DpadDown

Summary

Represents the directional pad down button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

DpadLeft

Kind: Enum value

public const Electron2D.JoyButton DpadLeft

Summary

Represents the directional pad left button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

DpadRight

Kind: Enum value

public const Electron2D.JoyButton DpadRight

Summary

Represents the directional pad right button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

DpadUp

Kind: Enum value

public const Electron2D.JoyButton DpadUp

Summary

Represents the directional pad up button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Guide

Kind: Enum value

public const Electron2D.JoyButton Guide

Summary

Represents the guide, home or system button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Invalid

Kind: Enum value

public const Electron2D.JoyButton Invalid

Summary

Represents an invalid or unmapped gamepad button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

LeftShoulder

Kind: Enum value

public const Electron2D.JoyButton LeftShoulder

Summary

Represents the left shoulder button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

LeftStick

Kind: Enum value

public const Electron2D.JoyButton LeftStick

Summary

Represents pressing the left stick.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Misc1

Kind: Enum value

public const Electron2D.JoyButton Misc1

Summary

Represents the first miscellaneous gamepad button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Paddle1

Kind: Enum value

public const Electron2D.JoyButton Paddle1

Summary

Represents the first paddle button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Paddle2

Kind: Enum value

public const Electron2D.JoyButton Paddle2

Summary

Represents the second paddle button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Paddle3

Kind: Enum value

public const Electron2D.JoyButton Paddle3

Summary

Represents the third paddle button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Paddle4

Kind: Enum value

public const Electron2D.JoyButton Paddle4

Summary

Represents the fourth paddle button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

RightShoulder

Kind: Enum value

public const Electron2D.JoyButton RightShoulder

Summary

Represents the right shoulder button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

RightStick

Kind: Enum value

public const Electron2D.JoyButton RightStick

Summary

Represents pressing the right stick.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Start

Kind: Enum value

public const Electron2D.JoyButton Start

Summary

Represents the start or menu button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Touchpad

Kind: Enum value

public const Electron2D.JoyButton Touchpad

Summary

Represents the touchpad click button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

X

Kind: Enum value

public const Electron2D.JoyButton X

Summary

Represents the left face button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton

Y

Kind: Enum value

public const Electron2D.JoyButton Y

Summary

Represents the top face button.

Remarks

Use this value with APIs that accept JoyButton.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.JoyButton