Hitcher: /* Available tags */

2026-06-22T19:13:57Z

Available tags

← Older revision		Revision as of 19:13, 22 June 2026
Line 41:		Line 41:
	\| The location of the underlying peripheral providing input, e.g. <code>/joystick/0</code> for the first physical controller held by the user. Used to highlight the controller on peripheral activity.		\| The location of the underlying peripheral providing input, e.g. <code>/joystick/0</code> for the first physical controller held by the user. Used to highlight the controller on peripheral activity.
	\|}		\|}
	~~The control has been greatly expanded to allow for more use cases in the new Player Viewer (<code>GameAgents</code>) dialog.~~
	=== Controller address ===		=== Controller address ===
	The controller address is connected to the in-game input. It's formed by the emulated console's port, followed by the controller ID.		The controller address is connected to the in-game input. It's formed by the emulated console's port, followed by the controller ID.

Hitcher: Created page with "{{mininav| Skinning | Available controls }}
'''Used to display a game controller, with optional effects.''' The game controller control is used for displaying a game controller, such as joysticks, keyboards, mice, lightguns, etc. In v21 Omega, the control was expanded to give skinners more control over how it behaves, including manually specifying a controller to show, allowing for a fallback image, and applying a highl..."

2026-06-22T19:05:52Z

Created page with "{{mininav| Skinning | Available controls }} <section begin="main content" /> '''Used to display a game controller, with optional effects.''' The game controller control is used for displaying a game controller, such as joysticks, keyboards, mice, lightguns, etc. In v21 Omega, the control was expanded to give skinners more control over how it behaves, including manually specifying a controller to show, allowing for a fallback image, and applying a highl..."

New page

{{mininav| [[Skinning]] | [[Controls|Available controls]] }}
<section begin="main content" />
'''Used to display a game controller, with optional effects.'''

The game controller control is used for displaying a game controller, such as joysticks, keyboards, mice, lightguns, etc.

In v21 Omega, the control was expanded to give skinners more control over how it behaves, including manually specifying a controller to show, allowing for a fallback image, and applying a highlighting diffuse effect when the underlying controller is active.
=== Example ===
<syntaxhighlight lang="XML" enclose="div">
<control type="gamecontroller">
<description>My first game controller</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>200</height>
<controllerid>game.controller.snes</controllerid>
</control>
</syntaxhighlight>
=== Available tags ===
The '''[[Default Control Tags]]''' are applicable to this control. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

In v21 and above, the control derives from an [[Image_Control]] to allow for a fallback texture. All tags and attributes for images can be used, and any game-specific tags will cause the texture to be overridden.

The game-specific tags added in v21 are:
{| class="prettytable"
! Tag !! Description
|-
| '''controllerid'''
| The add-on ID of the controller profile to render, e.g. <code>game.controller.snes</code>.
|-
| '''controllerdiffuse'''
| A diffuse color used to highlight the controller when activity is detected on the in-game port or on the underlying peripheral held by the user.
|-
| '''controlleraddress'''
| The in-game "address" of the controller, e.g. <code>/1/game.controller.snes</code> for a SNES controller connected to console port 1. Used to highlight the controller on port activity. Overrides <code><controllerid></code> and <code><portaddress></code>.
|-
| '''portaddress'''
| The in-game "address" of the port the controller is connected to, e.g. <code>/1</code> for port 1 of a SNES emulator. Used to highlight the controller on port activity.
|-
| '''peripherallocation'''
| The location of the underlying peripheral providing input, e.g. <code>/joystick/0</code> for the first physical controller held by the user. Used to highlight the controller on peripheral activity.
|}
The control has been greatly expanded to allow for more use cases in the new Player Viewer (<code>GameAgents</code>) dialog.
=== Controller address ===
The controller address is connected to the in-game input. It's formed by the emulated console's port, followed by the controller ID.

For example, on SNES controllers, the address of the first port is <code>/1</code>. The address of a SNES controller connected to that port is <code>/1/game.controller.snes</code>.

Old consoles used multitaps (controller hubs) to allow for more players than console ports. A multitap connected to port <code>/2</code> would have the address <code>/2/game.controller.snes.multitap</code>.

A SNES controller connected to port 1 on a multitap would then have the address <code>/2/game.controller.snes.multitap/1/game.controller.snes</code>.
=== Peripheral location ===
Peripherals are located by a <code>peripherals://</code> URI containing their peripheral bus as a hostname and a path to the peripheral. For example, keyboards have the location <code>peripherals://application/keyboard.dev</code>.
=== List item info ===
List item info can be used for all tag values. For example, if the control definition looks like:
<syntaxhighlight lang="XML" enclose="div">
<itemlayout width="96" height="96">
<control type="gamecontroller">
<texture>$INFO[ListItem.Icon]</texture>
<controllerid>$INFO[ListItem.Property(controllerid)]</controllerid>
</control>
</itemlayout>
</syntaxhighlight>
Static list items can be provided. Each gamewindow will inherit the properties:
<syntaxhighlight lang="XML" enclose="div">
<content>
<item>
<icon>DefaultAddonNone.png</icon>
</item>
<item>
<property name="controllerid">game.controller.snes</property>
</item>
</content>
</syntaxhighlight>
The in-game dialogs that highlight game controllers on button presses (<code>GamePorts</code> and <code>GameAgents</code>) use a similar strategy with list items populated by core.
<section end="main content" />
== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Game Controller - Revision history

Hitcher: /* Available tags */