HPL3/Amnesia: Rebirth/Scripting/iGamepad

From Frictional Wiki
Jump to navigation Jump to search

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

Fields

iGamepad has no public fields.

Functions

Return Type Function And Description
bool AxesUpdated()
bool ButtonIsDown(eGamepadButton aButton)
bool ButtonIsPressed()
bool ButtonIsReleased()
float GetAxisDeadZoneRadiusValue()
float GetAxisValue(eGamepadAxis aAxis)
cVector2l GetBallAbsPos(eGamepadBall aBall)
cGamepadInputData GetButton()
cColor GetColorLED()
tString GetGamepadName()
eGamepadHatState GetHatCurrentState(eGamepadHat aHat)
cGamepadInputData GetHatState()
cGamepadInputData GetInputUpdate()
int GetNumAxes()
int GetNumBalls()
int GetNumButtons()
int GetNumHats()
cGamepadInputData GetReleasedButton()
cGamepadInputData GetUpdatedAxis()
bool HasInputUpdates()
bool HatIsInState(eGamepadHat aHat, eGamepadHatState aState)
bool HatsChanged()
void SetAxisDeadZoneRadiusValue(float afValue)
void SetColorLED(const cColor &in aColor)
void SetRumble(float afValue, int alMillisec)

Details

AxesUpdated

bool AxesUpdated()

Returns:

  • bool—

ButtonIsDown

bool ButtonIsDown(eGamepadButton aButton)


Parameters

Returns:

  • bool—

ButtonIsPressed

bool ButtonIsPressed()

Returns:

  • bool—

ButtonIsReleased

bool ButtonIsReleased()

Returns:

  • bool—

GetAxisDeadZoneRadiusValue

float GetAxisDeadZoneRadiusValue()

Returns:

  • float—

GetAxisValue

float GetAxisValue(eGamepadAxis aAxis)


Parameters

Returns:

  • float—

GetBallAbsPos

cVector2l GetBallAbsPos(eGamepadBall aBall)


Parameters

Returns:

  • cVector2l—

GetButton

cGamepadInputData GetButton()

Returns:

  • cGamepadInputData—

GetColorLED

cColor GetColorLED()

Returns:

  • cColor—

GetGamepadName

tString GetGamepadName()

Returns:

  • tString—

GetHatCurrentState

eGamepadHatState GetHatCurrentState(eGamepadHat aHat)


Parameters

Returns:

  • eGamepadHatState—

GetHatState

cGamepadInputData GetHatState()

Returns:

  • cGamepadInputData—

GetInputUpdate

cGamepadInputData GetInputUpdate()

Returns:

  • cGamepadInputData—

GetNumAxes

int GetNumAxes()

Returns:

  • int—

GetNumBalls

int GetNumBalls()

Returns:

  • int—

GetNumButtons

int GetNumButtons()

Returns:

  • int—

GetNumHats

int GetNumHats()

Returns:

  • int—

GetReleasedButton

cGamepadInputData GetReleasedButton()

Returns:

  • cGamepadInputData—

GetUpdatedAxis

cGamepadInputData GetUpdatedAxis()

Returns:

  • cGamepadInputData—

HasInputUpdates

bool HasInputUpdates()

Returns:

  • bool—

HatIsInState

bool HatIsInState(eGamepadHat aHat,
                  eGamepadHatState aState)


Parameters

Returns:

  • bool—

HatsChanged

bool HatsChanged()

Returns:

  • bool—

SetAxisDeadZoneRadiusValue

void SetAxisDeadZoneRadiusValue(float afValue)


Parameters

  • afValue (float) —

Returns:

  • void

SetColorLED

void SetColorLED(const cColor &in aColor)


Parameters

Returns:

  • void

SetRumble

void SetRumble(float afValue,
               int alMillisec)


Parameters

  • afValue (float) —
  • alMillisec (int) —

Returns:

  • void

References


See all references...