Inheritance diagram for VRage.Input.MyControl:

Public Member Functions
	MyControl (MyStringId controlId, MyStringId name, MyGuiControlTypeEnum controlType, MyMouseButtonsEnum?defaultControlMouse, MyKeys?defaultControlKey, MyStringId?helpText=null, MyKeys?defaultControlKey2=null, MyStringId?description=null)

	MyControl (MyControl other)

void	SetControl (MyGuiInputDeviceEnum device, MyKeys key)

void	SetControl (MyMouseButtonsEnum mouseButton)

void	SetNoControl ()

MyKeys	GetKeyboardControl ()

MyKeys	GetSecondKeyboardControl ()

MyMouseButtonsEnum	GetMouseControl ()

bool	IsPressed ()

bool	IsNewPressed ()

bool	IsNewReleased ()

bool	IsJoystickPressed ()

bool	IsNewJoystickPressed ()

bool	IsNewJoystickReleased ()

float	GetAnalogState ()
	Return the analog state between 0 (not pressed at all) and 1 (fully pressed). If a digital button is mapped to an analog control, it can return only 0 or 1. More...

MyStringId	GetControlName ()

MyStringId	GetControlDescription ()

MyGuiControlTypeEnum	GetControlTypeEnum ()

MyStringId	GetGameControlEnum ()

bool	IsControlAssigned ()

bool	IsControlAssigned (MyGuiInputDeviceEnum deviceType)

void	CopyFrom (MyControl other)

override string	ToString ()
	Causes allocation. Creates single string with list of assigned controls. More...

StringBuilder	ToStringBuilder (string unassignedText)
	Causes allocation. Creates single StringBuilder with list of assigned controls. Caller takes ownership of returned StringBuilder (it is not stored internally). More...

string	GetControlButtonName (MyGuiInputDeviceEnum deviceType)

void	AppendBoundKeyJustOne (ref StringBuilder output)

void	AppendBoundButtonNames (ref StringBuilder output, MyGuiInputDeviceEnum device, string separator=null)

void	AppendBoundButtonNames (ref StringBuilder output, string separator=", ", string unassignedText=null, bool includeSecondary=true)

Static Public Member Functions
static void	AppendName (ref StringBuilder output, MyKeys key)

static void	AppendName (ref StringBuilder output, MyKeys key1, MyKeys key2, string separator)

static void	AppendName (ref StringBuilder output, MyMouseButtonsEnum mouseButton)

static void	AppendName (ref StringBuilder output, MyJoystickButtonsEnum joystickButton)

static void	AppendName (ref StringBuilder output, MyJoystickAxesEnum joystickAxis)

static void	AppendUnknownTextIfNeeded (ref StringBuilder output, string unassignedText)

Properties
string	ButtonNames `[get]`

string	ButtonNamesIgnoreSecondary `[get]`

Detailed Description

Definition at line 9 of file MyControl.cs.

Constructor & Destructor Documentation

VRage.Input.MyControl.MyControl	(	MyStringId	controlId,
		MyStringId	name,
		MyGuiControlTypeEnum	controlType,
		MyMouseButtonsEnum?	defaultControlMouse,
		MyKeys?	defaultControlKey,
		MyStringId?	helpText = `null`,
		MyKeys?	defaultControlKey2 = `null`,
		MyStringId?	description = `null`
	)

inline

Definition at line 58 of file MyControl.cs.

VRage.Input.MyControl.MyControl ( MyControl other )

inline

Definition at line 76 of file MyControl.cs.

Member Function Documentation

void VRage.Input.MyControl.AppendBoundButtonNames	(	ref StringBuilder	output,
		MyGuiInputDeviceEnum	device,
		string	separator = `null`
	)

inline

Definition at line 400 of file MyControl.cs.

void VRage.Input.MyControl.AppendBoundButtonNames	(	ref StringBuilder	output,
		string	separator = `", "`,
		string	unassignedText = `null`,
		bool	includeSecondary = `true`
	)

inline

Definition at line 426 of file MyControl.cs.

void VRage.Input.MyControl.AppendBoundKeyJustOne ( ref StringBuilder output )

inline

Definition at line 391 of file MyControl.cs.

static void VRage.Input.MyControl.AppendName	(	ref StringBuilder	output,
		MyKeys	key
	)

inlinestatic

Definition at line 450 of file MyControl.cs.

static void VRage.Input.MyControl.AppendName	(	ref StringBuilder	output,
		MyKeys	key1,
		MyKeys	key2,
		string	separator
	)

