SteamWorks.SteamController

Interface: SteamController

SteamWorksNamespace.SteamController

Table of contents

Properties

• ActivateActionSet
• ActivateActionSetLayer
• DeactivateActionSetLayer
• DeactivateAllActionSetLayers
• GetActionOriginFromXboxOrigin
• GetActionSetHandle
• GetActiveActionSetLayers
• GetAnalogActionData
• GetAnalogActionHandle
• GetAnalogActionOrigins
• GetConnectedControllers
• GetControllerBindingRevision
• GetControllerForGamepadIndex
• GetCurrentActionSet
• GetDigitalActionData
• GetDigitalActionHandle
• GetDigitalActionOrigins
• GetGamepadIndexForController
• GetGlyphForActionOrigin
• GetGlyphForXboxOrigin
• GetInputTypeForHandle
• GetMotionData
• GetStringForActionOrigin
• GetStringForXboxOrigin
• Init
• RunFrame
• SetLEDColor
• ShowBindingPanel
• Shutdown
• StopAnalogActionMomentum
• TranslateActionOrigin
• TriggerHapticPulse
• TriggerRepeatedHapticPulse
• TriggerVibration

Properties

ActivateActionSet

• ActivateActionSet: (controllerHandle: bigint, actionSetHandle: bigint) => undefined

Type declaration

▸ (controllerHandle, actionSetHandle): undefined

Parameters

Name	Type
controllerHandle	bigint
actionSetHandle	bigint

Returns

undefined

Defined in

index.d.ts:2629

---

ActivateActionSetLayer

• ActivateActionSetLayer: (controllerHandle: bigint, actionSetLayerHandle: bigint) => undefined

Type declaration

▸ (controllerHandle, actionSetLayerHandle): undefined

Parameters

Name	Type
controllerHandle	bigint
actionSetLayerHandle	bigint

Returns

undefined

Defined in

index.d.ts:2631

---

DeactivateActionSetLayer

• DeactivateActionSetLayer: (controllerHandle: bigint, actionSetLayerHandle: bigint) => undefined

Type declaration

▸ (controllerHandle, actionSetLayerHandle): undefined

Parameters

Name	Type
controllerHandle	bigint
actionSetLayerHandle	bigint

Returns

undefined

Defined in

index.d.ts:2632

---

DeactivateAllActionSetLayers

• DeactivateAllActionSetLayers: (controllerHandle: bigint) => undefined

Type declaration

▸ (controllerHandle): undefined

Parameters

Name	Type
controllerHandle	bigint

Returns

undefined

Defined in

index.d.ts:2633

---

GetActionOriginFromXboxOrigin

• GetActionOriginFromXboxOrigin: (controllerHandle: bigint, eOrigin: EXboxOrigin) => EControllerActionOrigin

Type declaration

▸ (controllerHandle, eOrigin): EControllerActionOrigin

Parameters

Name	Type
controllerHandle	bigint
eOrigin	EXboxOrigin

Returns

EControllerActionOrigin

Defined in

index.d.ts:2655

---

GetActionSetHandle

• GetActionSetHandle: (pszActionSetName: string) => bigint

Type declaration

▸ (pszActionSetName): bigint

Parameters

Name	Type
pszActionSetName	string

Returns

bigint

Defined in

index.d.ts:2628

---

GetActiveActionSetLayers

• GetActiveActionSetLayers: (controllerHandle: bigint, handlesOut: unknown) => number

Type declaration

▸ (controllerHandle, handlesOut): number

Parameters

Name	Type
controllerHandle	bigint
handlesOut	unknown

Returns

number

Defined in

index.d.ts:2634

---

GetAnalogActionData

• GetAnalogActionData: (controllerHandle: bigint, analogActionHandle: bigint) => InputAnalogActionData_t

Type declaration

▸ (controllerHandle, analogActionHandle): InputAnalogActionData_t

Parameters

Name	Type
controllerHandle	bigint
analogActionHandle	bigint

Returns

InputAnalogActionData_t

Defined in

index.d.ts:2639

---

GetAnalogActionHandle

• GetAnalogActionHandle: (pszActionName: string) => bigint

Type declaration

