Controls container - Revision history

Pw3r at 05:02, 22 November 2017

2017-11-22T05:02:08Z

← Older revision		Revision as of 05:02, 22 November 2017
Line 24:		Line 24:

	====event====		====event====
	:Type: ~~text~~		:Type: string
	:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If the 'trigger-on-up' tag is set to true 'Message.minor' will be set to "<event>-up" when the key is released.		:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If the 'trigger-on-up' tag is set to true 'Message.minor' will be set to "<event>-up" when the key is released.

	====default-keys====		====default-keys====
	:Type: ~~text~~		:Type: string
	:Desc: A comma separated list of the default ~~keys~~ to map to this control. ~~Use "null" if no default keys are to be set, if~~ multiple keys are required separate ~~the keys~~ with a space, e.g. "shift n".		:Desc: A comma separated list of the default key binds to map to this control. If multiple keys are required for a single bind, separate them with a space, e.g. "shift n".
	:~~To note~~ : default~~-keys are only available~~ for ~~built-in objects (source : Mr Windwalker himself !)~~. ~~For customized controlset~~, ~~the hotkey should be defined via Start Trainz\Menu\Settings\Control Settings~~		:Note: Trainz will only automatically map default key bindings for builtin content. Nonetheless, it is recommended that content creators use this field to provide "suggested" default bindings where appropriate.

	====context====		====context====
	:Type: ~~text~~		:Type: context-list (game-context.txt)
	:Desc: A semicolon separated list of contexts under which the control should be active, e.g. ~~"surveyor;driver".~~		:Desc: A semicolon separated list of contexts under which the control should be active, as follows:
	:~~Possible values~~: ~~menu,~~ surveyor, surveyor-topology, surveyor-paint, surveyor-objects, surveyor-track, ~~surveyor-trains~~, surveyor-tools, surveyor-layers, driver, driver-cab, driver-cab-steam~~, driver~~-~~dcc~~, ~~railyard~~		:* menu - Key will activate in any of the in-game menu screens (e.g. the Routes menu)
			:* railyard - Key will activate in Railyard
			:* surveyor - Key will activate in Surveyor, regardless of active tools
			:* surveyor-topology - Key will activate in Surveyor while in topology editing mode
			:* surveyor-paint - Key will activate in Surveyor while in terrain painting mode
			:* surveyor-objects - Key will activate in Surveyor while in scenery edit modes (object placement, or scenery spline placement)
			:* surveyor-track - Key will activate in Surveyor while in track edit modes (track placement, trackside object placement, or trackmark placement)
			:* surveyor-tools - Key will activate in Surveyor while in tool edit mode (cameras, rulers, copy, paste, etc)
			:* surveyor-layers - Key will activate in Surveyor while in layers edit mode
			:* surveyor-trains - Key will activate in Surveyor while in train/consist edit mode
			:* driver - Key will activate while in Driver, regardless of control mode
			:* driver-dcc - Key will activate while in Driver, while in DCC control mode
			:* driver-cab - Key will activate while in Driver, while in Cab control mode with a diesel/electric loco
			:* driver-cab-steam - Key will activate while in Driver, while in Cab control mode with a steam loco

	====reassignable====		====reassignable====

Pw3r at 04:46, 22 November 2017

2017-11-22T04:46:50Z

← Older revision		Revision as of 04:46, 22 November 2017
Line 4:		Line 4:
	The controls container is a list of control subcontainers with no standalone tags. Each control subcontainer uses the following format.		The controls container is a list of control subcontainers with no standalone tags. Each control subcontainer uses the following format.

	name-token ""		name-token ""
	desc-token ""		desc-token ""
	event ""		event ""
	default-keys ""		default-keys ""
	context ""		context ""
	reassignable 1		reassignable 1
	trigger-on-up 0		trigger-on-up 0
	trigger-on-down 1		trigger-on-down 1
	trigger-on-held 1		trigger-on-held 1
			trigger-mode-analog 0

	====name-token====		====name-token====
Line 51:		Line 52:
	:Type: bool		:Type: bool
	:Desc: Whether the control event should repeatedly trigger while a key remains held.		:Desc: Whether the control event should repeatedly trigger while a key remains held.

			====trigger-mode-analog====
			:Type: bool
			:Desc: Sets the control as being for 'analog' use. For example, a throttle lever control, which has non-boolean input values. Requires a minimum trainz-build of 4.6.

Pw3r at 04:00, 22 November 2017

2017-11-22T04:00:38Z

