HPL3/SOMA/Scripting/Scripting Api/cInput

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type	Function and Description
bool	cInput_BecameTriggered(const tString &in asName)
bool	cInput_BecameTriggered(int alId)
bool	cInput_CheckForInput()
cAction	cInput_CreateAction(const tString &in asName, int alId)
void	cInput_DestroyAction(cAction @apAction)
bool	cInput_DoubleTriggered(const tString &in asName, float afLimit)
bool	cInput_DoubleTriggered(int alId, float afLimit)
cAction	cInput_GetAction(const tString &in asName)
cAction	cInput_GetAction(int alId)
iEyeTracker	cInput_GetEyeTracker()
iKeyboard	cInput_GetKeyboard()
iMouse	cInput_GetMouse()
iSubAction	cInput_InputToSubAction()
bool	cInput_IsTriggered(const tString &in asName)
bool	cInput_IsTriggered(int alId)
void	cInput_ResetActionsToCurrentState()
void	cInput_Update(float afX)
bool	cInput_WasTriggered(const tString &in asName)
bool	cInput_WasTriggered(int alId)

Function Detail

cInput_BecameTriggered

bool cInput_BecameTriggered(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• bool—

cInput_BecameTriggered

bool cInput_BecameTriggered(int alId)

Parameters

• alId (int) —

Returns:

• bool—

cInput_CheckForInput

bool cInput_CheckForInput()

Returns:

• bool—

cInput_CreateAction

cAction@ cInput_CreateAction(const tString &in asName,
                             int alId)

Parameters

• asName (tString) —
• alId (int) —

Returns:

• cAction@—

cInput_DestroyAction

void cInput_DestroyAction(cAction @apAction)

Parameters

• @apAction (cAction) —

Returns:

• void

cInput_DoubleTriggered

bool cInput_DoubleTriggered(const tString &in asName,
                            float afLimit)

Parameters

• asName (tString) —
• afLimit (float) —

Returns:

• bool—

cInput_DoubleTriggered

bool cInput_DoubleTriggered(int alId,
                            float afLimit)

Parameters

• alId (int) —
• afLimit (float) —

Returns:

• bool—

cInput_GetAction

cAction@ cInput_GetAction(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• cAction@—

cInput_GetAction

cAction@ cInput_GetAction(int alId)

Parameters

• alId (int) —

Returns:

• cAction@—

cInput_GetEyeTracker

iEyeTracker@ cInput_GetEyeTracker()

Returns:

• iEyeTracker@—

cInput_GetKeyboard

iKeyboard@ cInput_GetKeyboard()

Returns:

• iKeyboard@—

cInput_GetMouse

iMouse@ cInput_GetMouse()

Returns:

• iMouse@—

cInput_InputToSubAction

iSubAction@ cInput_InputToSubAction()

Returns:

• iSubAction@—

cInput_IsTriggered

bool cInput_IsTriggered(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• bool—

cInput_IsTriggered

bool cInput_IsTriggered(int alId)

Parameters

• alId (int) —

Returns:

• bool—

cInput_ResetActionsToCurrentState

void cInput_ResetActionsToCurrentState()

Returns:

• void

cInput_Update

void cInput_Update(float afX)

Parameters

• afX (float) —

Returns:

• void

cInput_WasTriggered

bool cInput_WasTriggered(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• bool—

cInput_WasTriggered

bool cInput_WasTriggered(int alId)

Parameters

• alId (int) —

Returns:

• bool—