Difference between revisions of "Lua:getXBox360ControllerState"

From Cheat Engine
Jump to navigation Jump to search
m (Reverted edits by This content is not available (Talk) to last revision by FreeER)
 
Line 1: Line 1:
 
[[Category:Lua]]
 
[[Category:Lua]]
−
'''function''' getXBox360ControllerState(''ControllerID'' OPTIONAL)
+
{{CodeBox|'''function''' getXBox360ControllerState(''ControllerID'') ''':''' table}}
  
−
Returns a table containing the following fields on success (returns nothing/nil on failure):
+
Fetches the state of a connected Xbox 360 controller.
  
−
=== Function Parameters ===
+
If successful, this function returns a table containing the current controller state, including button states, trigger values, thumbstick positions, the controller ID, and the packet number.
  
−
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
+
The packet number can be used to detect whether the controller state has changed since the last call.
−
!align="left"|Index
+
 
 +
===Function Parameters===
 +
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
 +
!align="left"|Parameter
 
!align="left"|Type
 
!align="left"|Type
 
!style="width: 80%;background-color:white;" align="left"|Description
 
!style="width: 80%;background-color:white;" align="left"|Description
−
    |-
+
|-
−
    |ControllerID  
+
|ControllerID
−
    |integer
+
|Integer (optional)
−
    |The id of the controller (between 0 and 3)
+
|The ID of the controller to fetch the state from. Valid values range from 0 to 3.
−
    |-
+
|}
−
    |PacketNumber
 
−
    |integer
 
−
    |The packet id of the state you see. (use to detect changes)
 
−
    |-
 
−
    |GAMEPAD_DPAD_UP
 
−
    |boolean
 
−
    |D-PAD Up
 
−
    |-
 
−
    |GAMEPAD_DPAD_DOWN
 
−
    |boolean
 
−
    |D-PAD Down
 
−
    |-
 
−
    |GAMEPAD_DPAD_LEFT
 
−
    |boolean
 
−
    |D-PAD Left
 
−
    |-
 
−
    |GAMEPAD_DPAD_RIGHT
 
−
    |boolean
 
−
    |D-PAD Right
 
−
    |-
 
−
    |GAMEPAD_START
 
−
    |boolean
 
−
    |Start button
 
−
    |-
 
−
    |GAMEPAD_BACK
 
−
    |boolean
 
−
    |Back button
 
−
    |-
 
−
    |GAMEPAD_LEFT_THUMB
 
−
    |boolean
 
−
    |Left thumb stick down
 
−
    |-
 
−
    |GAMEPAD_RIGHT_THUMB
 
−
    |boolean
 
−
    |Right thumb stick down
 
−
    |-
 
−
    |GAMEPAD_LEFT_SHOULDER
 
−
    |boolean
 
−
    |Left shoulder button
 
−
    |-
 
−
    |GAMEPAD_RIGHT_SHOULDER
 
−
    |boolean
 
−
    |Right shoulder button
 
  
−
    |-
+
===Returns===
−
    |GAMEPAD_A
+
table — A table containing the current controller state on success.
−
    |boolean
 
−
    |A button
 
−
    |-
 
−
    |GAMEPAD_B
 
−
    |boolean
 
−
    |B button
 
−
    |-
 
−
    |GAMEPAD_X
 
−
    |boolean
 
−
    |X button
 
−
    |-
 
−
    |GAMEPAD_Y
 
−
    |boolean
 
−
    |Y button
 
  
−
    |-
+
===Return Table Fields===
−
    |LeftTrigger
+
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
−
    |integer ranging from 0 to 255
+
!align="left"|Field
−
    |Left trigger
+
!align="left"|Type
−
    |-
+
!style="width: 80%;background-color:white;" align="left"|Description
−
    |RightTrigger
+
|-
−
    |integer ranging from 0 to 255
+
|ControllerID
−
    |Right trigger
+
|Integer
 +
|The ID of the controller. Valid values range from 0 to 3.
 +
|-
 +
|PacketNumber
 +
|Integer
 +
|The packet ID of the controller state. This can be used to detect state changes.
 +
|-
 +
|GAMEPAD_DPAD_UP
 +
|Boolean
 +
|True if D-PAD Up is pressed.
 +
|-
 +
|GAMEPAD_DPAD_DOWN
 +
|Boolean
 +
|True if D-PAD Down is pressed.
 +
|-
 +
|GAMEPAD_DPAD_LEFT
 +
|Boolean
 +
|True if D-PAD Left is pressed.
 +
|-
 +
|GAMEPAD_DPAD_RIGHT
 +
|Boolean
 +
|True if D-PAD Right is pressed.
 +
|-
 +
|GAMEPAD_START
 +
|Boolean
 +
|True if the Start button is pressed.
 +
|-
 +
|GAMEPAD_BACK
 +
|Boolean
 +
|True if the Back button is pressed.
 +
|-
 +
|GAMEPAD_LEFT_THUMB
 +
|Boolean
 +
|True if the left thumbstick button is pressed.
 +
|-
 +
|GAMEPAD_RIGHT_THUMB
 +
|Boolean
 +
|True if the right thumbstick button is pressed.
 +
|-
 +
|GAMEPAD_LEFT_SHOULDER
 +
|Boolean
 +
|True if the left shoulder button is pressed.
 +
|-
 +
|GAMEPAD_RIGHT_SHOULDER
 +
|Boolean
 +
|True if the right shoulder button is pressed.
 +
|-
 +
|GAMEPAD_A
 +
|Boolean
 +
|True if the A button is pressed.
 +
|-
 +
|GAMEPAD_B
 +
|Boolean
 +
|True if the B button is pressed.
 +
