KeyboardInputCollector Class Reference

More...

Inheritance diagram for KeyboardInputCollector:

Public Member Functions
void	Enable ()
	Enable the input collector, prompting it to set up and enable appropriate input actions.
float2	GetMovement ()
	Gets the player movement vector.
float2	GetPanning ()
	Gets the player panning vector.
float	GetSprint ()
	Gets the player sprint multiplier.
bool	GetTeleportButtonPress ()
	Gets the teleport button press. Returns
bool	GetMenuButtonWasPressed ()
	Gets the menu button was pressed state in one frame. Returns
bool	GetGrabButtonWasPressed ()
	Gets the Q button pressed. Returns
bool	GetActivateButtonPress ()
	Gets the activate button pressed state. Returns
void	Dispose ()

Properties
bool	IsEnabled [get]
	True if the input collector has been enabled.
Properties inherited from IInputCollector

Detailed Description

Member Function Documentation

Enable()

void Enable ( )

inline

Enable the input collector, prompting it to set up and enable appropriate input actions.

Implements IInputCollector.

GetActivateButtonPress()

bool GetActivateButtonPress ( )

inline

Gets the activate button pressed state.

Returns

Implements IKeyboardInputCollector.

GetGrabButtonWasPressed()

bool GetGrabButtonWasPressed ( )

inline

Gets the Q button pressed.

Returns

Implements IKeyboardInputCollector.

GetMenuButtonWasPressed()

bool GetMenuButtonWasPressed ( )

inline

Gets the menu button was pressed state in one frame.

Returns

Implements IKeyboardInputCollector.

GetMovement()

float2 GetMovement ( )

inline

Gets the player movement vector.

Implements IKeyboardInputCollector.

GetPanning()

float2 GetPanning ( )

inline

Gets the player panning vector.

Implements IKeyboardInputCollector.

GetSprint()

float GetSprint ( )

inline

Gets the player sprint multiplier.

Implements IKeyboardInputCollector.

GetTeleportButtonPress()

bool GetTeleportButtonPress ( )

inline

Gets the teleport button press.

Returns

Implements IKeyboardInputCollector.

Property Documentation

IsEnabled

bool IsEnabled

get

True if the input collector has been enabled.

Implements IInputCollector.

---

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

• Runtime/Input/Collectors/KeyboardInputCollector.cs