KIND tni-controls-plugin - Revision history

Pw3r: /* controllers */

2017-11-22T05:43:41Z

controllers

← Older revision		Revision as of 05:43, 22 November 2017
Line 21:		Line 21:

	====controllers====		====controllers====
	:Type: [[controller-device-list_container]]		:Type: [[controller-device-list_container\|controller-device-list]]
	:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The format for the controller subcontainers is documented separately [[controller-device-list_container\|here]].		:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The format for the controller subcontainers is documented separately [[controller-device-list_container\|here]].

Pw3r: /* controllers */

2017-11-22T05:35:08Z

controllers

← Older revision		Revision as of 05:35, 22 November 2017
Line 22:		Line 22:
	====controllers====		====controllers====
	:Type: [[controller-device-list_container]]		:Type: [[controller-device-list_container]]
	:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The format for the ~~controllers themselves~~ is documented separately [[controller-device-list_container\|here]].		:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The format for the controller subcontainers is documented separately [[controller-device-list_container\|here]].

	==Example Config.txt==		==Example Config.txt==

Pw3r: /* controllers */

2017-11-22T05:34:26Z

controllers

← Older revision		Revision as of 05:34, 22 November 2017
Line 22:		Line 22:
	====controllers====		====controllers====
	:Type: [[controller-device-list_container]]		:Type: [[controller-device-list_container]]
	:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The ~~specification~~ for the controllers themselves ~~are~~ documented separately [[controller-device-list_container\|here]].		:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The format for the controllers themselves is documented separately [[controller-device-list_container\|here]].

	==Example Config.txt==		==Example Config.txt==

Pw3r: /* Supported Tags */

2017-11-22T05:16:37Z

Supported Tags

← Older revision		Revision as of 05:16, 22 November 2017
Line 10:		Line 10:
	Each tni-controls-plugin asset supports the following tags:		Each tni-controls-plugin asset supports the following tags:

	kind "tni-controls-plugin"		kind "tni-controls-plugin"
	tni-library-name ""		tni-library-name ""
	controllers		controllers
	{		{

Pw3r: /* tni-library-name */

2017-11-22T04:40:12Z

tni-library-name

← Older revision		Revision as of 04:40, 22 November 2017
Line 18:		Line 18:
	====tni-library-name====		====tni-library-name====
	:Type: string		:Type: string
	:Desc: Specifies the filename of the [[~~TrainzNativeInterface~~\|plugin DLL]] to load (minus the platform-specific file extension). This plugin is expected find hardware controls at the OS level, and ~~provide an interface between them and~~ [[TNI_Controls_Interface\|TNIControls]].		:Desc: Specifies the filename of the [[TNI_Core_Interface\|plugin DLL]] to load (minus the platform-specific file extension). This plugin is expected find hardware controls at the OS level, and direct input from that device to [[TNI_Controls_Interface\|TNIControls]].

	====controllers====		====controllers====

Pw3r: Created page with "KIND tni-controls-plugin is an asset type which provides an interface to a custom hardware control device, via TrainzNativeInterface. This asset type requires native c..."

2017-11-22T04:38:48Z

Created page with "KIND tni-controls-plugin is an asset type which provides an interface to a custom hardware control device, via TrainzNativeInterface. This asset type requires native c..."

New page

[[KIND tni-controls-plugin]] is an asset type which provides an interface to a custom hardware control device, via [[TrainzNativeInterface]]. This asset type requires native code support and it's use is restricted to authorised TNI content creators only.

==KIND Hierarchy==
===Parent Classes===
* [[KIND Library]]
===Child Classes===
* ''none''

==Supported Tags==
Each tni-controls-plugin asset supports the following tags:

kind "tni-controls-plugin"
tni-library-name ""
controllers
{
}

====tni-library-name====
:Type: string
:Desc: Specifies the filename of the [[TrainzNativeInterface|plugin DLL]] to load (minus the platform-specific file extension). This plugin is expected find hardware controls at the OS level, and provide an interface between them and [[TNI_Controls_Interface|TNIControls]].

====controllers====
:Type: [[controller-device-list_container]]
:Desc: Specifies the various controller types supported by this plugin (e.g. a RailDriver device, a joystick, or a gamepad). The specification for the controllers themselves are documented separately [[controller-device-list_container|here]].

==Example Config.txt==
Sample [[config.txt file]] for a tni-controls-plugin asset, with some standard tags excluded for brevity:

kuid <kuid:401543:1080>
kind "tni-controls-plugin"
trainz-build 4.6
username "RailDriver Plugin"
tni-library-name "TNIRailDriver"
category-class "YL"
description "TNI plugin for RailDriver controller"

controllers
{
raildriver
{
name-token "device-name-raildriver"
desc-token "device-desc-raildriver"

controls
{
reverser
{
name-token "control-name-reverser"
type "lever"
}
throttle
{
name-token "control-name-throttle"
type "lever"
}

''etc.''
}
}
}

string-table
{
device-name-raildriver "RailDriver Desktop Cab Controller"
device-desc-raildriver "RailDriver Desktop Train Cab Controller, with prototypical levers and controls for the ultimate interface to computer-based railroading."
control-name-reverser "RailDriver Reverser"
control-name-throttle "RailDriver Throttle"

''etc.''
}

==Categories==
[[Category:Asset KIND|T]]