← Older revision		Revision as of 04:00, 22 November 2017
Line 1:		Line 1:
	The [[controls_container\|controls container]] is a top-level [[config.txt file]] entry used by [[KIND_Controlset\|controlset]] assets.		The [[controls_container\|controls container]] is a top-level [[config.txt file]] entry used by [[KIND_Controlset\|controlset]] assets.

			==Supported Tags==
	The controls container is a list of control subcontainers with no standalone tags. Each control subcontainer uses the following format.		The controls container is a list of control subcontainers with no standalone tags. Each control subcontainer uses the following format.

	~~==Supported Tags==~~
	~~Each control subcontainer supports the following tags. Each tag is shown here with its default value.~~

	name-token ""		name-token ""

Vincentrh: /* default-keys */

2017-04-06T14:00:11Z

default-keys

← Older revision		Revision as of 14:00, 6 April 2017
Line 32:		Line 32:
	:Type: text		:Type: text
	:Desc: A comma separated list of the default keys to map to this control. Use "null" if no default keys are to be set, if multiple keys are required separate the keys with a space, e.g. "shift n".		:Desc: A comma separated list of the default keys to map to this control. Use "null" if no default keys are to be set, if multiple keys are required separate the keys with a space, e.g. "shift n".
			:To note : default-keys are only available for built-in objects (source : Mr Windwalker himself !). For customized controlset, the hotkey should be defined via Start Trainz\Menu\Settings\Control Settings

	====context====		====context====

Pw3r: /* event */

2011-10-19T05:32:47Z

event

← Older revision		Revision as of 05:32, 19 October 2011
Line 27:		Line 27:
	====event====		====event====
	:Type: text		:Type: text
	:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If the 'trigger-on-up' is set to true 'Message.minor' will be set to "<event>-up" when the key is released.		:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If the 'trigger-on-up' tag is set to true 'Message.minor' will be set to "<event>-up" when the key is released.

	====default-keys====		====default-keys====

Pw3r: /* event */

2011-10-19T05:32:10Z

event

← Older revision		Revision as of 05:32, 19 October 2011
Line 27:		Line 27:
	====event====		====event====
	:Type: text		:Type: text
	:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If trigger-on-up is ~~specified~~ Message.minor will be set to "<event>-up" when the key is released.		:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If the 'trigger-on-up' is set to true 'Message.minor' will be set to "<event>-up" when the key is released.

	====default-keys====		====default-keys====

Pw3r: /* event */

2011-10-19T05:27:56Z

event

← Older revision		Revision as of 05:27, 19 October 2011
Line 27:		Line 27:
	====event====		====event====
	:Type: text		:Type: text
	:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", event) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] (library/interior assets can specify a control set using the "controlset" tag).		:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", <event>) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] asset (library/interior assets can specify a control set using the "controlset" tag). If trigger-on-up is specified Message.minor will be set to "<event>-up" when the key is released.

	====default-keys====		====default-keys====

Pw3r: /* event */

2011-10-19T05:25:38Z

event

← Older revision		Revision as of 05:25, 19 October 2011
Line 27:		Line 27:
	====event====		====event====
	:Type: text		:Type: text
	:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("~~Interface-Event~~", event) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] (library/interior assets can specify a control set using the "controlset" tag.		:Desc: The name of the event to trigger when the control is triggered. A script message of the format ("ControlSet", event) will be posted to any linked [[KIND Library\|library]] or [[KIND Interior\|interior]] (library/interior assets can specify a control set using the "controlset" tag).

	====default-keys====		====default-keys====

Pw3r: /* context */

2011-10-19T05:03:20Z

context

← Older revision		Revision as of 05:03, 19 October 2011
Line 36:		Line 36:
	:Type: text		:Type: text
	:Desc: A semicolon separated list of contexts under which the control should be active, e.g. "surveyor;driver".		:Desc: A semicolon separated list of contexts under which the control should be active, e.g. "surveyor;driver".
	:Possible values: menu, surveyor, surveyor-topology, surveyor-paint, surveyor-objects, surveyor-track, surveyor-trains, surveyor-tools, surveyor-layers, ~~river~~, driver-cab, driver-cab-steam, driver-dcc, railyard		:Possible values: menu, surveyor, surveyor-topology, surveyor-paint, surveyor-objects, surveyor-track, surveyor-trains, surveyor-tools, surveyor-layers, driver, driver-cab, driver-cab-steam, driver-dcc, railyard

	====reassignable====		====reassignable====

Pw3r: /* Example controls container */

2011-10-19T04:19:20Z

Example controls container

← Older revision		Revision as of 04:19, 19 October 2011
Line 56:		Line 56:

	==Example controls container==		==Example controls container==
	See [[KIND_Controlset]].		See [[KIND_Controlset#Example_Config.txt\| controlset]].

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