CryEngine.Input

Classes | Static Public Member Functions | Properties | Events | List of all members

CryEngine.Input

Pre-Processes CryEngine's Input callback and generates Input events. Classes may be registered here, in order to receive global Input events. More...

Classes
class	InputListener

struct	KeyState

Static Public Member Functions
static Vector2	GetAxis (string name)
	Returns the value of and axis by name. Can be used to retrieve EyeTracker values. More...

static bool	KeyUp (KeyId key)
	Used to detect if a key is not being pressed in the current frame. More...

static bool	KeyDown (KeyId key)
	Used to detect if a key is being hold down in the current frame. More...

static float	GetInputValue (KeyId key)
	Get the current input value for the specified key. More...

Properties
static bool	ShiftDown `[get]`
	Set if Shift key is held Down More...

Events
static Action< InputEvent >	OnKey
	Fired when a key-state was modified More...

Detailed Description

Pre-Processes CryEngine's Input callback and generates Input events. Classes may be registered here, in order to receive global Input events.

Member Function Documentation

◆ GetAxis()

static Vector2 CryEngine.Input.GetAxis

(

string

name

)

inline

static

Returns the value of and axis by name. Can be used to retrieve EyeTracker values.

Returns: The axis.

Parameters

name

Name.

◆ GetInputValue()

static float CryEngine.Input.GetInputValue

(

KeyId

key

)

inline

static

Get the current input value for the specified key.

Returns: The input value.

Parameters

key

Key.

◆ KeyDown()

static bool CryEngine.Input.KeyDown

(

KeyId

key

)

inline

static

Used to detect if a key is being hold down in the current frame.

Returns: true if the key is down, false otherwise.

Parameters

key

Key.

◆ KeyUp()

static bool CryEngine.Input.KeyUp

(

KeyId

key

)

inline

static

Used to detect if a key is not being pressed in the current frame.

Returns: true if the key is up, false otherwise.

Parameters

key

Key.

Property Documentation

◆ ShiftDown

bool CryEngine.Input.ShiftDown

static

get

Set if Shift key is held Down

true if shift down; otherwise, false.

Event Documentation

◆ OnKey

Action<InputEvent> CryEngine.Input.OnKey

static

Fired when a key-state was modified