KIND Library - Revision history

Pw3r: /* Supported Tags */

2017-12-11T23:41:59Z

Supported Tags

← Older revision		Revision as of 23:41, 11 December 2017
Line 17:		Line 17:
	always-load-in-global-context 0		always-load-in-global-context 0
	controlset NULLKUID		controlset NULLKUID
			soundscript { }
	tni-library-name ""		tni-library-name ""
	~~soundscript~~		tni-socket-templates { }

	====always-load-in-global-context====		====always-load-in-global-context====
Line 26:		Line 27:
	:Type: KUID		:Type: KUID
	:Desc: Specifies a [[KIND Controlset\|controlset]] asset to link to this library.		:Desc: Specifies a [[KIND Controlset\|controlset]] asset to link to this library.
			====soundscript====
			:Type: [["Soundscript" container\|Soundscript Container]]
			:Desc: Specifies a list of sounds which the library may play from script.
	====tni-library-name====		====tni-library-name====
	:Type: string		:Type: string
	:Desc: Specifies a filename for a [[TrainzNativeInterface]] plugin DLL associated with this asset.		:Desc: Specifies a filename for a [[TrainzNativeInterface]] plugin DLL associated with this asset.
			====tni-socket-templates====
	====~~soundscript~~====		:Type: [[socket-template-list Container]]
	:Type: [[~~"Soundscript" container\|Soundscript~~ Container]]		:Desc: Specifies a list of socket templates for use within TNISocket calls.
	:Desc: Specifies a list of ~~sounds which the library may play from script~~.

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

Pw3r at 04:13, 22 November 2017

2017-11-22T04:13:43Z

← Older revision		Revision as of 04:13, 22 November 2017
Line 14:		Line 14:
	Each Library asset supports the following tags. Each tag is shown here with its default value.		Each Library asset supports the following tags. Each tag is shown here with its default value.

	kind "library"		kind "library"
	always-load-in-global-context 0		always-load-in-global-context 0
	controlset NULLKUID		controlset NULLKUID
	tni-library-name ""		tni-library-name ""
			soundscript

	====always-load-in-global-context====		====always-load-in-global-context====
Line 28:		Line 29:
	:Type: string		:Type: string
	:Desc: Specifies a filename for a [[TrainzNativeInterface]] plugin DLL associated with this asset.		:Desc: Specifies a filename for a [[TrainzNativeInterface]] plugin DLL associated with this asset.

			====soundscript====
			:Type: [["Soundscript" container\|Soundscript Container]]
			:Desc: Specifies a list of sounds which the library may play from script.

	==Example Config.txt==		==Example Config.txt==
	Sample [[config.txt file]] for a library asset, with the Standard Tags excluded for brevity:		Sample [[config.txt file]] for a library asset, with the Standard Tags excluded for brevity:

	kind "library"		kind "library"
	script "LibraryScript.gs"		script "LibraryScript.gs"
	class "LibraryClass"		class "LibraryClass"

	==Downloads==		==Downloads==

Pw3r at 04:09, 22 November 2017

2017-11-22T04:09:39Z

← Older revision		Revision as of 04:09, 22 November 2017
Line 18:		Line 18:
	controlset NULLKUID		controlset NULLKUID
	tni-library-name ""		tni-library-name ""


	====always-load-in-global-context====		====always-load-in-global-context====

Pw3r at 04:09, 22 November 2017

2017-11-22T04:09:14Z

← Older revision		Revision as of 04:09, 22 November 2017
Line 10:		Line 10:
	* [[KIND tni-render-plugin]]		* [[KIND tni-render-plugin]]
	* [[KIND tni-controls-plugin]]		* [[KIND tni-controls-plugin]]


	==Supported Tags==		==Supported Tags==

Pw3r at 04:09, 22 November 2017

2017-11-22T04:09:03Z