|-
 +
|GAMEPAD_X
 +
|Boolean
 +
|True if the X button is pressed.
 +
|-
 +
|GAMEPAD_Y
 +
|Boolean
 +
|True if the Y button is pressed.
 +
|-
 +
|LeftTrigger
 +
|Integer
 +
|The value of the left trigger. The value ranges from 0 to 255.
 +
|-
 +
|RightTrigger
 +
|Integer
 +
|The value of the right trigger. The value ranges from 0 to 255.
 +
|-
 +
|ThumbLeftX
 +
|Integer
 +
|The horizontal position of the left thumbstick. The value ranges from -32768 to 32767.
 +
|-
 +
|ThumbLeftY
 +
|Integer
 +
|The vertical position of the left thumbstick. The value ranges from -32768 to 32767.
 +
|-
 +
|ThumbRightX
 +
|Integer
 +
|The horizontal position of the right thumbstick. The value ranges from -32768 to 32767.
 +
|-
 +
|ThumbRightY
 +
|Integer
 +
|The vertical position of the right thumbstick. The value ranges from -32768 to 32767.
 +
|}
  
−
    |-
+
===Examples===
−
    |ThumbLeftX
+
<pre>
−
    |integer ranging from -32768 to 32767
+
local state = getXBox360ControllerState()
−
    |Horizontal position of the left thumbstick
+
 
−
    |-
+
if state ~= nil then
−
    |ThumbLeftY
+
  print("Controller ID: " .. state.ControllerID)
−
    |integer ranging from -32768 to 32767
+
  print("Packet number: " .. state.PacketNumber)
−
    |Verital position of the left thumbstick
 
−
    |-
 
−
    |ThumbRightX
 
−
    |integer ranging from -32768 to 32767
 
−
    |Horizontal position of the right thumbstick
 
−
    |-
 
−
    |ThumbRightY
 
−
    |integer ranging from -32768 to 32767
 
−
    |Vertical position of the right thumbstick
 
−
|}
 
  
 +
  if state.GAMEPAD_A then
 +
    print("A button is pressed")
 +
  end
  
−
== See also ==
+
  print("Left trigger: " .. state.LeftTrigger)
−
* [[Lua]]
+
  print("Left thumbstick X: " .. state.ThumbLeftX)
−
* [[Help_File:Script engine|Script engine]]
+
  print("Left thumbstick Y: " .. state.ThumbLeftY)
 +
end
 +
</pre>
  
−
=== Related Functions ===
+
{{LuaSeeAlso}}
−
* [[Lua:setXBox360ControllerVibration|setXBox360ControllerVibration]]
 

Latest revision as of 04:00, 21 June 2026

<> Function

function getXBox360ControllerState(ControllerID) : table

Fetches the state of a connected Xbox 360 controller.

If successful, this function returns a table containing the current controller state, including button states, trigger values, thumbstick positions, the controller ID, and the packet number.

The packet number can be used to detect whether the controller state has changed since the last call.

Function Parameters[edit]

Parameter Type Description
ControllerID Integer (optional) The ID of the controller to fetch the state from. Valid values range from 0 to 3.

Returns[edit]

table — A table containing the current controller state on success.

Return Table Fields[edit]

Field Type Description
ControllerID Integer The ID of the controller. Valid values range from 0 to 3.
PacketNumber Integer The packet ID of the controller state. This can be used to detect state changes.
GAMEPAD_DPAD_UP Boolean True if D-PAD Up is pressed.
GAMEPAD_DPAD_DOWN Boolean True if D-PAD Down is pressed.
GAMEPAD_DPAD_LEFT Boolean True if D-PAD Left is pressed.
GAMEPAD_DPAD_RIGHT Boolean True if D-PAD Right is pressed.
GAMEPAD_START Boolean True if the Start button is pressed.
GAMEPAD_BACK Boolean True if the Back button is pressed.
GAMEPAD_LEFT_THUMB Boolean True if the left thumbstick button is pressed.
GAMEPAD_RIGHT_THUMB Boolean True if the right thumbstick button is pressed.
GAMEPAD_LEFT_SHOULDER Boolean True if the left shoulder button is pressed.
GAMEPAD_RIGHT_SHOULDER Boolean True if the right shoulder button is pressed.
GAMEPAD_A Boolean True if the A button is pressed.
GAMEPAD_B Boolean True if the B button is pressed.
GAMEPAD_X Boolean True if the X button is pressed.
GAMEPAD_Y Boolean True if the Y button is pressed.
LeftTrigger Integer The value of the left trigger. The value ranges from 0 to 255.
RightTrigger Integer The value of the right trigger. The value ranges from 0 to 255.
ThumbLeftX Integer The horizontal position of the left thumbstick. The value ranges from -32768 to 32767.
ThumbLeftY Integer The vertical position of the left thumbstick. The value ranges from -32768 to 32767.
ThumbRightX Integer The horizontal position of the right thumbstick. The value ranges from -32768 to 32767.
ThumbRightY Integer The vertical position of the right thumbstick. The value ranges from -32768 to 32767.

Examples[edit]

local state = getXBox360ControllerState()

if state ~= nil then
  print("Controller ID: " .. state.ControllerID)
  print("Packet number: " .. state.PacketNumber)

  if state.GAMEPAD_A then
    print("A button is pressed")
  end

  print("Left trigger: " .. state.LeftTrigger)
  print("Left thumbstick X: " .. state.ThumbLeftX)
  print("Left thumbstick Y: " .. state.ThumbLeftY)
end

See also[edit]

Lua
Script Engine


Retrieved from "https://wiki.cheatengine.org/index.php?title=Lua:getXBox360ControllerState&oldid=7931"