TrainzOnline - User contributions [en]

Class Interface

2014-06-13T04:10:10Z

Vanguard11: /* Log */

*[[TrainzScript Language Reference|API Hierarchy]]
**Interface
 

*The Interface class provides scripts with methods to handle the user interface.
 

==Constants & Messages==

===RGB Color Constants===
 
{{TableHeader|width=55%|margin=15px}}
|bgcolor=#EEEEEE|'''Predefined 24 bit Red,Green,Blue color values'''||bgcolor=#EEEEEE|
|-
|width=375|public define int Colour_Red = 0xFF0000||width=225|Red
|-
|public define int Colour_Green = 0x00FF00||Green
|-
|public define int Colour_Blue = 0x0000FF||Blue
|-
|public define int Colour_Yellow = 0xFFFF20||Yellow
|-
|public define int Colour_Cyan = 0xB0C0FF||Cyan
|-
|public define int Colour_White = 0xFFFFFF||White
|-
|public define int Colour_Black = 0x000000||Black
|}
 

===Button Element Indices===
 
{{TableHeader|width=55%|margin=15px}}
|bgcolor=#EEEEEE|'''Constants referring to the buttons on the Driver menu'''||bgcolor=#EEEEEE|
|-
|width=375|public define int ButtonBar_Element_Close = 0||width=225|Exit button
|-
|public define int ButtonBar_Element_Pause = 1||Pause button.
|-
|public define int ButtonBar_Element_Save = 2||Save button.
|-
|public define int ButtonBar_Element_Performance = 3||Performance Settings button.
|-
|public define int ButtonBar_Element_MetricImp = 4||Imperial/Metric button.
|-
|public define int ButtonBar_Element_Find = 5||Find button.
|-
|public define int ButtonBar_Element_Help = 6||On Screen Help button.
|}
 

===Related Messages===
*Messages sent to and from Industry objects are listed below:
 