inlinestatic

Definition at line 457 of file MyControl.cs.

static void VRage.Input.MyControl.AppendName	(	ref StringBuilder	output,
		MyMouseButtonsEnum	mouseButton
	)

inlinestatic

Definition at line 477 of file MyControl.cs.

static void VRage.Input.MyControl.AppendName	(	ref StringBuilder	output,
		MyJoystickButtonsEnum	joystickButton
	)

inlinestatic

Definition at line 483 of file MyControl.cs.

static void VRage.Input.MyControl.AppendName	(	ref StringBuilder	output,
		MyJoystickAxesEnum	joystickAxis
	)

inlinestatic

Definition at line 489 of file MyControl.cs.

static void VRage.Input.MyControl.AppendUnknownTextIfNeeded	(	ref StringBuilder	output,
		string	unassignedText
	)

inlinestatic

Definition at line 495 of file MyControl.cs.

void VRage.Input.MyControl.CopyFrom ( MyControl other )

inline

Definition at line 339 of file MyControl.cs.

float VRage.Input.MyControl.GetAnalogState ( )

inline

Return the analog state between 0 (not pressed at all) and 1 (fully pressed). If a digital button is mapped to an analog control, it can return only 0 or 1.

Implements VRage.ModAPI.IMyControl.

Definition at line 248 of file MyControl.cs.

string VRage.Input.MyControl.GetControlButtonName ( MyGuiInputDeviceEnum deviceType )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 384 of file MyControl.cs.

MyStringId VRage.Input.MyControl.GetControlDescription ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 303 of file MyControl.cs.

MyStringId VRage.Input.MyControl.GetControlName ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 298 of file MyControl.cs.

MyGuiControlTypeEnum VRage.Input.MyControl.GetControlTypeEnum ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 308 of file MyControl.cs.

MyStringId VRage.Input.MyControl.GetGameControlEnum ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 313 of file MyControl.cs.

MyKeys VRage.Input.MyControl.GetKeyboardControl ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 106 of file MyControl.cs.

MyMouseButtonsEnum VRage.Input.MyControl.GetMouseControl ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 116 of file MyControl.cs.

MyKeys VRage.Input.MyControl.GetSecondKeyboardControl ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 111 of file MyControl.cs.

bool VRage.Input.MyControl.IsControlAssigned ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 318 of file MyControl.cs.

bool VRage.Input.MyControl.IsControlAssigned ( MyGuiInputDeviceEnum deviceType )

inline

Definition at line 324 of file MyControl.cs.

bool VRage.Input.MyControl.IsJoystickPressed ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 204 of file MyControl.cs.

bool VRage.Input.MyControl.IsNewJoystickPressed ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 211 of file MyControl.cs.

bool VRage.Input.MyControl.IsNewJoystickReleased ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 228 of file MyControl.cs.

bool VRage.Input.MyControl.IsNewPressed ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 143 of file MyControl.cs.

bool VRage.Input.MyControl.IsNewReleased ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 165 of file MyControl.cs.

bool VRage.Input.MyControl.IsPressed ( )

inline

Implements VRage.ModAPI.IMyControl.

Definition at line 121 of file MyControl.cs.

void VRage.Input.MyControl.SetControl	(	MyGuiInputDeviceEnum	device,
		MyKeys	key
	)

inline

Definition at line 81 of file MyControl.cs.

void VRage.Input.MyControl.SetControl ( MyMouseButtonsEnum mouseButton )

inline

Definition at line 94 of file MyControl.cs.

void VRage.Input.MyControl.SetNoControl ( )

inline

Definition at line 99 of file MyControl.cs.

override string VRage.Input.MyControl.ToString ( )

inline

Causes allocation. Creates single string with list of assigned controls.

Definition at line 348 of file MyControl.cs.

StringBuilder VRage.Input.MyControl.ToStringBuilder ( string unassignedText )

inline

Causes allocation. Creates single StringBuilder with list of assigned controls. Caller takes ownership of returned StringBuilder (it is not stored internally).

Definition at line 377 of file MyControl.cs.

Property Documentation

string VRage.Input.MyControl.ButtonNames

get

Definition at line 354 of file MyControl.cs.

string VRage.Input.MyControl.ButtonNamesIgnoreSecondary

get

Definition at line 364 of file MyControl.cs.

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

Sources/VRage.Input/Input/MyControl.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation