CryEngine.InputEvent

Public Member Functions | Properties | List of all members

Data container for input events. More...

Public Member Functions
bool	KeyPressed (KeyId keyId)
	Detect if this event is about the specified key being pressed. More...

bool	KeyUp (KeyId keyId)
	Detect if this event is about the specified key being released. More...

bool	KeyChanged (KeyId keyId)
	Detect if this event is about the specified key being changed. More...

bool	KeyDown (KeyId keyId)
	Detect if the specified key is currently pushed down during this frame. More...

Properties
int	DeviceIndex `[get, set]`
	Local index of this particular controller type. More...

InputDeviceType	DeviceType `[get, set]`
	Device type from which the event originated. More...

int	DeviceUniqueId `[get, set]`
	Process wide unique controller ID. More...

KeyId	KeyId `[get, set]`
	Device-specific id corresponding to the event. More...

string	KeyName `[get, set]`
	Human readable name of the event. More...

InputModifierFlags	InputModifiers `[get, set]`
	Key modifiers enabled at the time of this event. More...

InputState	State `[get, set]`
	Type of input event. More...

float	Value `[get, set]`
	Value associated with the event. More...

Detailed Description

Data container for input events.

Member Function Documentation

◆ KeyChanged()

bool CryEngine.InputEvent.KeyChanged

(

KeyId

keyId

)

inline

Detect if this event is about the specified key being changed.

Returns: true if the key has changed in this event, false otherwise.

Parameters

keyId

Key identifier.

◆ KeyDown()

bool CryEngine.InputEvent.KeyDown

(

KeyId

keyId

)

inline

Detect if the specified key is currently pushed down during this frame.

Returns: true if key is being pressed during this frame, false otherwise.

Parameters

keyId

Key identifier.

◆ KeyPressed()

bool CryEngine.InputEvent.KeyPressed

(

KeyId

keyId

)

inline

Detect if this event is about the specified key being pressed.

Returns: true if the key was pressed in this event, false otherwise.

Parameters

keyId

Key identifier.

◆ KeyUp()

bool CryEngine.InputEvent.KeyUp

(

KeyId

keyId

)

inline

Detect if this event is about the specified key being released.

Returns: true if the key was released in this event, false otherwise.

Parameters

keyId

Key identifier.

Property Documentation

◆ DeviceIndex

int CryEngine.InputEvent.DeviceIndex

get

set

Local index of this particular controller type.

The index of the device.

◆ DeviceType

InputDeviceType CryEngine.InputEvent.DeviceType

get

set

Device type from which the event originated.

The type of the device.

◆ DeviceUniqueId

int CryEngine.InputEvent.DeviceUniqueId

get

set

Process wide unique controller ID.

The device unique identifier.

◆ InputModifiers

InputModifierFlags CryEngine.InputEvent.InputModifiers

get

set

Key modifiers enabled at the time of this event.

The modifiers.

◆ KeyId

KeyId CryEngine.InputEvent.KeyId

get

set

Device-specific id corresponding to the event.

The key identifier.

◆ KeyName

string CryEngine.InputEvent.KeyName

get

set

Human readable name of the event.

The name of the key.

◆ State

InputState CryEngine.InputEvent.State

get

set

Type of input event.

The state.

◆ Value

float CryEngine.InputEvent.Value

get

set

Value associated with the event.

The value.