KIND Drivercommand

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (Added sort criterion)
(properties-behavior)
Line 17: Line 17:
 
:Type: Boolean
 
:Type: Boolean
 
:Desc: Order is written in such a way that it can be issued with a null driver character. If this is true, the order can be issued in surveyor.
 
:Desc: Order is written in such a way that it can be issued with a null driver character. If this is true, the order can be issued in surveyor.
 +
 +
====properties-behavior====
 +
:Type: String (enumerated)
 +
:Desc: Controls the behavior of the Driver Command in the 'add driver command' menu.
 +
 +
* no-properties -- The command requires no properties to be specified, and the instance will simply be created as-is.
 +
* edit-in-submenu -- The command prefers to show a submenu before the instance is created, controlling the initial configuration of the command instance. This should be used where there is only a single option to specify, where there are only a small number of choices for that option, and where a default selection would be inappropriate.
 +
* edit-after-add -- The command prefers to be edited in a popover after the instance is created. This should be used where there are multiple options to specify, or where the number of possible choices is large.
 +
 +
Note that the actual creation of the submenu and/or exposure of any properties via a popover are implemented in script. This tag simply tells Trainz what to expect so that it can display the initial menu without having to pay the cost of querying each possible script.
  
 
==Example Config.txt==
 
==Example Config.txt==

Revision as of 09:23, 2 May 2019

KIND Drivercommand assets are AI orders for use in sessions.

Contents

KIND Hierarchy

Parent Classes


kind ""
kuid <kuid:code1#:Code2#>
trainz-build ?
script ""
class ""
script-include-table
{
}
username ""
username-XX ""
description ""
description-XX ""
kuid-table
{
}
obsolete-table
{
}
string-table
{
}
string-table-XX
{
}
category-region ""
category-class ""
category-era ""
category-keyword ""
custom-category-list ""
must-have-product-rights ""
must-not-have-product-rights ""
privileges
{
}
thumbnails
{
}
extensions
{
}
license ""
author ""
organisation ""
contact-email ""
contact-website ""
member-of-groups
{
}

Child Classes

  • none.

Supported Tags

kind "drivercommand"
supports-null-driver-character 0

supports-null-driver-character

Type: Boolean
Desc: Order is written in such a way that it can be issued with a null driver character. If this is true, the order can be issued in surveyor.

properties-behavior

Type: String (enumerated)
Desc: Controls the behavior of the Driver Command in the 'add driver command' menu.
  • no-properties -- The command requires no properties to be specified, and the instance will simply be created as-is.
  • edit-in-submenu -- The command prefers to show a submenu before the instance is created, controlling the initial configuration of the command instance. This should be used where there is only a single option to specify, where there are only a small number of choices for that option, and where a default selection would be inappropriate.
  • edit-after-add -- The command prefers to be edited in a popover after the instance is created. This should be used where there are multiple options to specify, or where the number of possible choices is large.

Note that the actual creation of the submenu and/or exposure of any properties via a popover are implemented in script. This tag simply tells Trainz what to expect so that it can display the initial menu without having to pay the cost of querying each possible script.

Example Config.txt

TBD


Downloads

Attach sample files here?


Categories

Personal tools