Godot Nature of Code  1.2.0
Nature of Code implemented in Godot Engine
Public Types | Public Attributes | List of all members
VirtualControls Class Reference

Embedded virtual controls. Adapted from https://github.com/MarcoFazioRandom/Virtual-Joystick-Godot More...

Inherits Control.

Public Types

enum class  JoystickModeEnum { Fixed , Dynamic , Following }
 Joystick mode. More...
 
enum class  VectorModeEnum { Real , Normalized }
 Vector normalization mode. More...
 
enum class  VisibilityModeEnum { Always , TouchscreenOnly }
 Visibility mode. More...
 

Public Attributes

float MarginAmount = 8
 External margin amount More...
 
bool DebugDraw
 Debug draw information More...
 
JoystickModeEnum JoystickMode
 Joystick mode More...
 
VectorModeEnum VectorMode
 Vector mode More...
 
VisibilityModeEnum VisibilityMode = VisibilityModeEnum.TouchscreenOnly
 Visibility mode More...
 
Color JoystickPressedColor = Colors.Gray
 Joystick pressed color More...
 
float JoystickAnchorTop = 0.55f
 Joystick anchor top More...
 
float JoystickAnchorRight = 0.25f
 Joystick anchor right More...
 
int JoystickDirections
 Joystick fixed directions (between 0 (free) and 12) More...
 
float JoystickSymmetryAngle = 90.0f
 Joystick symmetry angle More...
 
float JoystickDeadZone = 0.2f
 Joystick dead zone More...
 
float JoystickClampZone = 1
 Joystick clamp zone More...
 
Vector2 JoystickOutput = Vector2.Zero
 Joystick output More...
 
bool ButtonAPressed
 Button A is currently pressed More...
 
bool ButtonBPressed
 Button B is currently pressed More...
 
bool JoystickReceivingInputs
 Joystick is receiving inputs More...
 

Detailed Description

Embedded virtual controls. Adapted from https://github.com/MarcoFazioRandom/Virtual-Joystick-Godot

Definition at line 8 of file VirtualControls.cs.

Member Enumeration Documentation

◆ JoystickModeEnum

enum VirtualControls.JoystickModeEnum
strong

Joystick mode.

Enumerator
Fixed 

Fixed joystick

Dynamic 

Dynamic joystick

Following 

Following joystick (follow drag movement)

Definition at line 13 of file VirtualControls.cs.

14  {
16  Fixed,
17 
19  Dynamic,
20 
22  Following
23  }

◆ VectorModeEnum

enum VirtualControls.VectorModeEnum
strong

Vector normalization mode.

Enumerator
Real 

Real vector value

Normalized 

Normalized vector value

Definition at line 28 of file VirtualControls.cs.

29  {
31  Real,
32 
34  Normalized
35  }

◆ VisibilityModeEnum

enum VirtualControls.VisibilityModeEnum
strong

Visibility mode.

Enumerator
Always 

Always show joystick

TouchscreenOnly 

Only show on touchscreen devices

Definition at line 40 of file VirtualControls.cs.

41  {
43  Always,
44 
46  TouchscreenOnly
47  }

Member Data Documentation

◆ ButtonAPressed

bool VirtualControls.ButtonAPressed

Button A is currently pressed

Definition at line 89 of file VirtualControls.cs.

◆ ButtonBPressed

bool VirtualControls.ButtonBPressed

Button B is currently pressed

Definition at line 92 of file VirtualControls.cs.

◆ DebugDraw

bool VirtualControls.DebugDraw

Debug draw information

Definition at line 53 of file VirtualControls.cs.

◆ JoystickAnchorRight

float VirtualControls.JoystickAnchorRight = 0.25f

Joystick anchor right

Definition at line 71 of file VirtualControls.cs.

◆ JoystickAnchorTop

float VirtualControls.JoystickAnchorTop = 0.55f

Joystick anchor top

Definition at line 68 of file VirtualControls.cs.

◆ JoystickClampZone

float VirtualControls.JoystickClampZone = 1

Joystick clamp zone

Definition at line 83 of file VirtualControls.cs.

◆ JoystickDeadZone

float VirtualControls.JoystickDeadZone = 0.2f

Joystick dead zone

Definition at line 80 of file VirtualControls.cs.

◆ JoystickDirections

int VirtualControls.JoystickDirections

Joystick fixed directions (between 0 (free) and 12)

Definition at line 74 of file VirtualControls.cs.

◆ JoystickMode

JoystickModeEnum VirtualControls.JoystickMode

Joystick mode

Definition at line 56 of file VirtualControls.cs.

◆ JoystickOutput

Vector2 VirtualControls.JoystickOutput = Vector2.Zero

Joystick output

Definition at line 86 of file VirtualControls.cs.

◆ JoystickPressedColor

Color VirtualControls.JoystickPressedColor = Colors.Gray

Joystick pressed color

Definition at line 65 of file VirtualControls.cs.

◆ JoystickReceivingInputs

bool VirtualControls.JoystickReceivingInputs

Joystick is receiving inputs

Definition at line 95 of file VirtualControls.cs.

◆ JoystickSymmetryAngle

float VirtualControls.JoystickSymmetryAngle = 90.0f

Joystick symmetry angle

Definition at line 77 of file VirtualControls.cs.

◆ MarginAmount

float VirtualControls.MarginAmount = 8

External margin amount

Definition at line 50 of file VirtualControls.cs.

◆ VectorMode

VectorModeEnum VirtualControls.VectorMode

Vector mode

Definition at line 59 of file VirtualControls.cs.

◆ VisibilityMode

VisibilityModeEnum VirtualControls.VisibilityMode = VisibilityModeEnum.TouchscreenOnly

Visibility mode

Definition at line 62 of file VirtualControls.cs.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1