Controller-device-list container

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Created page with "The controller-device-list container is a top-level config.txt file entry used by the controllers tag in [[KIND_tni-controls-plugin|tn...")
 
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
The [[controller-device-list_container|controller-device-list container]] is a top-level [[config.txt file]] entry used by the controllers tag in [[KIND_tni-controls-plugin|tni-controls-plugin]] assets. It provides the specification for one or more hardware controller devices, e.g. a RailDriver controller, a joystick, a gamepad, etc.
+
The [[controller-device-list_container|controller-device-list container]] is a [[config.txt file]] entry used by the controllers tag in [[KIND_tni-controls-plugin|tni-controls-plugin]] assets. It provides the specification for one or more hardware controller devices, e.g. a RailDriver controller, a joystick, a gamepad, etc.
  
 
==Supported Tags==
 
==Supported Tags==
The device-list container is a list of controller-device subcontainers with no standalone tags. Each controller device subcontainer supports the following tags.
+
The controller-device-list container is a list of controller-device subcontainers with no standalone tags. Each controller-device subcontainer supports the following tags.
  
 
   name-token
 
   name-token
Line 12: Line 12:
 
====name-token====
 
====name-token====
 
:Type: string
 
:Type: string
:Desc: The id of a [["String-table" container|string-table]] entry for the localised name of the control. This string table entry will be used in the Trainz UI to refer to the control. It should be very short (i.e. one or two words).
+
:Desc: The id of a [["String-table" container|string-table]] entry for the localised name of the controller. This string table entry will be used in the Trainz UI to refer to the controller. It should be very short (i.e. one or two words).
  
 
====desc-token====
 
====desc-token====
 
:Type: string
 
:Type: string
:Desc: The id of a [["String-table" container|string-table]] entry for the localised description of the control. This string table entry will be used in the Trainz UI to give detail to the player about the control. It should be fairly short (i.e. one short sentence). Optional.
+
:Desc: The id of a [["String-table" container|string-table]] entry for the localised description of the controller. This string table entry will be used in the Trainz UI to give detail to the player about the control. It should be fairly short (i.e. one short sentence). Optional.
  
 
====controls====
 
====controls====

Latest revision as of 16:22, 22 November 2017

The controller-device-list container is a config.txt file entry used by the controllers tag in tni-controls-plugin assets. It provides the specification for one or more hardware controller devices, e.g. a RailDriver controller, a joystick, a gamepad, etc.

Contents

[edit] Supported Tags

The controller-device-list container is a list of controller-device subcontainers with no standalone tags. Each controller-device subcontainer supports the following tags.

 name-token
 desc-token
 controls
 {
 }

[edit] name-token

Type: string
Desc: The id of a string-table entry for the localised name of the controller. This string table entry will be used in the Trainz UI to refer to the controller. It should be very short (i.e. one or two words).

[edit] desc-token

Type: string
Desc: The id of a string-table entry for the localised description of the controller. This string table entry will be used in the Trainz UI to give detail to the player about the control. It should be fairly short (i.e. one short sentence). Optional.

[edit] controls

Type: hardware-controls-list
Desc: Specifies the various controls supported by this controller type. I.e. Every lever, button, switch, etc on the hardware device. The format for the control subcontainers is documented separately here.

[edit] Example container

See tni-controls-plugin.

[edit] Categories

Personal tools