KIND Controlset

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Example Config.txt)
Line 1: Line 1:
 
[[KIND Controlset]]
 
[[KIND Controlset]]
  
Defines a set of input controls.
+
The 'controlset' kind defines a set of input controls. Support currently exists for keyboard input only, but this may be extended in the future. Individual controls are defined in the [[Controls_container|controls container]].
  
 
==Supported Tags==
 
==Supported Tags==
Line 7: Line 7:
  
 
==Supported Tags==
 
==Supported Tags==
Each traincar asset supports the following tags. Each tag is shown here with its default value.
+
Each traincar asset supports the following tags. The trainz-build tag should be greater than or equal to 3.6.
  
kind "controlset"
+
  kind                                   "controlset"
[[Controls_container|controls]]
+
  [[Controls_container|controls]]
{
+
  {
}
+
  }
  
 
====controls====
 
====controls====

Revision as of 13:45, 19 October 2011

KIND Controlset

The 'controlset' kind defines a set of input controls. Support currently exists for keyboard input only, but this may be extended in the future. Individual controls are defined in the controls container.

Contents

Supported Tags

Each controlset asset supports the following tags. Each tag is shown here with its default value.

Supported Tags

Each traincar asset supports the following tags. The trainz-build tag should be greater than or equal to 3.6.

 kind                                    "controlset"
 controls
 {
 }

controls

Type: Controls container
Desc: Specifies the various controls. Documented separately here.

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

Categories

Personal tools