▸ (pszActionName): bigint

Parameters

Name	Type
pszActionName	string

Returns

bigint

Defined in

index.d.ts:2638

---

GetAnalogActionOrigins

• GetAnalogActionOrigins: (controllerHandle: bigint, actionSetHandle: bigint, analogActionHandle: bigint, originsOut: unknown) => number

Type declaration

▸ (controllerHandle, actionSetHandle, analogActionHandle, originsOut): number

Parameters

Name	Type
controllerHandle	bigint
actionSetHandle	bigint
analogActionHandle	bigint
originsOut	unknown

Returns

number

Defined in

index.d.ts:2640

---

GetConnectedControllers

• GetConnectedControllers: (handlesOut: unknown) => number

Type declaration

▸ (handlesOut): number

Parameters

Name	Type
handlesOut	unknown

Returns

number

Defined in

index.d.ts:2627

---

GetControllerBindingRevision

• GetControllerBindingRevision: (controllerHandle: bigint, pMajor: number, pMinor: number) => boolean

Type declaration

▸ (controllerHandle, pMajor, pMinor): boolean

Parameters

Name	Type
controllerHandle	bigint
pMajor	number
pMinor	number

Returns

boolean

Defined in

index.d.ts:2657

---

GetControllerForGamepadIndex

• GetControllerForGamepadIndex: (nIndex: number) => bigint

Type declaration

▸ (nIndex): bigint

Parameters

Name	Type
nIndex	number

Returns

bigint

Defined in

index.d.ts:2651

---

GetCurrentActionSet

• GetCurrentActionSet: (controllerHandle: bigint) => bigint

Type declaration

▸ (controllerHandle): bigint

Parameters

Name	Type
controllerHandle	bigint

Returns

bigint

Defined in

index.d.ts:2630

---

GetDigitalActionData

• GetDigitalActionData: (controllerHandle: bigint, digitalActionHandle: bigint) => InputDigitalActionData_t

Type declaration

▸ (controllerHandle, digitalActionHandle): InputDigitalActionData_t

Parameters

Name	Type
controllerHandle	bigint
digitalActionHandle	bigint

Returns

InputDigitalActionData_t

Defined in

index.d.ts:2636

---

GetDigitalActionHandle

• GetDigitalActionHandle: (pszActionName: string) => bigint

Type declaration

▸ (pszActionName): bigint

Parameters

Name	Type
pszActionName	string

Returns

bigint

Defined in

index.d.ts:2635

---

GetDigitalActionOrigins

• GetDigitalActionOrigins: (controllerHandle: bigint, actionSetHandle: bigint, digitalActionHandle: bigint, originsOut: unknown) => number

Type declaration

▸ (controllerHandle, actionSetHandle, digitalActionHandle, originsOut): number

Parameters

Name	Type
controllerHandle	bigint
actionSetHandle	bigint
digitalActionHandle	bigint
originsOut	unknown

Returns

number

Defined in

index.d.ts:2637

---

GetGamepadIndexForController

• GetGamepadIndexForController: (ulControllerHandle: bigint) => number

Type declaration

▸ (ulControllerHandle): number

Parameters

Name	Type
ulControllerHandle	bigint

Returns

number

Defined in

index.d.ts:2652

---

GetGlyphForActionOrigin

• GetGlyphForActionOrigin: (eOrigin: EControllerActionOrigin) => string

Type declaration

▸ (eOrigin): string

Parameters

Name	Type
eOrigin	EControllerActionOrigin

Returns

string

Defined in

index.d.ts:2641

---

GetGlyphForXboxOrigin

• GetGlyphForXboxOrigin: (eOrigin: EXboxOrigin) => string

Type declaration

▸ (eOrigin): string

Parameters

Name	Type
eOrigin	EXboxOrigin

Returns

string

Defined in

index.d.ts:2654

---

GetInputTypeForHandle

• GetInputTypeForHandle: (controllerHandle: bigint) => ESteamInputType

Type declaration

▸ (controllerHandle): ESteamInputType

Parameters

Name	Type
controllerHandle	bigint

Returns

ESteamInputType

Defined in

index.d.ts:2650

---

GetMotionData

