KIND Controlset
From TrainzOnline
(Difference between revisions)
(7 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
− | [[KIND Controlset]] | + | [[KIND Controlset]] defines a set of user-input controls. The controls defined represent basic commands, e.g. "Activate headlights", and are thus independent from the actual method used to activate them (e.g. a keyboard key, gamepad button, etc). |
− | + | ==KIND Hierarchy== | |
+ | ===Parent Classes=== | ||
+ | * [[KIND TrainzBaseSpec]] | ||
+ | ===Child Classes=== | ||
+ | * ''none.'' | ||
==Supported Tags== | ==Supported Tags== | ||
− | Each controlset asset supports the following tags. | + | Each controlset asset supports the following tags. The trainz-build tag should be greater than or equal to 3.6. |
− | + | controls | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
{ | { | ||
} | } | ||
Line 16: | Line 16: | ||
====controls==== | ====controls==== | ||
:Type: [[Controls_container|Controls container]] | :Type: [[Controls_container|Controls container]] | ||
− | :Desc: Specifies the various | + | :Desc: Specifies the various control commands. The specification for the controls themselves are documented separately [[Controls_container|here]]. |
==Example Config.txt== | ==Example Config.txt== | ||
Line 68: | Line 68: | ||
==Categories== | ==Categories== | ||
− | [[Category:Asset KIND]] | + | [[Category:Asset KIND|C]] |
Latest revision as of 14:04, 22 November 2017
KIND Controlset defines a set of user-input controls. The controls defined represent basic commands, e.g. "Activate headlights", and are thus independent from the actual method used to activate them (e.g. a keyboard key, gamepad button, etc).
Contents |
[edit] KIND Hierarchy
[edit] Parent Classes
[edit] Child Classes
- none.
[edit] Supported Tags
Each controlset asset supports the following tags. The trainz-build tag should be greater than or equal to 3.6.
controls { }
[edit] controls
- Type: Controls container
- Desc: Specifies the various control commands. The specification for the controls themselves are documented separately here.
[edit] Example Config.txt
Sample config.txt file for a controlset asset, with the standard tags excluded for brevity:
kuid <kuid:401543:1100> kind "controlset" username "Menu Controls" trainz-build 3.6 category-class "CS" description "Keyboard shortcuts used within the Trainz menus" thumbnails { 1 { image "thumbnail.jpg" width 240 height 180 } } controls { routes-menu { name-token "routes-name" desc-token "routes-desc" event "routes-menu" default-keys "r" context "Menu" } new-route { name-token "new-route-name" desc-token "new-route-desc" event "new-route" default-keys "n,c" context "Menu" } } string-table { routes-name "Routes Menu" routes-desc "Opens the routes menu" new-route-name "New Route" new-route-desc "Creates a new route in Surveyor" }