{{TableHeader|width=55%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''
|-
|[[Interface Messages|Interface-Event]]||MapViewOff||?||Broadcast
|-
|[[Interface Messages|Interface-Event]]||MapViewOn||?||Broadcast
|-
|[[Interface Messages|Interface-Event]]||Mouse-Enter||MapObject||Broadcast
|-
|[[Interface Messages|Interface-Event]]||Mouse-Leave||?||Broadcast
|-
|[[Interface Messages|Interface-Event]]||Set-Metric-Mode||?||Broadcast
|-
|[[Interface Messages|Interface-Event]]||Toggle-Interface||?||Broadcast
|}
 

==Methods==

===AdjustScore===
{{MethodHeader|public void AdjustScore(int delta)}}
;Parameters
*'''delta''' = Positive or negative increment to apply to score.
;Returned Value
*None
;Syntax
AdjustScore(-5);
;Notes
 

===Exception===
{{MethodHeader|public native void Exception(string message)}}
;Parameters
*'''message''' = Message to be displayed and logged when the Exception occurs.
;Returned Value
*None
;Syntax
Interface.Exception("Fatal Error");
;Notes
*Allows an exception to be explicitly raised by a script in the event of a major error condition.
 

===GetDecoupleMode===
{{MethodHeader|public native bool GetDecoupleMode(void)}}
;Parameters
*None
;Returned Value
*Returns the current decoupling mode from the Driver interface.
;Syntax
bool dcMode = Interface.GetDecoupleMode();
;Notes
*The decouple mode can be enabled or disabled when the user clicks on the decouple icon located on the Driver button bar or presses ''Ctrl + D''.
*When the interface is in decouple mode, the decouple icon will be highlighted.
 

===GetDisplayHeight===
{{MethodHeader|public native int GetDisplayHeight(void)}}
;Parameters
*None
;Returned Value
*The height of the user's display in pixels.
;Syntax
int height = Interface.GetDisplayHeight();
;Notes
 

===GetDisplayWidth===
{{MethodHeader|public native int GetDisplayWidth(void)}}
;Parameters
*None
;Returned Value
*The width of the user's display in pixels.
;Syntax
int width = Interface.GetDisplayWidth();
;Notes
 

===GetElementProperty===
{{MethodHeader|public native string GetElementProperty(string elementId, string propertyId)}}
;Parameters
*'''elementId''' = Element to query.
*'''propertyId''' = Property to query.
;Returned Value
*The value of the specified property if it exists, null otherwise.
;Syntax

;Notes
*This method is used to read element properties of browser windows in the Trainz interface such as the Minimap.
*See also [[#SetElementProperty|SetElementProperty()]]
 

===GetInterfaceVisible===
{{MethodHeader|public native bool GetInterfaceVisible(void)}}
;Parameters
*None
;Returned Value
*True if the Driver interface is visible, false otherwise.
;Syntax
bool visible = Interface.GetInterfaceVisible();
;Notes
*The entire Driver mode interface can be hidden from view with the ''F5'' key.
 

===GetMapView===
{{MethodHeader|public native bool GetMapView(void)}}
;Parameters
*None
;Returned Value
*True if the map view window is visible, false otherwise.
;Syntax
bool visible = Interface.GetMapView();
;Notes
*The minimap can be displayed or hidden by pressing ''M'' or ''Control + M'';
 

===GetMessageWindowVisible===
{{MethodHeader|public native bool GetMessageWindowVisible(void)}}
;Parameters
*None
;Returned Value
*True if the message window at the top of the screen is visible, false otherwise.
;Syntax
bool visible = Interface.GetMessageWindowVisible();
;Notes
 

===GetMetricMode===
{{MethodHeader|public native bool GetMetricMode(void)}}
;Parameters
*None
;Returned Value
*True if the interface is displaying metric units, false for imperial.
;Syntax
bool imperial = !Interface.GetMetricMode();
;Notes
 

===GetObjectiveBarVisible===
{{MethodHeader|public native bool GetObjectiveBarVisible()}}
;Parameters
*None
;Returned Value
*True if the Driver objective panel is visible, false otherwise.
;Syntax
bool objectivesShown = Interface.GetObjectiveBarVisible();
;Notes
*The objective bar visibility can be toggled with the ''F6'' key.
 

===GetScore===
{{MethodHeader|public int GetScore(void)}}
;Parameters
*None
;Returned Value
*The current score.
;Syntax
int score = GetScore();
;Notes
 

===GetTimeStamp===
{{MethodHeader|public native string GetTimeStamp(void)}}
;Parameters
*None
;Returned Value
*A real time timestamp in seconds.
;Syntax
string timestamp = Interface.GetTimeStamp();
;Notes
*Returns the current time expressed as seconds elapsed since midnight on January 1, 1970 UTC.
*The return value is a string as Trainzscript does not support any extended integer types.
 

===GetWaybillWindowVisible===
{{MethodHeader|public bool GetWaybillWindowVisible()}}
;Parameters
*None
;Returned Value
*True if the Waybill Window is displayed, false otherwise.
;Syntax
bool waybillVisible = GetWaybillWindowVisible();
;Notes
 

===HasUnseenMessages===
{{MethodHeader|public native bool HasUnseenMessages(void)}}
;Parameters
*None
;Returned Value
*True if there are messages intended for the Driver message window which have not been displayed, false otherwise.
;Syntax
if (Interface.HasUnseenMessages()) Interface.SetMessageWindowVisible(true);
;Notes
*There are unseen messages if the message window is invisible yet messages have been received.
*This is indicated to the user by the highlighted microphone icon on the Driver button bar.
 

===HighlightButtonBarElement===
{{MethodHeader|public native void HighlightButtonBarElement(int buttonIndex, bool state)}}
;Parameters
*'''buttonIndex''' = One of the [[#Button Element Indices|Button Element Index]] values defining the button to highlight.
*'''state''' = True to turn highlighting on, false to turn it off.
;Returned Value
*None
;Syntax
Interface.HighlightButtonBarElement(ButtonBar_Element_Pause,true);
;Notes
*Turns highlighting for a button on the Driver Menu either on or off.
*This method allows a button on the Driver Menu found in the top left corner of the screen to be highlighted as if the mouse cursor was hovering above that button.
*Note that the Driver Menu is not always visible, but you can explicitly show it with [[#ShowDriverButtonMenu|ShowDriverButtonMenu()]]
 

===Log===
{{MethodHeader|public native void Log(string message)}}
;Parameters
*'''message''' = Text string to print to log file.
;Returned Value
*None
;Syntax
Interface.Log("Session ended");
;Notes
*Prints a string of text to the ''jetlog.txt'' log file.
*See also [[#Print|Print()]].
*Disabled by default in TS12. See [[CCG/Modelling: TrainzOptions File]].
 

===LogCallStack===
{{MethodHeader|public native void LogCallStack(string message)}}
;Parameters
*'''message''' = Text string to be included with the call stack and printed to the log file.
;Returned Value
*None
;Syntax
Interface.LogCallStack("Call Stack Contents");
;Notes
 

===LogResult===
{{MethodHeader|public void LogResult(string message)}}
;Parameters
*'''message''' = Text string to be included with the result and printed to the result log.
;Returned Value
*None
;Syntax
Interface.LogResult("Result Appended");
;Notes
 

===Print===
{{MethodHeader|Print()}}
;Parameters
*'''message''' = Text string to print to log file and to the message window.
;Returned Value
*None
;Syntax
Interface.Print("Session ended");
;Notes
*Prints a string of text to the ''jetlog.txt'' log file and echoes it to the messag window.
*See also [[#Log|Log()]].
 

===ResetResults===
{{MethodHeader|public void ResetResults()}}
;Parameters
*None
;Returned Value
*None
;Syntax
Interface.ResetResults();
;Notes
*Clears the result log.
 

===SetAlert===
{{MethodHeader|public native void SetAlert(string message, string iconTexture, float duration, int colour)}}
;Parameters
*'''message''' = Text of message to display.
*'''iconTexture''' = Icon for alert, use an empty string for no icon.
*'''duration''' = Time in seconds to keep the alert displayed.
*'''colour''' = Color of alert text as a 24 bit RGB or as one of the [[#RGB Color Constants|RGB Color Constants]].
;Returned Value
*None
;Syntax
Interface.SetAlert("Train Halted due to leaves on line","",10.0,Interface.Colour_Red);
;Notes
 

===SetDecoupleMode===
{{MethodHeader|public native void SetDecoupleMode(bool enabled)}}
;Parameters
*'''enabled''' = Use true to enable decoupling, false to prevent.
;Returned Value
*None
;Syntax
Interface.SetDecoupleMode(false);
;Notes
*The driver interface decoupling mode can be enabled or disabled using the icon on the Driver button bar or by keypress ''Ctrl + D''.
*When the interface is in decouple mode, the decouple icon will be highlighted.
 

===SetElementProperty===
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, string value)}}
;Parameters
*'''elementId''' = Element to update.
*'''propertyId''' = Property to update.
*'''value''' = New value to set.
;Returned Value
*None
;Syntax
Interface.SetElementProperty(elementId,propertyId,value);
;Notes
*This method is used to modify element properties of browser windows in the Trainz interface such as the Minimap
*See also [[#GetElementProperty|GetElementProperty()]]
 

===SetHelperIconScale===
{{MethodHeader|public native void SetHelperIconScale(float scale)}}
;Parameters
*'''scale''' = Scale factor to apply to on screen junction icons etc, range 0.5..1.0
;Returned Value
*None
;Syntax
Interface.SetHelperIconScale(0.5); // set to 50% of default size
;Notes
 

===SetMapView===
{{MethodHeader|public native void SetMapView(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
Interface.SetMapView(true);
;Notes
*The user can show or hide the map view window by pressing ''M'' or ''Ctrl + M'' on the keyboard
 

===SetMessageWindowVisible===
{{MethodHeader|public native void SetMessageWindowVisible(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
if (Interface.HasUnseenMessages()) Interface.SetMessageWindowVisible(true);
;Notes
*See Also [[#GetMessageWindowVisible|GetMessageWindowVisible()]] and [[#HasUnseenMessages|HasUnseenMessages()]].
 

===SetMetricMode===
{{MethodHeader|public native mode SetMetricMode(bool useMetric)}}
;Parameters
*'''useMetric''' = Use true to select metric units, false to select imperial.
;Returned Value
*None
;Syntax
Interface.SetMetricMode(false);
;Notes
**See also [[#GetMetricMode|GetMetricMode()]].
 

===SetObjective===
{{MethodHeader|public native void SetObjective(string message, string iconTexture)}}
;Parameters
*'''message''' = Text for objective message.
*'''iconTexture''' = Icon to display, use an empty string to omit the icon.
;Returned Value
*None
;Syntax
Interface.SetObjective("Line closed ahead","");
;Notes
*This method will cause the driver objective panel to become visible.
*The User can hide or show the panel at their discretion.
 

===SetObjectiveBarVisible===
{{MethodHeader|public native void SetObjectiveBarVisible(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
Interface.SetObjectiveBarVisible(false);
;Notes
*The Driver objective bar can be toggled between invisible and visible by pressing the ''F6'' key.
 

===SetObjectiveIcon===
{{MethodHeader|public native void SetObjectiveIcon(string iconTexture)}}
;Parameters
*'''iconTexture''' = Icon to display, use an empty string to remove a previous icon.
;Returned Value
*None
;Syntax
Interface.SetObjectiveIcon("");
;Notes
*The image file to use as the icon must be a 32x32 *.tga image.
 

===SetResults===
{{MethodHeader|public native void SetResults(string message)}}
;Parameters
*'''message''' = String to display in results box.
;Returned Value
*None
;Syntax
Interface.SetResults("Result text to display");
;Notes
*Displays the results of a scenario.
*This method will change the activities menu to the results screen and fill out the results box with the given string.
*The results will be visible when the user closes the activity module.
 

===SetScore===
{{MethodHeader|public native void SetScore(string message)}}
;Parameters
*'''message''' = Message to display in the activity bar.
;Returned Value
*None
;Syntax
Interface.SetScore("Score");
;Notes
 

===SetTooltip===
{{MethodHeader|public native void SetTooltip(Browser tooltip)}}
;Parameters
*'''tooltip''' = Browser to use as a tooltip window, if null the current tooltip will be removed.
;Returned Value
*None
;Syntax
Interface.SetTooltip(tooltip);
;Notes
*Sets the tooltip that should follow the mouse around.
*This method specifies that tooltip should follow the mouse.
*Any existing tooltip will be replaced.
*If this Browser is released, it will be removed automatically.
 

===SetWaybillWindowVisible===
{{MethodHeader|public void SetWaybillWindowVisible(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
Interface.SetWaybillWindowVisible(false);
;Notes
 

===ShowDriverButtonMenu===
{{MethodHeader|public native void ShowDriverButtonMenu(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
Interface.ShowDriverButtonMenu(true);
;Notes
*Showing and hiding is not immediate, there may be a delay before it slides on or off.
 

===ShowObjective===
{{MethodHeader|public native void ShowObjective(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
Interface.ShowObjective(true);
;Notes
 

===ShowOnScreenHelp===
{{MethodHeader|public native void ShowOnScreenHelp(bool visible)}}
;Parameters
*'''visible''' = Use true to display and false to hide.
;Returned Value
*None
;Syntax
Interface.ShowOnScreenHelp(true);
;Notes
*This method performs the same function as the ''Show On-screen Help'' menu item in Driver which is used to display or hide names on map objects such as junctions.
 

===WarnObsolete===
{{MethodHeader|public native void WarnObsolete(string warning)}}
;Parameters
*'''warning''' = Message to log to ''jetlog.txt'' at the first time this method is called.
;Returned Value
*None
;Syntax
Interface.WarnObsolete("Method is obsolete");
;Notes
*Generates a runtime warning that a given function or usage is obsolete.
*The warning goes to the JetLog.txt file and is not visible to the casual user within Trainz.
*Only one warning is generated for any given warning string.
 

==Code Examples==
 

==Related Methods==
 

==Categories==
[[Category:Script Class]]

CCG/Modelling: TrainzOptions File

2014-06-13T04:07:06Z

Vanguard11: /* TrainzOptions File */

==TrainzOptions File==
The '''trainzoptions.txt''' file specifies a number of settings for Trainz, and for a default installation of it is found in the C:\Program Files\Auran\TS2009 directory. It is a standard text file and may be edited.

'''1.''' As a creator, you may have an asset placed in a map, and you would like to find the creator for that asset.

While the asset name may be shown in the Surveyor menu and then the item located in CMP, it is sometimes useful to have the kuid of the asset displayed in the bottom right corner of the Surveyor screen when you select the asset, (use the get tool in the Surveyor menu for that object type).

By adding the following line to the trainzclassicoptions.txt file, the kuids of a placed and selected object will displayed in Surveyor:
:-showkuids

'''2.''' When testing a traincar asset or track configuration in Driver, sometimes it is helpful if the locomotive moves a faster speed than normal. This is achieved by adding the following line to the trainzcoptions.txt file.
:-debug

In Driver, use the arrow keys or speed dial to set the speed and direction, then hold down the Shift key. The train will move around the track at high speed.

'''3.''' When creating, Trainz has to be loaded regularly to test the models. To speed up loading time, you can disable the introduction screens by entering the line in the trainzoptions.txt file:
:-intro=disable

'''4.''' To determine the coordinates for the viewpoints to be used for a cabin cameralist, five values are required:
:0,0,0,0,0 =left/right, front/back, up/down, yaw, pitch.

To determine these variables, add the following line to trainzoptions.txt file.
:-freeintcam

Pan around the interior in Driver, using arrow keys and mouse. Viewing co-ordinates are displayed at the bottom left of the screen. Make sure you include any negative sign for coordinates where appropriate when entering them in CCP for the config.txt file.

'''5.''' As of TS12, writes to the Jetlog.txt file through Interface.Print() and Interface.Log() calls are disabled. If you are debugging your scripts, you can enable writes to the Jetlog.txt by enabling the following lines to trainzoptions.txt file.
:-enablescriptlogging
:-enablescriptmessagelogging

These will enable writes from Interface.Log() and Interface.Print() respectively.

Don't forget to start the commands with a '''hyphen (-)''' and save the file.

[[CCG/Modelling: Chunky Mesh Track|Previous Page]] . . . . [[CCG/Modelling: ViewPoints in Surveyor|Next Page]]

==Return to CCG Index==
[[Content Creator's Guide]]

CCG/Modelling: TrainzOptions File

2014-06-13T04:06:47Z

Vanguard11: /* TrainzOptions File */

CCG/Modelling: TrainzOptions File

2014-06-13T04:06:07Z

Vanguard11: /* TrainzOptions File */

==TrainzOptions File==
The '''trainzoptions.txt''' file specifies a number of settings for Trainz, and for a default installation of it is found in the C:\Program Files\Auran\TS2009 directory. It is a standard text file and may be edited.

'''1.''' As a creator, you may have an asset placed in a map, and you would like to find the creator for that asset.

While the asset name may be shown in the Surveyor menu and then the item located in CMP, it is sometimes useful to have the kuid of the asset displayed in the bottom right corner of the Surveyor screen when you select the asset, (use the get tool in the Surveyor menu for that object type).

By adding the following line to the trainzclassicoptions.txt file, the kuids of a placed and selected object will displayed in Surveyor:
:-showkuids

'''2.''' When testing a traincar asset or track configuration in Driver, sometimes it is helpful if the locomotive moves a faster speed than normal. This is achieved by adding the following line to the trainzcoptions.txt file.
:-debug

In Driver, use the arrow keys or speed dial to set the speed and direction, then hold down the Shift key. The train will move around the track at high speed.

'''3.''' When creating, Trainz has to be loaded regularly to test the models. To speed up loading time, you can disable the introduction screens by entering the line in the trainzoptions.txt file:
:-intro=disable

'''4.''' To determine the coordinates for the viewpoints to be used for a cabin cameralist, five values are required:
:0,0,0,0,0 =left/right, front/back, up/down, yaw, pitch.

To determine these variables, add the following line to trainzoptions.txt file.
:-freeintcam

Pan around the interior in Driver, using arrow keys and mouse. Viewing co-ordinates are displayed at the bottom left of the screen. Make sure you include any negative sign for coordinates where appropriate when entering them in CCP for the config.txt file.

'''5.''' As of TS12, writes to the Jetlog.txt file through Interface.Print() and Interface.Log() calls are disabled. If you are debugging your scripts, you can enable writes to the Jetlog.txt by enabling the following linex to trainzoptions.txt file.
:-enablescriptlogging
:-enablescriptmessagelogging

These will enable writes from Interface.Log() and Interface.Print() respectively.

Don't forget to start the commands with a '''hyphen (-)''' and save the file.

[[CCG/Modelling: Chunky Mesh Track|Previous Page]] . . . . [[CCG/Modelling: ViewPoints in Surveyor|Next Page]]

==Return to CCG Index==
[[Content Creator's Guide]]

"mesh-table" container

2011-04-01T05:17:30Z

Vanguard11: /* orientation */

The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content Types]].

The mesh-table is a list of mesh subcontainers with no standalone tags. Each mesh subcontainer uses the following format. Tags are parsed in a standardised format, but not all [[Content Types]] support the full range of tags. Each mesh derives its name from the subcontainer's tag name. These names are used to refer to specific meshes from within the mesh-table and also from script.

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

mesh-asset <NULLKUID>
mesh ""
anim ""
lod-level 255
mesh-season 255
att ""
att-parent ""
opacity 1.0
position 0,0,0
orientation 0,0,0
auto-create 0
use-parent-bounds 0
animation-loop-speed 0
light 1
critical-animation 1
effects
{
}
night-mesh-base ""

====mesh-asset====
Allows assets to be used as 'mesh libraries', the following container specifies that the mesh required (and its optional animation) is located in the root folder of <kuid:1234:5678>. CMP does not check for the existence of these files so you must ensure that they are present before using this tag.

mesh-table {
submesh {
mesh-asset <kuid:1234:5678>
mesh "meshname.im"
anim "meshname.kin"
att "a.point"
att-parent "default"
}
}

====mesh====
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

====anim====
The animation file (.kin) exported from 3dsmax. This may include a sub-path.

====lod-level====
The object LOD level at which this mesh is displayed. The default value (255) indicates that this mesh is visible at all detail levels. See also [[KIND Mesh]] for the 'mesh-detail-level' tag.

====mesh-season====
The season index for which this mesh is displayed. The default value (255) indicates that this mesh is visible in all seasons. See also [["Season-selector" container]].

====att====
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

====att-parent====
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

====opacity====
opacity x (float 0.0 - 1.0 default 1.0)

Specifies the overall transparency of a mesh. Values other than 0.0 or 1.0 employ alpha blending and a value of 0.0 has the same effect as hiding the mesh.

Note that this tag is buggy in TS2009 prior to SP4.

====position====
position X,Y,Z (in metres, default 0,0,0)

Specifies the location of a mesh relative to its insertion point.

====orientation====
orientation X,Y,Z (radians default 0,0,0)

Allows a submesh to be rotated relative to its insertion point. To reverse a mesh by 180 degrees about the Z axis, add the tag:

orientation 0,0,3.14159

A coconut is awarded to the programmer who decided that the parameters to this tag should be in radians.

====auto-create====
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

====use-parent-bounds====
When enabled, this tag indicates that render culling should occur using the whole object's bounding box rather than this mesh's bounding box. Bounding boxes on individual meshes may not update correctly when animation moves the object's geometry any significant distance from the bind position. This flag can help mitigate such effects, at a tiny performance penalty.

====animation-loop-speed====
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.

====light====
''TBD'

====critical-animation====
"critical-animation" indicates that this mesh's animation generates events which are critical to the script system's behavior. If your asset is not scripted, does not use scripted animation events, or only uses the events for display purposes and will not break if the occasional event is missed, this tag should be set to ''false''. Leaving this flag set to ''true'' is a '''significant''' performance penalty.

====night-mesh-base====
This night mesh is linked to the specified mesh and is visible only at night. It is invisible if the specified mesh is invisible, (if the auto-create 0 line were used so the specified mesh can be controlled by script).

=Effects Container=
The effects container also contains a list of effect subcontainers. The effect subcontainers support the following generic tags.

kind ""
name ""

The effect subcontainers support additional tags depending on the effect kind. The following effect kinds are supported:

* [[Corona Effect]]
* [[Name Effect]]
* [[Attachment Effect]]
* [[Animation Effect]]
* [[Texture-Replacement Effect]]

=Mesh-Table Example=
The following is an example of a simple mesh-table which implements two levels of detail.

mesh-table
{
default-lod0
{
mesh "example-lod0.im"
auto-create 1
lod-level 0
}
default-lod1
{
mesh "example-lod1.im"
auto-create 1
lod-level 1
}
}

[[Category:Config Container]]