← Older revision		Revision as of 04:09, 22 November 2017
Line 1:		Line 1:
	~~KIND~~ Library is a ~~coded module~~ that ~~interacts with other coded modules~~.		Library assets allow content creators to develop script code which can be shared between multiple assets. A library asset is loaded into a session only once, by the first asset to reference it, and all subsequent assets are given a reference to the same library. This enables a clean form of inter-asset communication, because the library can act as a coordinator for data or messages between the assets. A library is typically made to achieve a particular task- where several independent tasks are desired, separate library assets should be created. This allows assets to use only the script code that they require while being isolated from any unrelated script code.

			The simplest way to reference a particular library from an asset script is to use the [[KIND TrainzBaseSpec#script-include-table\|"script-include-table"]] tag in that asset's [[config.txt file]]. This causes the asset to become dependant on the library, and makes it possible to directly [[Script Include Directive\|include]] the library's scripts from the asset's script file(s). The asset may use [[Class World#GetLibrary\|World.GetLibrary()]] to get a reference to the library, as demonstrated [[Class Library#Client Configuration\|here]].

	==KIND Hierarchy==		==KIND Hierarchy==
Line 35:		Line 37:
	script "LibraryScript.gs"		script "LibraryScript.gs"
	class "LibraryClass"		class "LibraryClass"

	~~==Typical Usage==~~
	Library assets allow content creators to develop script code which can be shared between multiple assets. A library asset is loaded into a session only once, by the first asset to reference it, and all subsequent assets are given a reference to the same library. This enables a clean form of inter-asset communication, because the library can act as a coordinator for data or messages between the assets. A library is typically made to achieve a particular task- where several independent tasks are desired, separate library assets should be created. This allows assets to use only the script code that they require while being isolated from any unrelated script code.

	The simplest way to reference a particular library from an asset script is to use the [[KIND TrainzBaseSpec#script-include-table\|"script-include-table"]] tag in that asset's [[config.txt file]]. This causes the asset to become dependant on the library, and makes it possible to directly [[Script Include Directive\|include]] the library's scripts from the asset's script file(s). The asset may use [[Class World#GetLibrary\|World.GetLibrary()]] to get a reference to the library, as demonstrated [[Class Library#Client Configuration\|here]].

	==Downloads==		==Downloads==

Pw3r at 04:07, 22 November 2017

2017-11-22T04:07:03Z

← Older revision		Revision as of 04:07, 22 November 2017
Line 6:		Line 6:

	===Child Classes===		===Child Classes===
	* ~~''none.''~~		* [[KIND tni-render-plugin]]
			* [[KIND tni-controls-plugin]]

Pw3r: /* Supported Tags */

2017-11-22T03:56:21Z

Supported Tags

← Older revision		Revision as of 03:56, 22 November 2017
Line 12:		Line 12:
	Each Library asset supports the following tags. Each tag is shown here with its default value.		Each Library asset supports the following tags. Each tag is shown here with its default value.

	kind "library"		kind "library"
	always-load-in-global-context ""		always-load-in-global-context 0
	controlset ""		controlset NULLKUID
	tni-library-name ""		tni-library-name ""


	====always-load-in-global-context====		====always-load-in-global-context====
	:Type: bool		:Type: bool
	:Desc: ~~if set to '1'~~, library is always loaded to [[New_TrainzScript_Features#Global_script_context\|global script context]]		:Desc: If true, this library is always loaded to the [[New_TrainzScript_Features#Global_script_context\|global script context]].
	====controlset====		====controlset====
	:Type: KUID		:Type: KUID
	:Desc: ~~specifies~~ a [[KIND Controlset\|controlset]] asset to link to this library		:Desc: Specifies a [[KIND Controlset\|controlset]] asset to link to this library.
	====tni-library-name====		====tni-library-name====
	:Type: string		:Type: string
	:Desc: ~~TBD~~		:Desc: Specifies a filename for a [[TrainzNativeInterface]] plugin DLL associated with this asset.

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

Pcas1986: Changed tag description layout to similar pages. Unsure about tag "tni-library-name". Please delete if wrong.

2014-03-15T08:16:49Z

Changed tag description layout to similar pages. Unsure about tag "tni-library-name". Please delete if wrong.

@@ Line 11: / Line 11: @@
 ==Supported Tags==
 Each Library asset supports the following tags. Each tag is shown here with its default value.
-* ''always-load-in-global-context'' if set to '1', library is always loaded to [[New_TrainzScript_Features#Global_script_context|global script context]]
-* ''controlset'' specifies a [[KIND Controlset|controlset]] asset to link to this library
+ kind "library"
 ==Example Config.txt==

Pcas1986: Added sort criterion

2014-02-14T05:01:19Z

Added sort criterion

← Older revision		Revision as of 05:01, 14 February 2014
Line 30:		Line 30:

	==Categories==		==Categories==
	[[Category:Asset KIND]]		[[Category:Asset KIND\|L]]

Windwalkr at 11:06, 10 February 2013

2013-02-10T11:06:23Z

← Older revision		Revision as of 11:06, 10 February 2013
Line 3:		Line 3:
	==KIND Hierarchy==		==KIND Hierarchy==
	===Parent Classes===		===Parent Classes===
	* ~~''none.''~~		* [[KIND TrainzBaseSpec]]

	===Child Classes===		===Child Classes===
Line 20:		Line 20:
	script "LibraryScript.gs"		script "LibraryScript.gs"
	class "LibraryClass"		class "LibraryClass"

			==Typical Usage==
			Library assets allow content creators to develop script code which can be shared between multiple assets. A library asset is loaded into a session only once, by the first asset to reference it, and all subsequent assets are given a reference to the same library. This enables a clean form of inter-asset communication, because the library can act as a coordinator for data or messages between the assets. A library is typically made to achieve a particular task- where several independent tasks are desired, separate library assets should be created. This allows assets to use only the script code that they require while being isolated from any unrelated script code.

			The simplest way to reference a particular library from an asset script is to use the [[KIND TrainzBaseSpec#script-include-table\|"script-include-table"]] tag in that asset's [[config.txt file]]. This causes the asset to become dependant on the library, and makes it possible to directly [[Script Include Directive\|include]] the library's scripts from the asset's script file(s). The asset may use [[Class World#GetLibrary\|World.GetLibrary()]] to get a reference to the library, as demonstrated [[Class Library#Client Configuration\|here]].

	==Downloads==		==Downloads==