WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

ControllerState
✖
ControllerState

Unsupported in Cloud

✖

gives the state of the control c for the first connected controller device on which it is supported.

✖
ControllerState[{"c1","c2",…}]

gives the states of several controls.

✖
ControllerState[id,"c"]

gives the state of control c for controller devices with the specified identifier.

✖
ControllerState[id,{"c1","c2",…}]

gives the states of several controls for several controller devices.

Details and Options

  • Dynamic[ControllerState[…]] gives continually updated current controller states.
  • Typical control names include:
  • "X" or "X1"xprimary value
    "Y" or "Y1"yprimary value
    "Z" or "Z1"zprimary value
    "XY" or "XY1"{x,y}primary 2-axis controller value
    "XYZ" or "XYZ1"{x,y,z}primary 3-axis controller value
    "X2", "Y2", "XY2", etc.x, y, {x,y}, etc.values from a secondary controller
    "B1", "B2", etc.b1, b2, etc.button states
  • The following special control names are also possible:
  • "Axes"a list of all supported axis-like controls
    "Buttons"a list of all supported button-like controls
    "Controls"a list of all supported controls
    "Hardware"information on the controller device hardware
    "Mapping"rules for Wolfram System mappings of controls
    "Rules"rules for the settings of all controls
  • ControllerState always gives absolute instantaneous control states; it does not give relative or cyclic control states of the type available in Manipulate.
  • If no explicit controller identifier id is given, the controller used will be the first one found on the list specified by the option ControllerPath that supports all the controls "ci" requested.
  • Identifiers for controllers can be the following:
  • "name"device name from ControllerInformation
    "class"device class specifier
    nraw device index from ControllerInformation
    Allall devices supporting the requested controls
  • Possible device class identifiers include:
  • "Gamepad"controller typically including two analog controls
    "Joystick"controller typically including one primary analog control
    "Detachable"controller not built into a computer
    "BuiltIn"controller built into a computer
  • If a requested control value is not available, ControllerState returns $Failed for that value.

Examples

open allclose all

Basic Examples  (1)Summary of the most common use cases

Check the state of button 1:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-jppyk3
Out[1]=1

Check multiple values at once:

In[2]:=2
✖
https://wolfram.com/xid/0b0kc4uo6t0-d9oczb
Out[2]=2

Scope  (2)Survey of the scope of standard use cases

Acquire a list of all button controls supported by the device:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-0r8pf
Out[1]=1

Specify which controller type should be used:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-n2nb26
Out[1]=1

If no device of that type is attached, $Failed is returned:

In[2]:=2
✖
https://wolfram.com/xid/0b0kc4uo6t0-b43421
Out[2]=2

Options  (1)Common values & functionality for each option

ControllerPath  (1)

If multiple controllers are attached, specify the order of control sampling:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-eapz0c
Out[1]=1

By default, controls are sampled in the following order:

In[2]:=2
✖
https://wolfram.com/xid/0b0kc4uo6t0-podi0r
Out[2]=2

Properties & Relations  (3)Properties of the function, and connections to other functions

The controls for Manipulate are automatically linked to a controller:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-m0jgqk
Out[1]=1

Bind x to the X controller when your selection contains the output:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-cxj6z4
Out[1]=1

ControllerInformation can be used to find a device name:

In[1]:=1
✖
https://wolfram.com/xid/0b0kc4uo6t0-2xpmi
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0b0kc4uo6t0-k02rqd
Out[2]=2
Wolfram Research (2007), ControllerState, Wolfram Language function, https://reference.wolfram.com/language/ref/ControllerState.html.
✖
Wolfram Research (2007), ControllerState, Wolfram Language function, https://reference.wolfram.com/language/ref/ControllerState.html.

Text

Wolfram Research (2007), ControllerState, Wolfram Language function, https://reference.wolfram.com/language/ref/ControllerState.html.

✖
Wolfram Research (2007), ControllerState, Wolfram Language function, https://reference.wolfram.com/language/ref/ControllerState.html.

CMS

Wolfram Language. 2007. "ControllerState." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/ControllerState.html.

✖
Wolfram Language. 2007. "ControllerState." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/ControllerState.html.

APA

Wolfram Language. (2007). ControllerState. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ControllerState.html

✖
Wolfram Language. (2007). ControllerState. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ControllerState.html

BibTeX

@misc{reference.wolfram_2024_controllerstate, author="Wolfram Research", title="{ControllerState}", year="2007", howpublished="\url{https://reference.wolfram.com/language/ref/ControllerState.html}", note=[Accessed: 07-January-2025 ]}

✖
@misc{reference.wolfram_2024_controllerstate, author="Wolfram Research", title="{ControllerState}", year="2007", howpublished="\url{https://reference.wolfram.com/language/ref/ControllerState.html}", note=[Accessed: 07-January-2025 ]}

BibLaTeX

@online{reference.wolfram_2024_controllerstate, organization={Wolfram Research}, title={ControllerState}, year={2007}, url={https://reference.wolfram.com/language/ref/ControllerState.html}, note=[Accessed: 07-January-2025 ]}

✖
@online{reference.wolfram_2024_controllerstate, organization={Wolfram Research}, title={ControllerState}, year={2007}, url={https://reference.wolfram.com/language/ref/ControllerState.html}, note=[Accessed: 07-January-2025 ]}