MuGameFramework  1.0
MuGameFramework is a 2D game framework built upon C# and SFML
 All Classes Namespaces Files Functions Variables Enumerations Properties
MuGameFramework.InputDevice.JoystickState Struct Reference

Object holding a certain state of the Joystick More...

Public Member Functions

float GetAxisPosition (JoystickAxis axis)
 Get the current position of a joystick axis for this Joystick
bool IsButtonDown (int button)
 Check if a button on the joystick is pressed
bool IsButtonUp (int button)
 Check if a button on the joystick is unpressed
override bool Equals (object obj)
 Compare a JoystickState with this for equality
override int GetHashCode ()
 Get the hash code for this object

Static Public Member Functions

static bool operator== (JoystickState a, JoystickState b)
 Compare two JoystickStates for equality
static bool operator!= (JoystickState a, JoystickState b)
 Compare two JoystickState for inequality

Properties

bool IsConnected [get, set]
 Is the Joystick connected
float DeadZone [get, set]
 Value limit that - if below - movement will not be recognised by the JoystickState

Detailed Description

Object holding a certain state of the Joystick

Member Function Documentation

override bool MuGameFramework.InputDevice.JoystickState.Equals ( object  obj)

Compare a JoystickState with this for equality

Parameters
objJoystickState to compare
Returns
Result of comparison
float MuGameFramework.InputDevice.JoystickState.GetAxisPosition ( JoystickAxis  axis)

Get the current position of a joystick axis for this Joystick

Parameters
axisAxis to check
Returns
Position of the Axis
override int MuGameFramework.InputDevice.JoystickState.GetHashCode ( )

Get the hash code for this object

Returns
The hash code for this object
bool MuGameFramework.InputDevice.JoystickState.IsButtonDown ( int  button)

Check if a button on the joystick is pressed

Parameters
buttonButton to check
Returns
Result of check
bool MuGameFramework.InputDevice.JoystickState.IsButtonUp ( int  button)

Check if a button on the joystick is unpressed

Parameters
buttonButton to check
Returns
Result of check
static bool MuGameFramework.InputDevice.JoystickState.operator!= ( JoystickState  a,
JoystickState  b 
)
static

Compare two JoystickState for inequality

Parameters
aJoystickState A to check
bJoystickState B to check
Returns
Result of comparison
static bool MuGameFramework.InputDevice.JoystickState.operator== ( JoystickState  a,
JoystickState  b 
)
static

Compare two JoystickStates for equality

Parameters
aJoystickStates A to check
bJoystickStates B to check
Returns
Result of comparison

Property Documentation

float MuGameFramework.InputDevice.JoystickState.DeadZone
getset

Value limit that - if below - movement will not be recognised by the JoystickState

bool MuGameFramework.InputDevice.JoystickState.IsConnected
getset

Is the Joystick connected


The documentation for this struct was generated from the following file: