Controller-device-list container - Revision history

Pw3r at 06:22, 22 November 2017

2017-11-22T06:22:27Z

← Older revision		Revision as of 06:22, 22 November 2017
Line 2:		Line 2:

	==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====

Pw3r at 05:44, 22 November 2017

2017-11-22T05:44:45Z

← Older revision		Revision as of 05:44, 22 November 2017
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==

Pw3r: 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..."

2017-11-22T05:35:14Z

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..."

New page

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.

==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.

name-token
desc-token
controls
{
}

====name-token====
: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-token====
: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.

====controls====
:Type: [[hardware-controls-list_container|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 [[hardware-controls-list_container|here]].

==Example container==
See [[KIND_tni-controls-plugin#Example_Config.txt|tni-controls-plugin]].

==Categories==
[[Category:Config Container]]