https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FiGamepad
HPL3/Amnesia: Rebirth/Scripting/iGamepad - Revision history
2026-05-15T01:33:03Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/iGamepad&diff=6057&oldid=prev
Abion47: Created page with "{{ScriptingStub}} 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. ==Function..."
2020-11-15T22:38:22Z
<p>Created page with "{{ScriptingStub}} 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. ==Function..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Fields==<br />
iGamepad has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|bool|[[#AxesUpdated|AxesUpdated]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#ButtonIsDown|ButtonIsDown]]([[../eGamepadButton|eGamepadButton]] aButton)|}}<br />
{{CodeDocSummaryItem|bool|[[#ButtonIsPressed|ButtonIsPressed]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#ButtonIsReleased|ButtonIsReleased]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetAxisDeadZoneRadiusValue|GetAxisDeadZoneRadiusValue]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetAxisValue|GetAxisValue]]([[../eGamepadAxis|eGamepadAxis]] aAxis)|}}<br />
{{CodeDocSummaryItem|[[../cVector2l|cVector2l]]|[[#GetBallAbsPos|GetBallAbsPos]]([[../eGamepadBall|eGamepadBall]] aBall)|}}<br />
{{CodeDocSummaryItem|[[../cGamepadInputData|cGamepadInputData]]|[[#GetButton|GetButton]]()|}}<br />
{{CodeDocSummaryItem|[[../cColor|cColor]]|[[#GetColorLED|GetColorLED]]()|}}<br />
{{CodeDocSummaryItem|[[../tString|tString]]|[[#GetGamepadName|GetGamepadName]]()|}}<br />
{{CodeDocSummaryItem|[[../eGamepadHatState|eGamepadHatState]]|[[#GetHatCurrentState|GetHatCurrentState]]([[../eGamepadHat|eGamepadHat]] aHat)|}}<br />
{{CodeDocSummaryItem|[[../cGamepadInputData|cGamepadInputData]]|[[#GetHatState|GetHatState]]()|}}<br />
{{CodeDocSummaryItem|[[../cGamepadInputData|cGamepadInputData]]|[[#GetInputUpdate|GetInputUpdate]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetNumAxes|GetNumAxes]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetNumBalls|GetNumBalls]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetNumButtons|GetNumButtons]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetNumHats|GetNumHats]]()|}}<br />
{{CodeDocSummaryItem|[[../cGamepadInputData|cGamepadInputData]]|[[#GetReleasedButton|GetReleasedButton]]()|}}<br />
{{CodeDocSummaryItem|[[../cGamepadInputData|cGamepadInputData]]|[[#GetUpdatedAxis|GetUpdatedAxis]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#HasInputUpdates|HasInputUpdates]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#HatIsInState|HatIsInState]]([[../eGamepadHat|eGamepadHat]] aHat, [[../eGamepadHatState|eGamepadHatState]] aState)|}}<br />
{{CodeDocSummaryItem|bool|[[#HatsChanged|HatsChanged]]()|}}<br />
{{CodeDocSummaryItem|void|[[#SetAxisDeadZoneRadiusValue|SetAxisDeadZoneRadiusValue]](float afValue)|}}<br />
{{CodeDocSummaryItem|void|[[#SetColorLED|SetColorLED]](const [[../cColor|cColor]] &in aColor)|}}<br />
{{CodeDocSummaryItem|void|[[#SetRumble|SetRumble]](float afValue, int alMillisec)|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|AxesUpdated}}<br />
<syntaxhighlight lang="c++">bool AxesUpdated()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ButtonIsDown}}<br />
<syntaxhighlight lang="c++">bool ButtonIsDown(eGamepadButton aButton)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aButton|[[../eGamepadButton|eGamepadButton]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ButtonIsPressed}}<br />
<syntaxhighlight lang="c++">bool ButtonIsPressed()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ButtonIsReleased}}<br />
<syntaxhighlight lang="c++">bool ButtonIsReleased()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAxisDeadZoneRadiusValue}}<br />
<syntaxhighlight lang="c++">float GetAxisDeadZoneRadiusValue()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetAxisValue}}<br />
<syntaxhighlight lang="c++">float GetAxisValue(eGamepadAxis aAxis)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aAxis|[[../eGamepadAxis|eGamepadAxis]]|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetBallAbsPos}}<br />
<syntaxhighlight lang="c++">cVector2l GetBallAbsPos(eGamepadBall aBall)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aBall|[[../eGamepadBall|eGamepadBall]]|}}<br />
{{CodeDocDetailReturn|cVector2l|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetButton}}<br />
<syntaxhighlight lang="c++">cGamepadInputData GetButton()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cGamepadInputData|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetColorLED}}<br />
<syntaxhighlight lang="c++">cColor GetColorLED()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cColor|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetGamepadName}}<br />
<syntaxhighlight lang="c++">tString GetGamepadName()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|tString|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetHatCurrentState}}<br />
<syntaxhighlight lang="c++">eGamepadHatState GetHatCurrentState(eGamepadHat aHat)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aHat|[[../eGamepadHat|eGamepadHat]]|}}<br />
{{CodeDocDetailReturn|eGamepadHatState|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetHatState}}<br />
<syntaxhighlight lang="c++">cGamepadInputData GetHatState()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cGamepadInputData|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetInputUpdate}}<br />
<syntaxhighlight lang="c++">cGamepadInputData GetInputUpdate()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cGamepadInputData|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetNumAxes}}<br />
<syntaxhighlight lang="c++">int GetNumAxes()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetNumBalls}}<br />
<syntaxhighlight lang="c++">int GetNumBalls()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetNumButtons}}<br />
<syntaxhighlight lang="c++">int GetNumButtons()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetNumHats}}<br />
<syntaxhighlight lang="c++">int GetNumHats()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetReleasedButton}}<br />
<syntaxhighlight lang="c++">cGamepadInputData GetReleasedButton()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cGamepadInputData|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetUpdatedAxis}}<br />
<syntaxhighlight lang="c++">cGamepadInputData GetUpdatedAxis()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cGamepadInputData|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|HasInputUpdates}}<br />
<syntaxhighlight lang="c++">bool HasInputUpdates()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|HatIsInState}}<br />
<syntaxhighlight lang="c++">bool HatIsInState(eGamepadHat aHat,<br />
eGamepadHatState aState)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aHat|[[../eGamepadHat|eGamepadHat]]|}}<br />
{{CodeDocDetailParam|aState|[[../eGamepadHatState|eGamepadHatState]]|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|HatsChanged}}<br />
<syntaxhighlight lang="c++">bool HatsChanged()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetAxisDeadZoneRadiusValue}}<br />
<syntaxhighlight lang="c++">void SetAxisDeadZoneRadiusValue(float afValue)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afValue|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetColorLED}}<br />
<syntaxhighlight lang="c++">void SetColorLED(const cColor &in aColor)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aColor|[[../cColor|cColor]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetRumble}}<br />
<syntaxhighlight lang="c++">void SetRumble(float afValue,<br />
int alMillisec)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afValue|float|}}<br />
{{CodeDocDetailParam|alMillisec|int|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{ReferencesSection}}<br />
<br />
{{HPL3RebirthScriptingCategories}}</div>
Abion47