KIND Library
(→Supported Tags) |
|||
| Line 3: | Line 3: | ||
==KIND Hierarchy== | ==KIND Hierarchy== | ||
===Parent Classes=== | ===Parent Classes=== | ||
| − | * | + | * [[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== | ||
Revision as of 21:06, 10 February 2013
KIND Library is a coded module that interacts with other coded modules.
Contents |
KIND Hierarchy
Parent Classes
Child Classes
- none.
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 global script context
- controlset specifies a controlset asset to link to this library
Example Config.txt
Sample config.txt file for a library asset, with the Standard Tags excluded for brevity:
kind "library" script "LibraryScript.gs" 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 "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 include the library's scripts from the asset's script file(s). The asset may use World.GetLibrary() to get a reference to the library, as demonstrated here.
Downloads
Attach sample files here?