• GetMotionData: (controllerHandle: bigint) => InputMotionData_t

Type declaration

▸ (controllerHandle): InputMotionData_t

Parameters

Name	Type
controllerHandle	bigint

Returns

InputMotionData_t

Defined in

index.d.ts:2644

---

GetStringForActionOrigin

• GetStringForActionOrigin: (eOrigin: EControllerActionOrigin) => string

Type declaration

▸ (eOrigin): string

Parameters

Name	Type
eOrigin	EControllerActionOrigin

Returns

string

Defined in

index.d.ts:2642

---

GetStringForXboxOrigin

• GetStringForXboxOrigin: (eOrigin: EXboxOrigin) => string

Type declaration

▸ (eOrigin): string

Parameters

Name	Type
eOrigin	EXboxOrigin

Returns

string

Defined in

index.d.ts:2653

---

Init

• Init: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2624

---

RunFrame

• RunFrame: () => undefined

Type declaration

▸ (): undefined

Returns

undefined

Defined in

index.d.ts:2626

---

SetLEDColor

• SetLEDColor: (controllerHandle: bigint, nColorR: number, nColorG: number, nColorB: number, nFlags: number) => undefined

Type declaration

▸ (controllerHandle, nColorR, nColorG, nColorB, nFlags): undefined

Parameters

Name	Type
controllerHandle	bigint
nColorR	number
nColorG	number
nColorB	number
nFlags	number

Returns

undefined

Defined in

index.d.ts:2648

---

ShowBindingPanel

• ShowBindingPanel: (controllerHandle: bigint) => boolean

Type declaration

▸ (controllerHandle): boolean

Parameters

Name	Type
controllerHandle	bigint

Returns

boolean

Defined in

index.d.ts:2649

---

Shutdown

• Shutdown: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2625

---

StopAnalogActionMomentum

• StopAnalogActionMomentum: (controllerHandle: bigint, eAction: bigint) => undefined

Type declaration

▸ (controllerHandle, eAction): undefined

Parameters

Name	Type
controllerHandle	bigint
eAction	bigint

Returns

undefined

Defined in

index.d.ts:2643

---

TranslateActionOrigin

• TranslateActionOrigin: (eDestinationInputType: ESteamInputType, eSourceOrigin: EControllerActionOrigin) => EControllerActionOrigin

Type declaration

▸ (eDestinationInputType, eSourceOrigin): EControllerActionOrigin

Parameters

Name	Type
eDestinationInputType	ESteamInputType
eSourceOrigin	EControllerActionOrigin

Returns

EControllerActionOrigin

Defined in

index.d.ts:2656

---

TriggerHapticPulse

• TriggerHapticPulse: (controllerHandle: bigint, eTargetPad: ESteamControllerPad, usDurationMicroSec: number) => undefined

Type declaration

▸ (controllerHandle, eTargetPad, usDurationMicroSec): undefined

Parameters

Name	Type
controllerHandle	bigint
eTargetPad	ESteamControllerPad
usDurationMicroSec	number

Returns

undefined

Defined in

index.d.ts:2645

---

TriggerRepeatedHapticPulse

• TriggerRepeatedHapticPulse: (controllerHandle: bigint, eTargetPad: ESteamControllerPad, usDurationMicroSec: number, usOffMicroSec: number, unRepeat: number, nFlags: number) => undefined

Type declaration

▸ (controllerHandle, eTargetPad, usDurationMicroSec, usOffMicroSec, unRepeat, nFlags): undefined

Parameters

Name	Type
controllerHandle	bigint
eTargetPad	ESteamControllerPad
usDurationMicroSec	number
usOffMicroSec	number
unRepeat	number
nFlags	number

Returns

undefined

Defined in

index.d.ts:2646

---

TriggerVibration

• TriggerVibration: (controllerHandle: bigint, usLeftSpeed: number, usRightSpeed: number) => undefined

Type declaration

▸ (controllerHandle, usLeftSpeed, usRightSpeed): undefined

Parameters

Name	Type
controllerHandle	bigint
usLeftSpeed	number
usRightSpeed	number

Returns

undefined

Defined in

index.d.ts:2647