Controls class. Allows for controls queries and controls injection from devices. More...

Inherits MonoBehaviour.

Static Public Member Functions
static void	RegisterActionInfoProvider (ControlsAction action, IActionInfoProvider actionInfoProvider)
	Register an action info provider. More...

static void	UnregisterActionInfoProvider (ControlsAction action, IActionInfoProvider actionInfoProvider)
	Unregister an action info provider. More...

static void	InjectSmoothCadence (float cadence)
	Injects a power value. More...

static void	InjectDirection (Vector3 direction)
	Injects a direction. Call this from a device script. More...

static void	InjectActionState (ControlsAction action, bool state)
	Injections an action state. More...

static string	GetActionCaption (ControlsAction action)
	Returns the current caption for a given action. More...

static bool	IsActionEnabled (ControlsAction action)
	Checks if a given action is enabled. More...

static bool	GetAction (ControlsAction action)
	Returns the current state of an action. More...

static bool	GetActionDown (ControlsAction action)
	Checks if the given action has just been pressed down. More...

static bool	GetActionUp (ControlsAction action)
	Checks if the given action has just been released. More...

static float	GetActionHoldTime (ControlsAction action)
	Returns the amount of time the given action has been held down. More...

static void	ResetHoldTime (ControlsAction action)
	Resets the Hold Time of an action. Used to "consume" a held input, such as the 3 second hold for quitting. More...

Public Attributes
AnimationCurve	PowerCurve

float	MinPower = .05f
	The value below which power is simply considered zero. More...

Properties
static float	Power `[get]`
	Returns an abstract power value in the range [0 ... 1]. More...

static Vector3	Direction `[get]`
	Returns a normalized, abstract direction. Could also be zero. More...

static float	RawCadence `[get]`
	Returns the raw pedaling cadence for logging use or other study reasons. More...

Detailed Description

Controls class. Allows for controls queries and controls injection from devices.

Definition at line 41 of file Controls.cs.

Member Function Documentation

static bool Controls.GetAction ( ControlsAction action )

inlinestatic

Returns the current state of an action.

Definition at line 186 of file Controls.cs.

static string Controls.GetActionCaption ( ControlsAction action )

inlinestatic

Returns the current caption for a given action.

Definition at line 160 of file Controls.cs.

static bool Controls.GetActionDown ( ControlsAction action )

inlinestatic

Checks if the given action has just been pressed down.

Definition at line 194 of file Controls.cs.

static float Controls.GetActionHoldTime ( ControlsAction action )

inlinestatic

Returns the amount of time the given action has been held down.

Definition at line 210 of file Controls.cs.

static bool Controls.GetActionUp ( ControlsAction action )

inlinestatic

Checks if the given action has just been released.

Definition at line 202 of file Controls.cs.

static void Controls.InjectActionState	(	ControlsAction	action,
		bool	state
	)

inlinestatic

Injections an action state.

Parameters

action	The action for which to inject a state.
state	The state to inject.

Call this from a device script.

Definition at line 147 of file Controls.cs.

static void Controls.InjectDirection ( Vector3 direction )

inlinestatic

Injects a direction. Call this from a device script.

Call this from a device script.

Definition at line 136 of file Controls.cs.

static void Controls.InjectSmoothCadence ( float cadence )

inlinestatic

Injects a power value.

Call this from a device script.

Definition at line 109 of file Controls.cs.

static bool Controls.IsActionEnabled ( ControlsAction action )

inlinestatic

Checks if a given action is enabled.

Definition at line 173 of file Controls.cs.

static void Controls.RegisterActionInfoProvider	(	ControlsAction	action,
		IActionInfoProvider	actionInfoProvider
	)

inlinestatic

Register an action info provider.

Parameters

action	The action for which the given provider will provide info.
actionInfoProvider	The action provider to register.

Definition at line 90 of file Controls.cs.

static void Controls.ResetHoldTime ( ControlsAction action )

inlinestatic

Resets the Hold Time of an action. Used to "consume" a held input, such as the 3 second hold for quitting.

Definition at line 219 of file Controls.cs.

static void Controls.UnregisterActionInfoProvider	(	ControlsAction	action,
		IActionInfoProvider	actionInfoProvider
	)

inlinestatic

Unregister an action info provider.

Parameters

action	The action for which the given provider provides info.
actionInfoProvider	The action provider to unregister.

Definition at line 100 of file Controls.cs.

Member Data Documentation

float Controls.MinPower = .05f

The value below which power is simply considered zero.

Definition at line 74 of file Controls.cs.

Property Documentation

Vector3 Controls.Direction

staticget

Returns a normalized, abstract direction. Could also be zero.

Definition at line 55 of file Controls.cs.

float Controls.Power

staticget

Returns an abstract power value in the range [0 ... 1].

Definition at line 47 of file Controls.cs.

float Controls.RawCadence

staticget

Returns the raw pedaling cadence for logging use or other study reasons.

Definition at line 63 of file Controls.cs.

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

C:/Users/Dan/Documents/Doomsday/Liberi/Assets/Scripts/Core/Controls.cs

Static Public Member Functions

Public Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation