https://wiki.trainzsimulator.com/api.php?action=feedcontributions&feedformat=atom&user=CiceronmtTrainzOnline - User contributions [en]2026-11-05T08:52:46ZUser contributionsMediaWiki 1.46.2https://wiki.trainzsimulator.com/index.php?title=Class_World&diff=33215Class World2022-07-29T15:42:21Z<p>Ciceronmt: /* GetNamedObjectList */</p>
<hr />
<div>*[[TrainzScript Library Reference|API Hierarchy]]<br />
**World (world.gs)<br />
<br><br />
*World is a static class used to access various aspects of the Trainz environment.<br />
<br><br />
<br />
==Constants==<br />
*These constants are used to define various values and can be used as mnenomics.<br />
*If accessed from scripts the values must be prefixed ''World.'', for example:<br />
World.SetWeather(World.WEATHER_TYPE_LIGHT_SNOW,World.WEATHER_CHANGEABILITY_PERIODIC);<br />
<br><br />
<br />
===Camera View Modes===<br />
----<br />
*These values can be used either to choose the current camera viewing mode through World.[[#SetCameraMode|SetCameraMode()]], or to restrict certain camera modes from being accessed through methods such as World.[[#SetCamera|SetCamera()]].<br />
<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CAMERA_INTERNAL = 1||Internal cabin camera view.<br />
|-<br />
|public define int CAMERA_EXTERNAL = 2||External train camera view<br />
|-<br />
|public define int CAMERA_TRACKING = 4||External tracking camera view.<br />
|-<br />
|public define int CAMERA_ROAMING = 128||Roaming camera view.<br />
|}<br />
<br><br />
<br />
===Camera Flags===<br />
----<br />
*These flags are used in addition to the Camera Mode Flags to allow or disallow specific camera actions. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CAMERA_SWITCH_VIEWS = 8||User permitted to swap between the camera views.<br />
|-<br />
|public define int CAMERA_SWITCH_VEHICLES = 16||User permitted to swap vehicles within the current train.<br />
|-<br />
|public define int CAMERA_SWITCH_TRAINS = 32||User permitted to swap to other trains which are in the consist menu.<br />
|-<br />
|public define int CAMERA_LOCKED = 64||User is NOT permitted to adjust camera (i.e. zoom, pan etc.).<br />
|-<br />
|public define int CAMERA_NORMAL = * ||Normal camera mode where everything is permitted.<br />
|-<br />
|colspan=2|<sup>* NOTE: CAMERA_NORMAL = CAMERA_INTERNAL | CAMERA_EXTERNAL | CAMERA_TRACKING | CAMERA_SWITCH_VIEWS | CAMERA_SWITCH_VEHICLES | CAMERA_SWITCH_TRAINS</sup><br />
|}<br />
<br><br />
<br />
===Weather Type Constants===<br />
----<br />
*Define the current state of the weather in Trainz. <br />
*A variety of weather conditions are supported and can be changed by using one of these values with the World.[[#SetWeather|SetWeather()]] method. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int WEATHER_TYPE_CLEAR = 0||Clear weather, no clouds, rain or snow.<br />
|-<br />
|public define int WEATHER_TYPE_CLOUDY = 1||Cloudy weather, no rain.<br />
|-<br />
|public define int WEATHER_TYPE_DRIZZLE = 2||Drizzle, light rain.<br />
|-<br />
|public define int WEATHER_TYPE_RAIN = 3||Rainy weather.<br />
|-<br />
|public define int WEATHER_TYPE_STORMY = 4||Stormy weather that includes lightning and thunder.<br />
|-<br />
|public define int WEATHER_TYPE_LIGHT_SNOW = 5||Snowing lightly.<br />
|-<br />
|public define int WEATHER_TYPE_MEDIUM_SNOW = 6||Medium level snow fall.<br />
|-<br />
|public define int WEATHER_TYPE_HEAVY_SNOW = 7||Heavy snow fall.<br />
|}<br />
<br><br />
<br />
===Weather Changeability Constants===<br />
----<br />
*Define the changeability settings for the weather. <br />
*Weather changeability refers to variability of weather conditions rather than to a specific weather type.<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int WEATHER_CHANGEABILITY_NONE = 0||Weather remains static.<br />
|-<br />
|public define int WEATHER_CHANGEABILITY_PERIODIC = 1||Periodic changes in weather.<br />
|-<br />
|public define int WEATHER_CHANGEABILITY_EXTREME = 2||Extreme and frequent changes in weather. <br />
|}<br />
<br><br />
<br />
===Time Values===<br />
----<br />
*Time constants defined in seconds.<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TIME_SECOND = 1.0f||One second.<br />
|-<br />
|public define float TIME_MINUTE = TIME_SECOND * 60.0f||One minute, 60.0 seconds.<br />
|-<br />
|public define float TIME_HOUR = TIME_MINUTE * 60.0f||One hour, 60.0 minutes, 3600.0 seconds.<br />
|-<br />
|public define float TIME_DAY = TIME_HOUR * 24.0f||One day, 24 hours, 1440.0 minutes, 86400.0 seconds.<br />
|}<br />
<br><br />
<br />
===Time Rate Constants===<br />
----<br />
*Values that define the time rates relative to normal time. <br />
*These constants can be used to set the time rate that Trainz runs out through the World.[[#SetGameTimeRate|SetGameTimeRate()]] method. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TIME_RATE_1X = 0||Real time (i.e. time in Trainz passes at the same rate as in the real world)<br />
|-<br />
|public define int TIME_RATE_2X = 1||Time passes at twice normal speed.<br />
|-<br />
|public define int TIME_RATE_4X = 2||<br />
|-<br />
|public define int TIME_RATE_8X = 3||<br />
|-<br />
|public define int TIME_RATE_16X = 4||<br />
|-<br />
|public define int TIME_RATE_32X = 5||<br />
|-<br />
|public define int TIME_RATE_60X = 6||<br />
|-<br />
|public define int TIME_RATE_120X = 7||<br />
|-<br />
|public define int TIME_RATE_240X = 8||<br />
|-<br />
|public define int TIME_RATE_360X = 9||<br />
|-<br />
|public define int TIME_RATE_480X = 10||<br />
|-<br />
|public define int TIME_RATE_720X = 11||<br />
|-<br />
|public define int TIME_RATE_960X = 12||<br />
|-<br />
|public define int TIME_RATE_1200X = 13||<br />
|-<br />
|public define int TIME_RATE_1440X = 14||<br />
|}<br />
<br><br />
<br />
===Layer Type Constants===<br />
----<br />
*These constants can be used for querying route/session layers via [[#GetLayerList|GetLayerList]] and [[#GetLayerType|GetLayerType]].<br />
*<font color=red>Added in TRS19?</font><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int LAYER_INVALID = 0||<br />
|-<br />
|public define int LAYER_ROUTE = 1||<br />
|-<br />
|public define int LAYER_SESSION = 2||<br />
|-<br />
|public define int LAYER_BOTH = 3||<br />
|}<br />
<br><br />
<br />
===World Editing Mode Constants===<br />
----<br />
*These constants can be used to set editing modes through World.[[#SetWorldEditModeEnabled|SetWorldEditModeEnabled()]].<br />
*<font color=red>Added in TRS19?</font><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int PERMIT_EDIT_NONE = 0x0||<br />
|-<br />
|public define int PERMIT_EDIT_TOPOLOGY = 0x1||<br />
|-<br />
|public define int PERMIT_EDIT_PAINT = 0x2||<br />
|-<br />
|public define int PERMIT_EDIT_SCENERYOBJECTS = 0x4||<br />
|-<br />
|public define int PERMIT_EDIT_SCENERYSPLINES = 0x8||<br />
|-<br />
|public define int PERMIT_EDIT_TRACKSPLINES = 0x10||<br />
|-<br />
|public define int PERMIT_EDIT_TRACKSIDEOBJECTS = 0x20||<br />
|-<br />
|public define int PERMIT_EDIT_TRACKMARKS = 0x40||<br />
|-<br />
|public define int PERMIT_EDIT_TOOLS = 0x80||<br />
|-<br />
|public define int PERMIT_EDIT_WORLD = 0x100||<br />
|-<br />
|public define int PERMIT_EDIT_LAYERS = 0x200||<br />
|-<br />
|public define int PERMIT_EDIT_TRAINS = 0x400||<br />
|-<br />
|public define int PERMIT_EDIT_CONSISTS = 0x800||<br />
|-<br />
|public define int PERMIT_EDIT_ALL = -1||<br />
|}<br />
<br><br />
<br />
===Trainz Modules===<br />
----<br />
*Trainz module mode constants. <br />
*These values define the various module environments that Trainz can be in. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int NO_MODULE = 0||Trainz not running in a module.<br />
|-<br />
|public define int SURVEYOR_MODULE = 1||Trainz is currently running in Surveyor.<br />
|-<br />
|public define int DRIVER_MODULE = 2||Trainz is currently running in Driver.<br />
|}<br />
<br> <br />
<br />
==Related Messages==<br />
* [[TrainzScript Message Reference]]<br><br />
* [[Camera Messages]]<br><br />
* [[Interface Messages]]<br><br />
* [[ModuleInit Message]]<br><br />
<br><br />
<br />
==AddDriverCharacter==<br />
{{MethodHeader|public native [[Class DriverCharacter|DriverCharacter]] AddDriverCharacter([[Class Asset|Asset]] driverCharacterAsset)}}<br />
;Parameters<br />
*'''driverCharacterAsset''' = Asset containing character to be added.<br />
;Returned Value<br />
*Reference to the DriverCharacter if successful, null otherwise.<br />
;Syntax<br />
DriverCharacter Casey = World.AddDriverCharacter(CaseyJones);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==AddDriverCommand==<br />
{{MethodHeader|public native [[Class DriverCommand|DriverCommand]] AddDriverCommand([[Class Asset|Asset]] driverCommandAsset)}}<br />
;Parameters<br />
*'''driverCommandAsset''' = Asset containing command to be added.<br />
;Returned Value<br />
*Reference to the DriverCommand if successful, null otherwise.<br />
;Syntax<br />
DriverCommand GoFaster = World.AddDriverCommand(accelerate);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==CancelCurrentEditingMode==<br />
{{MethodHeader|public native void CancelCurrentEditingMode(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.CancelCurrentEditingMode();<br />
;Notes<br />
* Cancels out of any player entered editing mode, if relevant. This should only normally be called as a result of direct player action.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==CreateBehavior==<br />
{{MethodHeader|public native [[Class ScenarioBehavior|ScenarioBehavior]] CreateBehavior([[Class KUID|KUID]] kuid, [[Class Soup|Soup]] initialProperties)}}<br />
;Parameters<br />
*'''kuid''' = KUID of scenario.<br />
'''initialProperties''' = Soup object containing initial properties for scenario.<br />
;Returned Value<br />
*Reference to the ScenarioBehavior created if successful, null otherwise.<br />
;Syntax<br />
ScenarioBehavior scenario = World.CreateBehavior(scenarioAsset, scenarioSoup);<br />
;Notes<br />
*The returned ScenarioBehavior object may be ended by releasing all references to it (resetting all references to null).<br />
<br><br />
<br />
==CreateTrain==<br />
{{MethodHeader|public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, string trackmarkName, bool direction)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class TrackMark|TrackMark]] trackmark, bool direction)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class Buildable|Buildable]] buildable, string trackName, float position, bool direction)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class GSTrackSearch|GSTrackSearch]] tracksearch, bool avoidDerailments)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class GSTrackSearch|GSTrackSearch]] tracksearch)}}<br />
;Parameters<br />
*'''consist''' = An array of vehicle KUIDs used to describe the required Train object.<br />
*'''trackmarkName''' = Name of Trackmark at which the consist is to be formed.<br />
*'''buildable''' = Buildable on which the consist is to be formed.<br />
*'''trackName''' = Name of track within Buildable object.<br />
*'''position''' = Distance at which the Train is to be placed relative to the start of the track.<br />
*'''trackmark''' = Reference to Trackmark at which the consist is to be formed.<br />
*'''direction''' = Orientation of Train relative to direction of track or trackmark.<br />
*'''tracksearch''' = The location at which to create the train<br />
*'''avoidDerailments''' = If true this function will fail and return null if creating the train would cause a derailment<br />
;Returned Value<br />
*Reference to the Train created if successful, null otherwise.<br />
;Syntax<br />
Train train = World.CreateTrain(consist, buildable, "Track 1", 10.0, true);<br />
;Notes<br />
*These methods create a train from a list of vehicles in a consist array.<br />
*Depending on the variant of the method used, the train can be created at a Trackmark, specified by name or reference, or at a Buildable or Industry object.<br />
*It is the responsibility of the script programmer to ensure that sufficient track exists at the given location to allow the train to be created.<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>'''GSTrackSearch''' aliases added in TRS19?</font><br />
<br><br />
<br />
==DeleteTrain==<br />
{{MethodHeader|public native void DeleteTrain([[Class Train|Train]] train)}}<br />
;Parameters<br />
*'''train''' = train to be deleted from map.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.DeleteTrain(flyingScotsman);<br />
;Notes<br />
*Once a train has been deleted, care should be taken to avoid using its reference.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==DeleteVehicle==<br />
{{MethodHeader|public native void DeleteVehicle([[Class Vehicle|Vehicle]] vehicle)}}<br />
;Parameters<br />
*'''vehicle''' = vehicle to be deleted from its train.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.DeleteVehicle(vehicles[vehicles.size()-1]);<br />
;Notes<br />
*Use [[Class Train#GetVehicles|Train.GetVehicles()]] to obtain an array of vehicles for a given train.<br />
*Use [[Class Vehicle#GetMyTrain|Vehicle.GetMyTrain()]] to obtain a train reference for a given vehicle.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==EndScenario==<br />
{{MethodHeader|public void EndScenario(float time)}}<br />
;Parameters<br />
*'''time''' = Amount of seconds to delay before ending the session<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.EndScenario(30.0);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==FindAsset==<br />
{{MethodHeader|public native [[Class Asset|Asset]] FindAsset([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of Asset to return.<br />
;Returned Value<br />
*Given a valid KUID parameter, this method return an Asset reference if successful, null otherwise.<br />
;Syntax<br />
Asset asset = World.FindAsset(kuid);<br />
;Notes<br />
*See also Asset.FindAsset()<br />
<br><br />
<br />
==FindDriverCommand==<br />
{{MethodHeader|public native [[Class DriverCommand|DriverCommand]] FindDriverCommand([[Class Asset|Asset]] driverCommandAsset)}}<br />
;Parameters<br />
*'''driverCommandAsset''' = Asset containing command to be added.<br />
;Returned Value<br />
*Reference to the DriverCommand if successful, null otherwise.<br />
;Syntax<br />
DriverCommand GoFaster = World.FindDriverCommand(accelerate);<br />
;Notes<br />
<br><br />
<br />
==GetAssetList==<br />
{{MethodHeader|public native [[Class Asset|Asset]][ ] GetAssetList(string kind)}}<br />
;Parameters<br />
*'''kind''' = String representing the Kind of asset to return.<br />
;Returned Value<br />
*A list of all assets of the given ''kind''<br />
;Syntax<br />
Asset[] Libraries = World.GetAssetList("Library");<br />
;Notes<br />
*All installed assets of the given ''kind'' are returned, irrespective of whether or not they are in use on the current map.<br />
<br><br />
<br />
==GetBadWeatherFog==<br />
{{MethodHeader|public obsolete native float GetBadWeatherFog(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Bad weather fog distance as a float in the range 0.0..1.0.<br />
;Syntax<br />
float dist = World.GetBadWeatherFog();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetBehaviors==<br />
{{MethodHeader|public native [[Class ScenarioBehavior|ScenarioBehavior]][ ] GetBehaviors(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A list of top-level behaviors or rules on the currently loaded route.<br />
;Syntax<br />
ScenarioBehavior[] rules = World.GetBehaviors();<br />
;Notes<br />
<br><br />
<br />
==GetCameraPitch==<br />
{{MethodHeader|public native float GetCameraPitch(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Current camera pitch, in radians<br />
;Syntax<br />
float pitch = World.GetCameraPitch();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCameraPositionX==<br />
{{MethodHeader|public obsolete native float GetCameraPositionX(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*X Coordinate of the current camera position.<br />
;Syntax<br />
float X = World.GetCameraPositionX();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetCameraPositionY==<br />
{{MethodHeader|public obsolete native float GetCameraPositionY(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Y Coordinate of the current camera position.<br />
;Syntax<br />
float Y = World.GetCameraPositionY();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetCameraPositionZ==<br />
{{MethodHeader|public obsolete native float GetCameraPositionZ(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Z Coordinate of the current camera position.<br />
;Syntax<br />
float Z = World.GetCameraPositionZ();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetCameraYaw==<br />
{{MethodHeader|public native float GetCameraYaw(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Current camera yaw, in radians<br />
;Syntax<br />
float yaw = World.GetCameraYaw();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCameraZoom==<br />
{{MethodHeader|public native float GetCameraZoom(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Current camera zoom, in meters<br />
;Syntax<br />
float zoom= World.GetCameraZoom();<br />
;Notes<br />
*<font color=red>Is this value equivalent to '''radius''' in [[#SetCameraAngle|SetCameraAngle()]]?</font><br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCurrentModule==<br />
{{MethodHeader|public native int GetCurrentModule(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An integer representing the current Trainz module.<br />
;Syntax<br />
int module = World.GetCurrentModule();<br />
;Notes<br />
* See [[#Trainz Modules|Trainz Modules]] for details of the constants associated with this method. <br />
* See [[ModuleInit Message]] for further details.<br />
<br><br />
<br />
==GetCurrentProfile==<br />
{{MethodHeader|public native [[Class Asset|Asset]] GetCurrentProfile(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current session asset<br />
;Syntax<br />
Asset currentSession = World.GetCurrentProfile();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCurrentTrain==<br />
{{MethodHeader|public native Train GetCurrentTrain(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The currently focused train<br />
;Syntax<br />
Train myTrain = World.GetCurrentTrain();<br />
;Notes<br />
* The current train is the one currently controlled by the user, which may not be the train the camera is focused on.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetDriverCharacterList==<br />
{{MethodHeader|public native [[Class DriverCharacter|DriverCharacter]][ ] GetDriverCharacterList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of DriverCharacter objects installed in the current world.<br />
;Syntax<br />
DriverCharacter[] drivers = World.GetDriverCharacterList();<br />
;Notes<br />
<br><br />
<br />
==GetDriverCommandList==<br />
{{MethodHeader|public native [[Class DriverCommand|DriverCommand]][ ] GetDriverCommandList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of DriverCommand objects installed in the current world.<br />
;Syntax<br />
DriverCommand[] commands = World.GetDriverCommandList();<br />
;Notes<br />
<br><br />
<br />
==GetGameDate==<br />
{{MethodHeader|public native int GetGameDate(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game day (1 - 31)<br />
;Syntax<br />
int Now = World.GetGameDate();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGameMonth==<br />
{{MethodHeader|public native int GetGameMonth(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game month (1 - 12)<br />
;Syntax<br />
int Now = World.GetGameMonth();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGameObjectByID==<br />
{{MethodHeader|public native [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetGameObjectByID([[Class GameObjectID|GameObjectID]] objectID, bool bTriggerLoad)<br>public native [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetGameObjectByID([[Class GameObjectID|GameObjectID]] objectID)}}<br />
;Parameters<br />
*'''objectID''' = The ID of the object to find.<br />
*'''bTriggerLoad''' = Optional, defaults to true. Whether to trigger an asynchronous load of any matching object (if it's not loaded already).<br />
;Returned Value<br />
* Asynchronous search result object. <br />
;Syntax<br />
AsyncObjectSearchResult search_result = World.GetGameObjectByID(objectID, true); // Search for and load an object<br />
;Notes<br />
*See [[HowTo/Search for objects in the world]] for a detailed guide on asynchronous searches.<br />
*The retured object is a reference to the in-progress object search.<br />
*When the search completes, a message of type "ObjectSearch","AsyncResult" will be posted to the result object.<br />
*If bTriggerLoad is true, a further message of type "ObjectSearch","AsyncLoadComplete" will be posted when all objects are loaded into memory. This message will still be posted if every object is already loaded.<br />
*Added in TRS19<br />
<br><br />
<br />
==GetGameObjectByIDIfLoaded==<br />
{{MethodHeader|public native [[Class GameObject|GameObject]] GetGameObjectByIDIfLoaded([[Class GameObjectID|GameObjectID]] objectID)}}<br />
;Parameters<br />
*'''objectID''' = The ID of the boject to find.<br />
;Returned Value<br />
* The object, if it exists and is currently loaded.<br />
;Syntax<br />
GameObject my_object = World.GetGameObjectByID(objectID);<br />
if (my_object) Interface.Print("Object exists and is loaded");<br />
;Notes<br />
*Added in TRS19<br />
<br><br />
<br />
==GetGameSeason==<br />
{{MethodHeader|public native float GetGameSeason(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game season<br />
;Syntax<br />
float Season = World.GetGameSeason();<br />
;Notes<br />
*The returned time is normalised to a value between 0.0 and 1.0<br />
*0.0 = mid-summer<br />
*0.5 = mid-winter<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGameTime==<br />
{{MethodHeader|public native float GetGameTime(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game time.<br />
;Syntax<br />
float Now = World.GetGameTime();<br />
;Notes<br />
*The returned time is normalised to a value between 0.0 and 1.0<br />
*0.0 = midday<br />
*0.25 = 6 p.m.<br />
*0.5 = midnight<br />
*0.75 = 6 a.m.<br />
*1.0 = midday again<br />
*Use the [[#Time_Values|Time Value]] constants to convert the normalised values to human readable times.<br />
<br><br />
<br />
==GetGameYear==<br />
{{MethodHeader|public native int GetGameYear(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game year.<br />
;Syntax<br />
int Now = World.GetGameYear();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGoodWeatherFog==<br />
{{MethodHeader|public obsolete native float GetGoodWeatherFog(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Good weather fog distance as a float in the range 0.0..1.0.<br />
;Syntax<br />
float dist = World.GetGoodWeatherFog();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetGroundDrawDistance==<br />
{{MethodHeader|public obsolete native float GetGroundDrawDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Ground draw distance in metres.<br />
;Syntax<br />
float dist = World.GetGroundDrawDistance();<br />
;Notes<br />
<br><br />
<br />
==GetIndustryList==<br />
{{MethodHeader|public obsolete native [[Class GameObject|GameObject]][ ] GetIndustryList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the Industry objects for the current route.<br />
;Syntax<br />
GameObject[] Industries = World.GetIndustryList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetJunctionList==<br />
{{MethodHeader|public obsolete native [[Class Junction|Junction]][ ] GetJunctionList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trackside junction objects for the current route.<br />
;Syntax<br />
Junction[] junctions = World.GetJunctionList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
*Junction objects attached to fixed track junctions are not returned by this method.<br />
<br><br />
<br />
==GetLayerList==<br />
{{MethodHeader|public native string[ ] GetLayerList(int layerType)}}<br />
;Parameters<br />
*layerType = LAYER_ROUTE, LAYER_SESSION, or LAYER_BOTH<br />
;Returned Value<br />
*Array of layer names<br />
;Syntax<br />
string[] routeLayerNames = World.GetLayerList(World.LAYER_ROUTE);<br />
;Notes<br />
*<font color=red>Added in ...?</font> <br />
<br><br />
<br />
==GetLayerType==<br />
{{MethodHeader|public native int GetLayerType(string layerName)}}<br />
;Parameters<br />
*layerName = The name of the layer<br />
;Returned Value<br />
*LAYER_ROUTE or LAYER_SESSION<br />
;Syntax<br />
int layerType = World.GetLayerType("MyLayer");<br />
;Notes<br />
*<font color=red>Added in ...?</font> <br />
<br><br />
<br />
==GetLibrary==<br />
{{MethodHeader|public native [[Class Library|Library]] GetLibrary([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of script library asset to load.<br />
;Returned Value<br />
*A reference to the script library asset if successful, null otherwise.<br />
;Syntax<br />
Library codelib = World.GetLibrary(LibraryKUID);<br />
;Notes<br />
*The [[Class Library|Library]] asset is initialised when this method is first called in a session.<br />
*Since only one instance can exist, subsequent calls return a reference to the existing Library object.<br />
*See [[Class Library|Library]] for notes on how to use this method.<br />
<br><br />
<br />
==GetLocalPlayerName==<br />
{{MethodHeader|public native string GetLocalPlayerName(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The name of the local player<br />
;Syntax<br />
string playerName = World.GetLocalPlayerName();<br />
;Notes<br />
* Gets the name of the local player, as should be used for setting ownership on DriverCharacters, etc.<br />
*<font color=red>Added in .TRS19?</font><br />
<br><br />
<br />
==GetNamedObjectList==<br />
{{MethodHeader|public native [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetNamedObjectList(string categoryFilter, string nameFilter, bool bNotifyOfExpiry)<br>public [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetNamedObjectList(string categoryFilter, string nameFilter)}}<br />
;Parameters<br />
*'''categoryFilter''' = A category filter to search for. Optional, provided a nameFilter parameter is provided. A category code reference can be found in [[Class AssetCategory|AssetCategory]].<br />
*'''nameFilter''' = A partial object name to search for. Optional, provided a categoryFilter parameter is provided.<br />
*'''bNotifyOfExpiry''' = Optional, defaults to false. If native code detects that the search results have changed then a message of type "ObjectSearch","Expired" will be posted to the result object, and the calling script can perform a new search if desired<br />
;Returned Value<br />
* Asynchronous search result object. <br />
;Syntax<br />
AsyncObjectSearchResult search_result = World.GetNamedObjectList(AssetCategory.Locomotive, "SD40-2"); // Search for all SD40-2 locomotives in the world<br />
;Notes<br />
*See [[HowTo/Search for objects in the world]] for a detailed guide on asynchronous searches.<br />
*The retured object is a reference to the in-progress object search.<br />
*When the search completes, a message of type "ObjectSearch","AsyncResult" will be posted to the result object.<br />
*With expiration notices are enabled, only one notification of type "ObjectSearch","Expired" will be posted for each search.<br />
*Added in TRS19.<br />
*''As personal experience has shown, the number of lines in this list is limited to 1000, so for large routes, unfortunately, such a search is not complete.''<br />
<br><br />
<br />
==GetSceneryDrawDistance==<br />
{{MethodHeader|public obsolete native float GetSceneryDrawDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Undefined.<br />
;Notes<br />
*Included for legacy script compatibility only. Has no effect.<br />
<br><br />
<br />
==GetSeconds==<br />
{{MethodHeader|public native float GetSeconds(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current value of a floating point number incrementing once per second in real time.<br />
;Syntax<br />
float start = World.GetSeconds();<br />
// do stuff<br />
float finish = World.GetSeconds();<br />
float period = finish - start;<br />
;Notes<br />
*Each call will return a float value containing the current value of an internal counter.<br />
*Subtracting a later value from a value saved at an earlier call will enable the delay between the two calls to be established.<br />
<br><br />
<br />
==GetSignalList==<br />
{{MethodHeader|public obsolete native [[Class Signal|Signal]][ ] GetSignalList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the signal objects for the current route.<br />
;Syntax<br />
Signal[] signals = World.GetSignalList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetStringTable==<br />
{{MethodHeader|public native [[Class StringTable|StringTable]] GetStringTable(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*The StringTable for the current session.<br />
;Syntax<br />
StringTable data = World.GetStringTable();<br />
;Notes<br />
<br><br />
<br />
==GetSurveyorSavedConsist==<br />
{{MethodHeader|public obsolete native [[Class Soup|Soup]] GetSurveyorSavedConsist(string name)}}<br />
;Parameters <br />
*'''name''' = Name of the consist to retrieve.<br />
;Returned Value<br />
*Returns a Soup definition of the named consist if it exists, null otherwise.<br />
;Syntax<br />
Soup consist = World.GetSurveyorSavedConsist("Brighton Belle");<br />
;Notes<br />
*Remember that the returned data is in a Soup format, which is not the same thing as a Train. <br />
*[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]] can be used to create a train from the returned Soup.<br />
*This method only works in Surveyor.<br />
*Obsolete in TRS19.<br />
<br><br />
<br />
==GetSurveyorSavedConsistList==<br />
{{MethodHeader|public native string[ ] GetSurveyorSavedConsistList()}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of names of all the saved consist objects in Surveyor.<br />
;Syntax<br />
string[] consists = World.GetSurveyorSavedConsistList();<br />
;Notes<br />
*This method only works in Surveyor.<br />
*Obsolete in TRS19.<br />
<br><br />
<br />
==GetTimeElapsed==<br />
{{MethodHeader|public native float GetTimeElapsed(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The number of real-time seconds that have passed since the start of the current session. <br />
;Syntax<br />
float secondsElapsed = World.GetTimeElapsed();<br />
;Notes<br />
*This measure of time stops passing while the game is paused.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetTrackmarkList==<br />
{{MethodHeader|public obsolete native [[Class TrackMark|TrackMark]][ ] GetTrackmarkList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trackmark objects for the current route.<br />
;Syntax<br />
Trackmark[] trackmarks = World.GetTrackmarkList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetTrainList==<br />
{{MethodHeader|public obsolete native [[Class Train|Train]][ ] GetTrainList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trains for the current route.<br />
;Syntax<br />
Train[] trains = World.GetTrainList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetTrainzBuild==<br />
{{MethodHeader|public native int GetTrainzBuild(void)}}<br />
;Parameters;<br />
*None<br />
;Returned Value<br />
*Gets the current build number of Trainz. <br />
;Syntax<br />
int build = World.GetTrainzBuild();<br />
;Notes<br />
*The value returned corresponds to the build number you can see in the bottom-right side of the main Trainz menu screen.<br />
<br><br />
<br />
==GetTrainzVersion==<br />
{{MethodHeader|public native float GetTrainzVersion(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The TRS version number.<br />
;Syntax<br />
float version = World.GetTrainzVersion();<br />
;Notes<br />
*The value returned corresponds to the version number of Content manager (for example 4.6). <br />
<br><br />
<br />
==GetTriggerList==<br />
{{MethodHeader|public obsolete native [[Class Trigger|Trigger]][ ] GetTriggerList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trigger objects for the current route.<br />
;Syntax<br />
Trigger[] triggers = World.GetTriggerList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
*This method does not return scenery triggers, ie those attached to SceneryWithTrack objects and their descendants.<br />
<br><br />
<br />
==GetVehicleList==<br />
{{MethodHeader|public obsolete native [[Class Vehicle|Vehicle]][ ] GetVehicleList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the vehicles in the current route.<br />
;Syntax<br />
Vehicle[] vehicles = World.GetVehicleList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetWeatherChangeability==<br />
{{MethodHeader|public native int GetWeatherChangeability(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*One of the [[#Weather_Changeability_Constants|Weather Changeability Constants]] denoting the variability of weather conditions.<br />
;Syntax<br />
int variability = World.GetWeatherChangeability();<br />
;Notes<br />
<br><br />
<br />
==GetWeatherType==<br />
{{MethodHeader|public native int GetWeatherType(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*One of the [[#Weather_Type_Constants|Weather Type Constants]] denoting the current weather conditions.<br />
;Syntax<br />
int weather = World.GetWeatherType();<br />
;Notes<br />
<br><br />
<br />
==IsAssetRestrictionInEffect==<br />
{{MethodHeader|public native bool IsAssetRestrictionInEffect(string)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Whether this game world has Asset Restrictions. <br />
;Syntax<br />
bool assetRestrictionsExist = World.IsAssetRestrictionInEffect();<br />
;Notes<br />
*Multiplayer Sessions require Asset Restrictions to be in effect to avoid compatibility issues between peers.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==IsLayerVisible==<br />
{{MethodHeader|public native bool IsLayerVisible(string layerName)}}<br />
;Parameter<br />
*layerName = Name of the layer to check<br />
;Returned Value<br />
*Whether the layer is visible<br />
;Syntax<br />
bool isVisible = World.IsLayerVisible("MyLayer");<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==LoadMap==<br />
{{MethodHeader|public native bool LoadMap([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of map to load.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
if (World.LoadMap(mapKUID) Interface.Print("Map loaded OK");<br />
else Interface.Print("Map load failed");<br />
;Notes<br />
*Use World.[[#FindKUID|FindKUID()]] to find the desired route KUID.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==LoadSession==<br />
{{MethodHeader|public native bool LoadSession([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of session to load.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
if (World.LoadSession(sessionKUID) Interface.Print("Session loaded OK");<br />
else Interface.Print("Session load failed");<br />
;Notes<br />
*Use World.[[#FindKUID|FindKUID()]] to find the desired session KUID.<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==Play2DSound==<br />
{{MethodHeader|public float Play2DSound([[Class Asset|Asset]] asset, string wave)}}<br />
;Parameters<br />
*'''asset''' = Asset where the sound file is located.<br />
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.<br />
;Returned Value<br />
* Undefined.<br />
;Syntax<br />
// Play the sound and continues script execution.<br />
World.Play2DSound(soundAsset,"sounds/allaboard.wav"); <br />
// Wait until sound has completed before continuing (pre-TS12 only!)<br />
Sleep(World.Play2DSound(soundAsset,"sounds/allaboard.wav")); <br />
;Notes<br />
*Plays a ''.wav" sound file from the given asset's folder.<br />
*The sound is non directional and can be mono or stereo. <br />
*This method does not return after the sound has finished playing, it returns with the length of the sound as soon as it is called. <br />
*This means your code will keep on executing while Trainz is playing the sound.<br />
<br><br />
<br />
==PlaySound==<br />
{{MethodHeader|public native float PlaySound<br>&nbsp;&nbsp;&nbsp;&nbsp;([[Class Asset|Asset]] asset, string wave, float vol, float near, float far, [[Class GameObject|GameObject]] target, string pt)<br>&nbsp;&nbsp;&nbsp;&nbsp;([[Class Asset|Asset]] asset, string wave, float vol, float near, float far, [[Class GameObject|GameObject]] target, string pt, bool loop)}}<br />
;Parameters<br />
*'''asset''' = Asset where the sound file is located.<br />
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.<br />
*'''vol''' = Volume level to play the sound at (0 to 1)<- These values taken from TRS2019 world.gs file comments<br />
*'''near''' = Distance from the target asset at which the sound will be played at maximum volume.<br />
*'''far''' = Distance from the target asset at which the sound will become inaudible.<br />
*'''target''' = GameObject to which the sound will be attached if a 3d sound is required, null for 2D.<br />
*'''pt''' = Name of attachment point in the target object if a 3d sound is required, null for 2D.<br />
*'''loop''' = (Optional) If true the sound will loop continuously.<br />
;Returned Value<br />
* Sound length in seconds for Trainz before TS12<br />
* Undefined for TS12 and TANE<br />
;Syntax<br />
// Play the sound and continues script execution.<br />
World.PlaySound(soundAsset,"sounds/allaboard.wav",1.0,10.0,100.0,Station,"a.loudspeaker"); <br />
// Wait until sound has completed before continuing (pre-TS12 only!)<br />
Sleep(World.PlaySound(soundAsset,"sounds/allaboard.wav",1000.0,10.0,100.0,Station,"a.loudspeaker"); <br />
;Notes<br />
*Plays a ''.wav'' sound file from the given asset's folder.<br />
*If the sound is to be directional a mono sound file is required. <br />
*This method does not return after the sound has finished playing: it returns as soon as it is called. <br />
*This means your code will keep on executing while Trainz is playing the sound.<br />
*If you want to wait for the sound to complete playing before moving on, wrap the PlaySound() call up in a Sleep() call. '''Note!''' This works only in Trainz versions before TS12. For newer versions, TS12 and TANE, you can hard-code the duration of the sound, or store it in the extensions container of the config.txt file.<br />
*The sound volume will be at a maximum for a camera position at or less than the value of the ''near'' parameter and will reduce with distance until the hearing position reaches ''far'', when the sound will be inaudible.<br />
<br><br />
<br />
==RemoveDriverCharacter==<br />
{{MethodHeader|public native void RemoveDriverCharacter([[Class DriverCharacter|DriverCharacter]] driver)}}<br />
;Parameters<br />
*'''driver''' = DriverCharacter to remove.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.RemoveDriverCharacter(dave);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==RemoveDriverCommand==<br />
{{MethodHeader|public native void RemoveDriverCommand([[Class DriverCommand|DriverCommand]] command)}}<br />
;Parameters<br />
*'''command''' = DriverCommand to remove.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.RemoveDriverCommand(driverCommand);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==RestartSession==<br />
{{MethodHeader|public native bool RestartSession()}}<br />
;Parameters<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.RestartSession();<br />
;Notes<br />
*Valid in Driver mode only.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==SetBadWeatherFog==<br />
{{MethodHeader|public obsolete native void SetBadWeatherFog(float distance)}}<br />
;Parameters<br />
*'''distance''' = Bad weather fog distance to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetBadWeatherFog(0.5);<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==SetCamera==<br />
{{MethodHeader|public native bool SetCamera([[Class MapObject|MapObject]] focus)<br>public native void SetCamera([[Class Junction|Junction]] focus)<br>public native void SetCamera([[Class Vehicle|Vehicle]] focus, int cameraMode)<br>public native void SetCamera([[Class Train|Train]] focus, int cameraMode)}}<br />
;Parameters<br />
*'''focus''' = Object on which the camera is to be focused.<br />
*''cameraMode''' = One of the [[#Camera_View_Modes|Camera View Mode]] constants defining the view which should be assigned to the camera.<br />
;Returned Value<br />
*The first variant returns a boolean to indicate success or failure.<br />
*Remaining variants do not return a value<br />
;Syntax<br />
World.SetCamera(train.GetVehicles[0],World.CAMERA_TRACKING); // sets the camera to track the first vehicle in the train.<br />
;Notes<br />
*<font color=red>Junction alias removed in TRS19?</font><br />
<br><br />
<br />
==SetCameraAngle==<br />
{{MethodHeader|public void SetCameraAngle(float yaw, float pitch, float radius)<br>public obsolete void SetCameraAngle(int yaw, int pitch, float radius)}}<br />
;Parameters<br />
*'''yaw''' = Camera rotation in radians (float) or degrees (int), 90 is a direct front view.<br />
*'''pitch''' = Camera angle relative to the horizon in radians (float), or degrees (int), 0 is horizontal, 90 points vertically upwards.<br />
*'''radius''' = Distance in metres to the object in focus.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetCameraAngle(90,0,25); // Sets the camera to a direct frontal view at 25 metres from the currently focused object.<br />
;Notes<br />
*''Radius'' is measured from the object origin point (0,0,0). If there's no target object this will be the distance to the ground.<br />
*Note difference in units of ''yaw'' and ''pitch'' depending in the method signature used.<br />
*The integer version of this method call is obsolete in TRS19.<br />
<br><br />
<br />
==SetCameraFlags==<br />
{{MethodHeader|public native void SetCameraFlags(int flags)}}<br />
;Parameter<br />
*'''flags''' integer value defining what the user is permitted to do with the game camera.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
// User is permitted to select External or Tracking views only.<br />
World.SetCameraFlags(World.CAMERA_EXTERNAL | World.CAMERA_TRACKING);<br />
;Notes<br />
*Use any combination of [[#Camera_Flags|Camera Flags]] and [[#Camera_View_Modes|Camera View Modes]] to set the parameter.<br />
<br><br />
<br />
==SetCameraMode==<br />
{{MethodHeader|public void SetCameraMode(int mode)}}<br />
;Parameter<br />
*'''mode''' = Camera mode to select.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetCameraMode(World.CAMERA_TRACKING);<br />
;Notes<br />
*Use one of the [[#Camera_View_Modes|Camera View Modes]] to set the parameter.<br />
<br><br />
<br />
==SetEditingCamera==<br />
{{MethodHeader|public void SetEditingCamera([[Class GameObject|GameObject]] actor, bool bIsActorEditingCamera)}}<br />
;Parameter<br />
*'''actor''' = The script who is intended to edit the camera position.<br />
*'''bIsActorEditingCamera''' = True to begin editing, or False to end the editing operation. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetEditingCamera(myScript, true);<br />
;Notes<br />
*Hints to the caching systems that the camera position is in the process of being changed. This may reduce the amount of streaming that will occur until the change is complete.<br />
*This is intended for use-cases where the decision to move the camera happens in advance of the actual call to [[#SetCamera|SetCamera()]] or etc., for example when the new camera target needs to be streamed in first.<br />
*There is no advantage in calling this unless your code then sleeps/waits before undoing the call.<br />
*It is not required to call this before using SetCamera() etc.<br />
*A boolean state is stored per actor; multiple calls to enable editing on a single actor do not need to be matched to multiple calls to disable editing.<br />
*It is counterproductive to call this when transitioning the camera over a short distance (ie. where the source and target locations can see each other). If jumping to a new location, followed by a visual camera transition at the new location, camera editing may be enabled around the target-selection for the jump, and the jump itself, but should be disabled before proceeding with the transition.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==SetGameDate==<br />
{{MethodHeader|public void SetGameDate(int year, int month, int date)}}<br />
;Parameters<br />
*'''year''' = The year to set (1970-2038)<br />
*'''month''' = The month to set (1-12)<br />
*'''day''' = The day to set (1-31)<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameDate(2000, 12, 25); // sets date to 25 December 2000<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==SetGameTime==<br />
{{MethodHeader|public void SetGameTime(float time)}}<br />
;Parameters<br />
*'''time''' = new gane time to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameTime(0.5); // sets time to midnight<br />
;Notes<br />
*Game time is normalised to a value between 0.0 and 1.0<br />
*0.0 = midday<br />
*0.25 = 6 p.m.<br />
*0.5 = midnight<br />
*0.75 = 6 a.m.<br />
*1.0 = midday again<br />
*Use the [[#Time_Values|Time Value]] constants to convert human readable times to normalised values. <br />
<br><br />
<br />
==SetGameTimeRate==<br />
{{MethodHeader|public native void SetGameTimeRate(float rate)}}<br />
;Parameters<br />
*'''rate''' = New time rate to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameTimeRate(World.TIME_RATE_8X); // sets game time to advance by 8 minutes per minute of real world time.<br />
;Notes<br />
*Use one of the [[#Time_Rate_Constants|Time Rate Constants]] to define the parameter.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==SetGoodWeatherFog==<br />
{{MethodHeader|public obsolete native void SetGoodWeatherFog(float distance)}}<br />
;Parameters<br />
*'''distance''' = Good weather fog distance to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGoodWeatherFog(0.5);<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==SetGroundDrawDistance==<br />
{{MethodHeader|public obsolete native void SetGroundDrawDistance(float distance)}}<br />
;Parameters<br />
*'''distance''' = Ground draw distance in metres.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGroundDrawDistance(1000.0);<br />
;Notes<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==SetLayerVisible==<br />
{{MethodHeader|public native void IsLayerVisible(string layerName, bool visible)}}<br />
;Parameter<br />
*layerName = Name of the layer to check<br />
*visible = Whether to set the layer visible or not<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.IsLayerVisible("MyLayer", False);<br />
;Notes<br />
*Show/Hide a route/session layer.<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==SetSceneryDrawDistance==<br />
{{MethodHeader|public obsolete native void SetSceneryDrawDistance(float distance)}}<br />
;Parameters<br />
*'''distance''' = unused.<br />
;Returned Value<br />
*None<br />
;Notes<br />
* Does nothing. Included for script compatibility only.<br />
<br><br />
<br />
==SetTargetObserver==<br />
{{MethodHeader|public void SetTargetObserver([[Class GameObject|GameObject]] observer)}}<br />
;Parameters<br />
*'''observer''' = The game object to receive targeting messages.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetTargetObserver(self);<br />
;Notes<br />
* It is unlikely a script programmer would ever need to use this method.<br />
* Causes the specified object to receive "Track", "LeftClick" messages when a track is clicked. Causes the specified object to receive "Interface-Event", "Left-Click" messages when a targetable MapObject is clicked. May cause the functionality of a left mouse click to change from what the user is expecting, so should be used with caution. Used in modal scripts to allow the user to indicate a location for train placement, etc. As there is only a single observer at any given time, the script must take care to only call this function when entering placement mode at the user's request.<br />
<br><br />
<br />
==SetWeather==<br />
{{MethodHeader|public native void SetWeather(int type, int changeability)}}<br />
;Parameters<br />
*'''type''' = Weather conditions as defined by one of the [[#Weather_Type_Constants|Weather Type Constants]].<br />
*'''change''' = Weather variation as defined by one of the [[#Weather_Changeability_Constants|Weather Changeability Constants]].<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetWeather(World.WEATHER_TYPE_HEAVY_SNOW,World.WEATHER_CHANGEABILITY_EXTREME); // April in Paris.<br />
;Notes<br />
<br><br />
<br />
==SetWorldEditModeEnabled==<br />
{{MethodHeader|public native bool SetWorldEditModeEnabled(int editFlags, bool enable)}}<br />
;Parameters<br />
*'''editFlags''' = Bitmask specifying which modes to alter, see PERMIT_EDIT_*<br />
*''cameraMode''' = Whether to enable or disable the mode<br />
;Returned Value<br />
*Whether the change was completely successful<br />
;Syntax<br />
World.SetWorldEditModeEnabled(World.PERMIT_EDIT_TRAINS | World.PERMIT_EDIT_CONSISTS, True); // Enable player editing of trains and consists<br />
;Notes<br />
*This does not affect scripts which may alter the world, only the availability of the player world editing tools (i.e, the Surveyor tabs).<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==SynchronouslyLoadGameObjectByID==<br />
{{MethodHeader|public [[Class GameObject|GameObject]] SynchronouslyLoadGameObjectByID([[Class GameObjectID|GameObjectID]] objectID)}}<br />
;Parameters<br />
*'''objectID''' = The ID of the object to find.<br />
;Returned Value<br />
* The object, if it exists.<br />
;Syntax<br />
GameObject my_object = World.SynchronouslyLoadGameObjectByID(objectID);<br />
if (my_object Interface.Print("Object exists and has been loaded if required");<br />
;Notes<br />
*This function is usable only by script 'thread' functions and will throw an exception if called incorrectly.<br />
*Added in TRS19<br />
<br><br />
<br />
==UpdatePositionToGroundHeight==<br />
{{MethodHeader|public native bool UpdatePositionToGroundHeight([[Class WorldCoordinate|WorldCoordinate]] position)}}<br />
;Parameters<br />
*'''position''' (in, out) = Position object to update with the ground height at it's location<br />
;Returned Value<br />
* True if the ground position was updated<br />
;Syntax<br />
if (World.UpdatePositionToGroundHeight(position) Interface.Print("Position was updated");<br />
;Notes<br />
*This updates the input ''position'' object with the ground height at that location.<br />
*This process may fail if the ground data at the specified location is not currently loaded.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==UpdatePositionToSurfaceHeight==<br />
{{MethodHeader|public native bool UpdatePositionToSurfaceHeight([[Class WorldCoordinate|WorldCoordinate]] position)}}<br />
;Parameters<br />
*'''position''' (in, out) = Position object to update with the water height at it's location<br />
;Returned Value<br />
* True if the ground position was updated<br />
;Syntax<br />
if (World.UpdatePositionToGroundHeight(position) Interface.Print("Position was updated");<br />
;Notes<br />
*This updates the input ''position'' object with the water height at that location. If no water is present, the position is adjusted to the ground height.<br />
*This process may fail if the ground data at the specified location is not currently loaded.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==UserSetCamera==<br />
{{MethodHeader|public native bool UserSetCamera([[Class GameObject|GameObject]] target)}}<br />
;Parameters<br />
*'''target''' = GameObject to set focus to.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.UserSetCamera(Router,GetGameObject("Junction 5"));<br />
;Notes<br />
<br><br />
<br />
==UserSetCameraMode==<br />
{{MethodHeader|public native void UserSetCameraMode(int mode)}}<br />
;Parameters<br />
*'''mode''' = One of the [[#Camera_View_Modes|Camera View Modes]]<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.UserSetCameraMode(World.CAMERA_ROAMING); // switches to roaming view if permitted.<br />
;Notes<br />
*This method respects the current [[#Camera_Flags|Camera Flag]] settings, disallowing any change which the flags do not permit.<br />
<br><br />
<br />
==UserSetCameraPosition==<br />
{{MethodHeader|public native bool UserSetCamera([[Class WorldCoordinate|WorldCoordinate]] camPos)}}<br />
;Parameters<br />
*'''camPos''' = World coordinates to set camera to<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.UserSetCamera(Router,GetGameObject("Junction 5"));<br />
;Notes<br />
* For camera modes which do not need to target specific objects, this allows the camera to be set to an arbitrary world position.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_World&diff=33208Class World2022-07-28T04:42:13Z<p>Ciceronmt: /* GetGameObjectByIDIfLoaded */</p>
<hr />
<div>*[[TrainzScript Library Reference|API Hierarchy]]<br />
**World (world.gs)<br />
<br><br />
*World is a static class used to access various aspects of the Trainz environment.<br />
<br><br />
<br />
==Constants==<br />
*These constants are used to define various values and can be used as mnenomics.<br />
*If accessed from scripts the values must be prefixed ''World.'', for example:<br />
World.SetWeather(World.WEATHER_TYPE_LIGHT_SNOW,World.WEATHER_CHANGEABILITY_PERIODIC);<br />
<br><br />
<br />
===Camera View Modes===<br />
----<br />
*These values can be used either to choose the current camera viewing mode through World.[[#SetCameraMode|SetCameraMode()]], or to restrict certain camera modes from being accessed through methods such as World.[[#SetCamera|SetCamera()]].<br />
<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CAMERA_INTERNAL = 1||Internal cabin camera view.<br />
|-<br />
|public define int CAMERA_EXTERNAL = 2||External train camera view<br />
|-<br />
|public define int CAMERA_TRACKING = 4||External tracking camera view.<br />
|-<br />
|public define int CAMERA_ROAMING = 128||Roaming camera view.<br />
|}<br />
<br><br />
<br />
===Camera Flags===<br />
----<br />
*These flags are used in addition to the Camera Mode Flags to allow or disallow specific camera actions. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CAMERA_SWITCH_VIEWS = 8||User permitted to swap between the camera views.<br />
|-<br />
|public define int CAMERA_SWITCH_VEHICLES = 16||User permitted to swap vehicles within the current train.<br />
|-<br />
|public define int CAMERA_SWITCH_TRAINS = 32||User permitted to swap to other trains which are in the consist menu.<br />
|-<br />
|public define int CAMERA_LOCKED = 64||User is NOT permitted to adjust camera (i.e. zoom, pan etc.).<br />
|-<br />
|public define int CAMERA_NORMAL = * ||Normal camera mode where everything is permitted.<br />
|-<br />
|colspan=2|<sup>* NOTE: CAMERA_NORMAL = CAMERA_INTERNAL | CAMERA_EXTERNAL | CAMERA_TRACKING | CAMERA_SWITCH_VIEWS | CAMERA_SWITCH_VEHICLES | CAMERA_SWITCH_TRAINS</sup><br />
|}<br />
<br><br />
<br />
===Weather Type Constants===<br />
----<br />
*Define the current state of the weather in Trainz. <br />
*A variety of weather conditions are supported and can be changed by using one of these values with the World.[[#SetWeather|SetWeather()]] method. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int WEATHER_TYPE_CLEAR = 0||Clear weather, no clouds, rain or snow.<br />
|-<br />
|public define int WEATHER_TYPE_CLOUDY = 1||Cloudy weather, no rain.<br />
|-<br />
|public define int WEATHER_TYPE_DRIZZLE = 2||Drizzle, light rain.<br />
|-<br />
|public define int WEATHER_TYPE_RAIN = 3||Rainy weather.<br />
|-<br />
|public define int WEATHER_TYPE_STORMY = 4||Stormy weather that includes lightning and thunder.<br />
|-<br />
|public define int WEATHER_TYPE_LIGHT_SNOW = 5||Snowing lightly.<br />
|-<br />
|public define int WEATHER_TYPE_MEDIUM_SNOW = 6||Medium level snow fall.<br />
|-<br />
|public define int WEATHER_TYPE_HEAVY_SNOW = 7||Heavy snow fall.<br />
|}<br />
<br><br />
<br />
===Weather Changeability Constants===<br />
----<br />
*Define the changeability settings for the weather. <br />
*Weather changeability refers to variability of weather conditions rather than to a specific weather type.<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int WEATHER_CHANGEABILITY_NONE = 0||Weather remains static.<br />
|-<br />
|public define int WEATHER_CHANGEABILITY_PERIODIC = 1||Periodic changes in weather.<br />
|-<br />
|public define int WEATHER_CHANGEABILITY_EXTREME = 2||Extreme and frequent changes in weather. <br />
|}<br />
<br><br />
<br />
===Time Values===<br />
----<br />
*Time constants defined in seconds.<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TIME_SECOND = 1.0f||One second.<br />
|-<br />
|public define float TIME_MINUTE = TIME_SECOND * 60.0f||One minute, 60.0 seconds.<br />
|-<br />
|public define float TIME_HOUR = TIME_MINUTE * 60.0f||One hour, 60.0 minutes, 3600.0 seconds.<br />
|-<br />
|public define float TIME_DAY = TIME_HOUR * 24.0f||One day, 24 hours, 1440.0 minutes, 86400.0 seconds.<br />
|}<br />
<br><br />
<br />
===Time Rate Constants===<br />
----<br />
*Values that define the time rates relative to normal time. <br />
*These constants can be used to set the time rate that Trainz runs out through the World.[[#SetGameTimeRate|SetGameTimeRate()]] method. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TIME_RATE_1X = 0||Real time (i.e. time in Trainz passes at the same rate as in the real world)<br />
|-<br />
|public define int TIME_RATE_2X = 1||Time passes at twice normal speed.<br />
|-<br />
|public define int TIME_RATE_4X = 2||<br />
|-<br />
|public define int TIME_RATE_8X = 3||<br />
|-<br />
|public define int TIME_RATE_16X = 4||<br />
|-<br />
|public define int TIME_RATE_32X = 5||<br />
|-<br />
|public define int TIME_RATE_60X = 6||<br />
|-<br />
|public define int TIME_RATE_120X = 7||<br />
|-<br />
|public define int TIME_RATE_240X = 8||<br />
|-<br />
|public define int TIME_RATE_360X = 9||<br />
|-<br />
|public define int TIME_RATE_480X = 10||<br />
|-<br />
|public define int TIME_RATE_720X = 11||<br />
|-<br />
|public define int TIME_RATE_960X = 12||<br />
|-<br />
|public define int TIME_RATE_1200X = 13||<br />
|-<br />
|public define int TIME_RATE_1440X = 14||<br />
|}<br />
<br><br />
<br />
===Layer Type Constants===<br />
----<br />
*These constants can be used for querying route/session layers via [[#GetLayerList|GetLayerList]] and [[#GetLayerType|GetLayerType]].<br />
*<font color=red>Added in TRS19?</font><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int LAYER_INVALID = 0||<br />
|-<br />
|public define int LAYER_ROUTE = 1||<br />
|-<br />
|public define int LAYER_SESSION = 2||<br />
|-<br />
|public define int LAYER_BOTH = 3||<br />
|}<br />
<br><br />
<br />
===World Editing Mode Constants===<br />
----<br />
*These constants can be used to set editing modes through World.[[#SetWorldEditModeEnabled|SetWorldEditModeEnabled()]].<br />
*<font color=red>Added in TRS19?</font><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int PERMIT_EDIT_NONE = 0x0||<br />
|-<br />
|public define int PERMIT_EDIT_TOPOLOGY = 0x1||<br />
|-<br />
|public define int PERMIT_EDIT_PAINT = 0x2||<br />
|-<br />
|public define int PERMIT_EDIT_SCENERYOBJECTS = 0x4||<br />
|-<br />
|public define int PERMIT_EDIT_SCENERYSPLINES = 0x8||<br />
|-<br />
|public define int PERMIT_EDIT_TRACKSPLINES = 0x10||<br />
|-<br />
|public define int PERMIT_EDIT_TRACKSIDEOBJECTS = 0x20||<br />
|-<br />
|public define int PERMIT_EDIT_TRACKMARKS = 0x40||<br />
|-<br />
|public define int PERMIT_EDIT_TOOLS = 0x80||<br />
|-<br />
|public define int PERMIT_EDIT_WORLD = 0x100||<br />
|-<br />
|public define int PERMIT_EDIT_LAYERS = 0x200||<br />
|-<br />
|public define int PERMIT_EDIT_TRAINS = 0x400||<br />
|-<br />
|public define int PERMIT_EDIT_CONSISTS = 0x800||<br />
|-<br />
|public define int PERMIT_EDIT_ALL = -1||<br />
|}<br />
<br><br />
<br />
===Trainz Modules===<br />
----<br />
*Trainz module mode constants. <br />
*These values define the various module environments that Trainz can be in. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int NO_MODULE = 0||Trainz not running in a module.<br />
|-<br />
|public define int SURVEYOR_MODULE = 1||Trainz is currently running in Surveyor.<br />
|-<br />
|public define int DRIVER_MODULE = 2||Trainz is currently running in Driver.<br />
|}<br />
<br> <br />
<br />
==Related Messages==<br />
* [[TrainzScript Message Reference]]<br><br />
* [[Camera Messages]]<br><br />
* [[Interface Messages]]<br><br />
* [[ModuleInit Message]]<br><br />
<br><br />
<br />
==AddDriverCharacter==<br />
{{MethodHeader|public native [[Class DriverCharacter|DriverCharacter]] AddDriverCharacter([[Class Asset|Asset]] driverCharacterAsset)}}<br />
;Parameters<br />
*'''driverCharacterAsset''' = Asset containing character to be added.<br />
;Returned Value<br />
*Reference to the DriverCharacter if successful, null otherwise.<br />
;Syntax<br />
DriverCharacter Casey = World.AddDriverCharacter(CaseyJones);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==AddDriverCommand==<br />
{{MethodHeader|public native [[Class DriverCommand|DriverCommand]] AddDriverCommand([[Class Asset|Asset]] driverCommandAsset)}}<br />
;Parameters<br />
*'''driverCommandAsset''' = Asset containing command to be added.<br />
;Returned Value<br />
*Reference to the DriverCommand if successful, null otherwise.<br />
;Syntax<br />
DriverCommand GoFaster = World.AddDriverCommand(accelerate);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==CancelCurrentEditingMode==<br />
{{MethodHeader|public native void CancelCurrentEditingMode(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.CancelCurrentEditingMode();<br />
;Notes<br />
* Cancels out of any player entered editing mode, if relevant. This should only normally be called as a result of direct player action.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==CreateBehavior==<br />
{{MethodHeader|public native [[Class ScenarioBehavior|ScenarioBehavior]] CreateBehavior([[Class KUID|KUID]] kuid, [[Class Soup|Soup]] initialProperties)}}<br />
;Parameters<br />
*'''kuid''' = KUID of scenario.<br />
'''initialProperties''' = Soup object containing initial properties for scenario.<br />
;Returned Value<br />
*Reference to the ScenarioBehavior created if successful, null otherwise.<br />
;Syntax<br />
ScenarioBehavior scenario = World.CreateBehavior(scenarioAsset, scenarioSoup);<br />
;Notes<br />
*The returned ScenarioBehavior object may be ended by releasing all references to it (resetting all references to null).<br />
<br><br />
<br />
==CreateTrain==<br />
{{MethodHeader|public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, string trackmarkName, bool direction)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class TrackMark|TrackMark]] trackmark, bool direction)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class Buildable|Buildable]] buildable, string trackName, float position, bool direction)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class GSTrackSearch|GSTrackSearch]] tracksearch, bool avoidDerailments)<br>public native [[Class Train|Train]] CreateTrain([[Class KUID|KUID]][ ] consist, [[Class GSTrackSearch|GSTrackSearch]] tracksearch)}}<br />
;Parameters<br />
*'''consist''' = An array of vehicle KUIDs used to describe the required Train object.<br />
*'''trackmarkName''' = Name of Trackmark at which the consist is to be formed.<br />
*'''buildable''' = Buildable on which the consist is to be formed.<br />
*'''trackName''' = Name of track within Buildable object.<br />
*'''position''' = Distance at which the Train is to be placed relative to the start of the track.<br />
*'''trackmark''' = Reference to Trackmark at which the consist is to be formed.<br />
*'''direction''' = Orientation of Train relative to direction of track or trackmark.<br />
*'''tracksearch''' = The location at which to create the train<br />
*'''avoidDerailments''' = If true this function will fail and return null if creating the train would cause a derailment<br />
;Returned Value<br />
*Reference to the Train created if successful, null otherwise.<br />
;Syntax<br />
Train train = World.CreateTrain(consist, buildable, "Track 1", 10.0, true);<br />
;Notes<br />
*These methods create a train from a list of vehicles in a consist array.<br />
*Depending on the variant of the method used, the train can be created at a Trackmark, specified by name or reference, or at a Buildable or Industry object.<br />
*It is the responsibility of the script programmer to ensure that sufficient track exists at the given location to allow the train to be created.<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>'''GSTrackSearch''' aliases added in TRS19?</font><br />
<br><br />
<br />
==DeleteTrain==<br />
{{MethodHeader|public native void DeleteTrain([[Class Train|Train]] train)}}<br />
;Parameters<br />
*'''train''' = train to be deleted from map.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.DeleteTrain(flyingScotsman);<br />
;Notes<br />
*Once a train has been deleted, care should be taken to avoid using its reference.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==DeleteVehicle==<br />
{{MethodHeader|public native void DeleteVehicle([[Class Vehicle|Vehicle]] vehicle)}}<br />
;Parameters<br />
*'''vehicle''' = vehicle to be deleted from its train.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.DeleteVehicle(vehicles[vehicles.size()-1]);<br />
;Notes<br />
*Use [[Class Train#GetVehicles|Train.GetVehicles()]] to obtain an array of vehicles for a given train.<br />
*Use [[Class Vehicle#GetMyTrain|Vehicle.GetMyTrain()]] to obtain a train reference for a given vehicle.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==EndScenario==<br />
{{MethodHeader|public void EndScenario(float time)}}<br />
;Parameters<br />
*'''time''' = Amount of seconds to delay before ending the session<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.EndScenario(30.0);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==FindAsset==<br />
{{MethodHeader|public native [[Class Asset|Asset]] FindAsset([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of Asset to return.<br />
;Returned Value<br />
*Given a valid KUID parameter, this method return an Asset reference if successful, null otherwise.<br />
;Syntax<br />
Asset asset = World.FindAsset(kuid);<br />
;Notes<br />
*See also Asset.FindAsset()<br />
<br><br />
<br />
==FindDriverCommand==<br />
{{MethodHeader|public native [[Class DriverCommand|DriverCommand]] FindDriverCommand([[Class Asset|Asset]] driverCommandAsset)}}<br />
;Parameters<br />
*'''driverCommandAsset''' = Asset containing command to be added.<br />
;Returned Value<br />
*Reference to the DriverCommand if successful, null otherwise.<br />
;Syntax<br />
DriverCommand GoFaster = World.FindDriverCommand(accelerate);<br />
;Notes<br />
<br><br />
<br />
==GetAssetList==<br />
{{MethodHeader|public native [[Class Asset|Asset]][ ] GetAssetList(string kind)}}<br />
;Parameters<br />
*'''kind''' = String representing the Kind of asset to return.<br />
;Returned Value<br />
*A list of all assets of the given ''kind''<br />
;Syntax<br />
Asset[] Libraries = World.GetAssetList("Library");<br />
;Notes<br />
*All installed assets of the given ''kind'' are returned, irrespective of whether or not they are in use on the current map.<br />
<br><br />
<br />
==GetBadWeatherFog==<br />
{{MethodHeader|public obsolete native float GetBadWeatherFog(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Bad weather fog distance as a float in the range 0.0..1.0.<br />
;Syntax<br />
float dist = World.GetBadWeatherFog();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetBehaviors==<br />
{{MethodHeader|public native [[Class ScenarioBehavior|ScenarioBehavior]][ ] GetBehaviors(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A list of top-level behaviors or rules on the currently loaded route.<br />
;Syntax<br />
ScenarioBehavior[] rules = World.GetBehaviors();<br />
;Notes<br />
<br><br />
<br />
==GetCameraPitch==<br />
{{MethodHeader|public native float GetCameraPitch(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Current camera pitch, in radians<br />
;Syntax<br />
float pitch = World.GetCameraPitch();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCameraPositionX==<br />
{{MethodHeader|public obsolete native float GetCameraPositionX(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*X Coordinate of the current camera position.<br />
;Syntax<br />
float X = World.GetCameraPositionX();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetCameraPositionY==<br />
{{MethodHeader|public obsolete native float GetCameraPositionY(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Y Coordinate of the current camera position.<br />
;Syntax<br />
float Y = World.GetCameraPositionY();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetCameraPositionZ==<br />
{{MethodHeader|public obsolete native float GetCameraPositionZ(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Z Coordinate of the current camera position.<br />
;Syntax<br />
float Z = World.GetCameraPositionZ();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetCameraYaw==<br />
{{MethodHeader|public native float GetCameraYaw(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Current camera yaw, in radians<br />
;Syntax<br />
float yaw = World.GetCameraYaw();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCameraZoom==<br />
{{MethodHeader|public native float GetCameraZoom(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Current camera zoom, in meters<br />
;Syntax<br />
float zoom= World.GetCameraZoom();<br />
;Notes<br />
*<font color=red>Is this value equivalent to '''radius''' in [[#SetCameraAngle|SetCameraAngle()]]?</font><br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCurrentModule==<br />
{{MethodHeader|public native int GetCurrentModule(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An integer representing the current Trainz module.<br />
;Syntax<br />
int module = World.GetCurrentModule();<br />
;Notes<br />
* See [[#Trainz Modules|Trainz Modules]] for details of the constants associated with this method. <br />
* See [[ModuleInit Message]] for further details.<br />
<br><br />
<br />
==GetCurrentProfile==<br />
{{MethodHeader|public native [[Class Asset|Asset]] GetCurrentProfile(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current session asset<br />
;Syntax<br />
Asset currentSession = World.GetCurrentProfile();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetCurrentTrain==<br />
{{MethodHeader|public native Train GetCurrentTrain(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The currently focused train<br />
;Syntax<br />
Train myTrain = World.GetCurrentTrain();<br />
;Notes<br />
* The current train is the one currently controlled by the user, which may not be the train the camera is focused on.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetDriverCharacterList==<br />
{{MethodHeader|public native [[Class DriverCharacter|DriverCharacter]][ ] GetDriverCharacterList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of DriverCharacter objects installed in the current world.<br />
;Syntax<br />
DriverCharacter[] drivers = World.GetDriverCharacterList();<br />
;Notes<br />
<br><br />
<br />
==GetDriverCommandList==<br />
{{MethodHeader|public native [[Class DriverCommand|DriverCommand]][ ] GetDriverCommandList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of DriverCommand objects installed in the current world.<br />
;Syntax<br />
DriverCommand[] commands = World.GetDriverCommandList();<br />
;Notes<br />
<br><br />
<br />
==GetGameDate==<br />
{{MethodHeader|public native int GetGameDate(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game day (1 - 31)<br />
;Syntax<br />
int Now = World.GetGameDate();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGameMonth==<br />
{{MethodHeader|public native int GetGameMonth(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game month (1 - 12)<br />
;Syntax<br />
int Now = World.GetGameMonth();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGameObjectByID==<br />
{{MethodHeader|public native [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetGameObjectByID([[Class GameObjectID|GameObjectID]] objectID, bool bTriggerLoad)<br>public native [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetGameObjectByID([[Class GameObjectID|GameObjectID]] objectID)}}<br />
;Parameters<br />
*'''objectID''' = The ID of the object to find.<br />
*'''bTriggerLoad''' = Optional, defaults to true. Whether to trigger an asynchronous load of any matching object (if it's not loaded already).<br />
;Returned Value<br />
* Asynchronous search result object. <br />
;Syntax<br />
AsyncObjectSearchResult search_result = World.GetGameObjectByID(objectID, true); // Search for and load an object<br />
;Notes<br />
*See [[HowTo/Search for objects in the world]] for a detailed guide on asynchronous searches.<br />
*The retured object is a reference to the in-progress object search.<br />
*When the search completes, a message of type "ObjectSearch","AsyncResult" will be posted to the result object.<br />
*If bTriggerLoad is true, a further message of type "ObjectSearch","AsyncLoadComplete" will be posted when all objects are loaded into memory. This message will still be posted if every object is already loaded.<br />
*Added in TRS19<br />
<br><br />
<br />
==GetGameObjectByIDIfLoaded==<br />
{{MethodHeader|public native [[Class GameObject|GameObject]] GetGameObjectByIDIfLoaded([[Class GameObjectID|GameObjectID]] objectID)}}<br />
;Parameters<br />
*'''objectID''' = The ID of the boject to find.<br />
;Returned Value<br />
* The object, if it exists and is currently loaded.<br />
;Syntax<br />
GameObject my_object = World.GetGameObjectByID(objectID);<br />
if (my_object) Interface.Print("Object exists and is loaded");<br />
;Notes<br />
*Added in TRS19<br />
<br><br />
<br />
==GetGameSeason==<br />
{{MethodHeader|public native float GetGameSeason(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game season<br />
;Syntax<br />
float Season = World.GetGameSeason();<br />
;Notes<br />
*The returned time is normalised to a value between 0.0 and 1.0<br />
*0.0 = mid-summer<br />
*0.5 = mid-winter<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGameTime==<br />
{{MethodHeader|public native float GetGameTime(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game time.<br />
;Syntax<br />
float Now = World.GetGameTime();<br />
;Notes<br />
*The returned time is normalised to a value between 0.0 and 1.0<br />
*0.0 = midday<br />
*0.25 = 6 p.m.<br />
*0.5 = midnight<br />
*0.75 = 6 a.m.<br />
*1.0 = midday again<br />
*Use the [[#Time_Values|Time Value]] constants to convert the normalised values to human readable times.<br />
<br><br />
<br />
==GetGameYear==<br />
{{MethodHeader|public native int GetGameYear(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game year.<br />
;Syntax<br />
int Now = World.GetGameYear();<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetGoodWeatherFog==<br />
{{MethodHeader|public obsolete native float GetGoodWeatherFog(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Good weather fog distance as a float in the range 0.0..1.0.<br />
;Syntax<br />
float dist = World.GetGoodWeatherFog();<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==GetGroundDrawDistance==<br />
{{MethodHeader|public obsolete native float GetGroundDrawDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Ground draw distance in metres.<br />
;Syntax<br />
float dist = World.GetGroundDrawDistance();<br />
;Notes<br />
<br><br />
<br />
==GetIndustryList==<br />
{{MethodHeader|public obsolete native [[Class GameObject|GameObject]][ ] GetIndustryList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the Industry objects for the current route.<br />
;Syntax<br />
GameObject[] Industries = World.GetIndustryList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetJunctionList==<br />
{{MethodHeader|public obsolete native [[Class Junction|Junction]][ ] GetJunctionList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trackside junction objects for the current route.<br />
;Syntax<br />
Junction[] junctions = World.GetJunctionList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
*Junction objects attached to fixed track junctions are not returned by this method.<br />
<br><br />
<br />
==GetLayerList==<br />
{{MethodHeader|public native string[ ] GetLayerList(int layerType)}}<br />
;Parameters<br />
*layerType = LAYER_ROUTE, LAYER_SESSION, or LAYER_BOTH<br />
;Returned Value<br />
*Array of layer names<br />
;Syntax<br />
string[] routeLayerNames = World.GetLayerList(World.LAYER_ROUTE);<br />
;Notes<br />
*<font color=red>Added in ...?</font> <br />
<br><br />
<br />
==GetLayerType==<br />
{{MethodHeader|public native int GetLayerType(string layerName)}}<br />
;Parameters<br />
*layerName = The name of the layer<br />
;Returned Value<br />
*LAYER_ROUTE or LAYER_SESSION<br />
;Syntax<br />
int layerType = World.GetLayerType("MyLayer");<br />
;Notes<br />
*<font color=red>Added in ...?</font> <br />
<br><br />
<br />
==GetLibrary==<br />
{{MethodHeader|public native [[Class Library|Library]] GetLibrary([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of script library asset to load.<br />
;Returned Value<br />
*A reference to the script library asset if successful, null otherwise.<br />
;Syntax<br />
Library codelib = World.GetLibrary(LibraryKUID);<br />
;Notes<br />
*The [[Class Library|Library]] asset is initialised when this method is first called in a session.<br />
*Since only one instance can exist, subsequent calls return a reference to the existing Library object.<br />
*See [[Class Library|Library]] for notes on how to use this method.<br />
<br><br />
<br />
==GetLocalPlayerName==<br />
{{MethodHeader|public native string GetLocalPlayerName(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The name of the local player<br />
;Syntax<br />
string playerName = World.GetLocalPlayerName();<br />
;Notes<br />
* Gets the name of the local player, as should be used for setting ownership on DriverCharacters, etc.<br />
*<font color=red>Added in .TRS19?</font><br />
<br><br />
<br />
==GetNamedObjectList==<br />
{{MethodHeader|public native [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetNamedObjectList(string categoryFilter, string nameFilter, bool bNotifyOfExpiry)<br>public [[Class AsyncObjectSearchResult|AsyncObjectSearchResult]] GetNamedObjectList(string categoryFilter, string nameFilter)}}<br />
;Parameters<br />
*'''categoryFilter''' = A category filter to search for. Optional, provided a nameFilter parameter is provided. A category code reference can be found in [[Class AssetCategory|AssetCategory]].<br />
*'''nameFilter''' = A partial object name to search for. Optional, provided a categoryFilter parameter is provided.<br />
*'''bNotifyOfExpiry''' = Optional, defaults to false. If native code detects that the search results have changed then a message of type "ObjectSearch","Expired" will be posted to the result object, and the calling script can perform a new search if desired<br />
;Returned Value<br />
* Asynchronous search result object. <br />
;Syntax<br />
AsyncObjectSearchResult search_result = World.GetNamedObjectList(AssetCategory.Locomotive, "SD40-2"); // Search for all SD40-2 locomotives in the world<br />
;Notes<br />
*See [[HowTo/Search for objects in the world]] for a detailed guide on asynchronous searches.<br />
*The retured object is a reference to the in-progress object search.<br />
*When the search completes, a message of type "ObjectSearch","AsyncResult" will be posted to the result object.<br />
*With expiration notices are enabled, only one notification of type "ObjectSearch","Expired" will be posted for each search.<br />
*Added in TRS19<br />
<br><br />
<br />
==GetSceneryDrawDistance==<br />
{{MethodHeader|public obsolete native float GetSceneryDrawDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Undefined.<br />
;Notes<br />
*Included for legacy script compatibility only. Has no effect.<br />
<br><br />
<br />
==GetSeconds==<br />
{{MethodHeader|public native float GetSeconds(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current value of a floating point number incrementing once per second in real time.<br />
;Syntax<br />
float start = World.GetSeconds();<br />
// do stuff<br />
float finish = World.GetSeconds();<br />
float period = finish - start;<br />
;Notes<br />
*Each call will return a float value containing the current value of an internal counter.<br />
*Subtracting a later value from a value saved at an earlier call will enable the delay between the two calls to be established.<br />
<br><br />
<br />
==GetSignalList==<br />
{{MethodHeader|public obsolete native [[Class Signal|Signal]][ ] GetSignalList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the signal objects for the current route.<br />
;Syntax<br />
Signal[] signals = World.GetSignalList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetStringTable==<br />
{{MethodHeader|public native [[Class StringTable|StringTable]] GetStringTable(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*The StringTable for the current session.<br />
;Syntax<br />
StringTable data = World.GetStringTable();<br />
;Notes<br />
<br><br />
<br />
==GetSurveyorSavedConsist==<br />
{{MethodHeader|public obsolete native [[Class Soup|Soup]] GetSurveyorSavedConsist(string name)}}<br />
;Parameters <br />
*'''name''' = Name of the consist to retrieve.<br />
;Returned Value<br />
*Returns a Soup definition of the named consist if it exists, null otherwise.<br />
;Syntax<br />
Soup consist = World.GetSurveyorSavedConsist("Brighton Belle");<br />
;Notes<br />
*Remember that the returned data is in a Soup format, which is not the same thing as a Train. <br />
*[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]] can be used to create a train from the returned Soup.<br />
*This method only works in Surveyor.<br />
*Obsolete in TRS19.<br />
<br><br />
<br />
==GetSurveyorSavedConsistList==<br />
{{MethodHeader|public native string[ ] GetSurveyorSavedConsistList()}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of names of all the saved consist objects in Surveyor.<br />
;Syntax<br />
string[] consists = World.GetSurveyorSavedConsistList();<br />
;Notes<br />
*This method only works in Surveyor.<br />
*Obsolete in TRS19.<br />
<br><br />
<br />
==GetTimeElapsed==<br />
{{MethodHeader|public native float GetTimeElapsed(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The number of real-time seconds that have passed since the start of the current session. <br />
;Syntax<br />
float secondsElapsed = World.GetTimeElapsed();<br />
;Notes<br />
*This measure of time stops passing while the game is paused.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==GetTrackmarkList==<br />
{{MethodHeader|public obsolete native [[Class TrackMark|TrackMark]][ ] GetTrackmarkList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trackmark objects for the current route.<br />
;Syntax<br />
Trackmark[] trackmarks = World.GetTrackmarkList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetTrainList==<br />
{{MethodHeader|public obsolete native [[Class Train|Train]][ ] GetTrainList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trains for the current route.<br />
;Syntax<br />
Train[] trains = World.GetTrainList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetTrainzBuild==<br />
{{MethodHeader|public native int GetTrainzBuild(void)}}<br />
;Parameters;<br />
*None<br />
;Returned Value<br />
*Gets the current build number of Trainz. <br />
;Syntax<br />
int build = World.GetTrainzBuild();<br />
;Notes<br />
*The value returned corresponds to the build number you can see in the bottom-right side of the main Trainz menu screen.<br />
<br><br />
<br />
==GetTrainzVersion==<br />
{{MethodHeader|public native float GetTrainzVersion(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The TRS version number.<br />
;Syntax<br />
float version = World.GetTrainzVersion();<br />
;Notes<br />
*The value returned corresponds to the version number of Content manager (for example 4.6). <br />
<br><br />
<br />
==GetTriggerList==<br />
{{MethodHeader|public obsolete native [[Class Trigger|Trigger]][ ] GetTriggerList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trigger objects for the current route.<br />
;Syntax<br />
Trigger[] triggers = World.GetTriggerList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
*This method does not return scenery triggers, ie those attached to SceneryWithTrack objects and their descendants.<br />
<br><br />
<br />
==GetVehicleList==<br />
{{MethodHeader|public obsolete native [[Class Vehicle|Vehicle]][ ] GetVehicleList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the vehicles in the current route.<br />
;Syntax<br />
Vehicle[] vehicles = World.GetVehicleList();<br />
;Notes<br />
*This function is obsolete and should not be used. Use [[#GetNamedObjectList|GetNamedObjectList]] instead.<br />
<br><br />
<br />
==GetWeatherChangeability==<br />
{{MethodHeader|public native int GetWeatherChangeability(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*One of the [[#Weather_Changeability_Constants|Weather Changeability Constants]] denoting the variability of weather conditions.<br />
;Syntax<br />
int variability = World.GetWeatherChangeability();<br />
;Notes<br />
<br><br />
<br />
==GetWeatherType==<br />
{{MethodHeader|public native int GetWeatherType(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*One of the [[#Weather_Type_Constants|Weather Type Constants]] denoting the current weather conditions.<br />
;Syntax<br />
int weather = World.GetWeatherType();<br />
;Notes<br />
<br><br />
<br />
==IsAssetRestrictionInEffect==<br />
{{MethodHeader|public native bool IsAssetRestrictionInEffect(string)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Whether this game world has Asset Restrictions. <br />
;Syntax<br />
bool assetRestrictionsExist = World.IsAssetRestrictionInEffect();<br />
;Notes<br />
*Multiplayer Sessions require Asset Restrictions to be in effect to avoid compatibility issues between peers.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==IsLayerVisible==<br />
{{MethodHeader|public native bool IsLayerVisible(string layerName)}}<br />
;Parameter<br />
*layerName = Name of the layer to check<br />
;Returned Value<br />
*Whether the layer is visible<br />
;Syntax<br />
bool isVisible = World.IsLayerVisible("MyLayer");<br />
;Notes<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==LoadMap==<br />
{{MethodHeader|public native bool LoadMap([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of map to load.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
if (World.LoadMap(mapKUID) Interface.Print("Map loaded OK");<br />
else Interface.Print("Map load failed");<br />
;Notes<br />
*Use World.[[#FindKUID|FindKUID()]] to find the desired route KUID.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==LoadSession==<br />
{{MethodHeader|public native bool LoadSession([[Class KUID|KUID]] kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of session to load.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
if (World.LoadSession(sessionKUID) Interface.Print("Session loaded OK");<br />
else Interface.Print("Session load failed");<br />
;Notes<br />
*Use World.[[#FindKUID|FindKUID()]] to find the desired session KUID.<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==Play2DSound==<br />
{{MethodHeader|public float Play2DSound([[Class Asset|Asset]] asset, string wave)}}<br />
;Parameters<br />
*'''asset''' = Asset where the sound file is located.<br />
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.<br />
;Returned Value<br />
* Undefined.<br />
;Syntax<br />
// Play the sound and continues script execution.<br />
World.Play2DSound(soundAsset,"sounds/allaboard.wav"); <br />
// Wait until sound has completed before continuing (pre-TS12 only!)<br />
Sleep(World.Play2DSound(soundAsset,"sounds/allaboard.wav")); <br />
;Notes<br />
*Plays a ''.wav" sound file from the given asset's folder.<br />
*The sound is non directional and can be mono or stereo. <br />
*This method does not return after the sound has finished playing, it returns with the length of the sound as soon as it is called. <br />
*This means your code will keep on executing while Trainz is playing the sound.<br />
<br><br />
<br />
==PlaySound==<br />
{{MethodHeader|public native float PlaySound<br>&nbsp;&nbsp;&nbsp;&nbsp;([[Class Asset|Asset]] asset, string wave, float vol, float near, float far, [[Class GameObject|GameObject]] target, string pt)<br>&nbsp;&nbsp;&nbsp;&nbsp;([[Class Asset|Asset]] asset, string wave, float vol, float near, float far, [[Class GameObject|GameObject]] target, string pt, bool loop)}}<br />
;Parameters<br />
*'''asset''' = Asset where the sound file is located.<br />
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.<br />
*'''vol''' = Volume level to play the sound at (0 to 1)<- These values taken from TRS2019 world.gs file comments<br />
*'''near''' = Distance from the target asset at which the sound will be played at maximum volume.<br />
*'''far''' = Distance from the target asset at which the sound will become inaudible.<br />
*'''target''' = GameObject to which the sound will be attached if a 3d sound is required, null for 2D.<br />
*'''pt''' = Name of attachment point in the target object if a 3d sound is required, null for 2D.<br />
*'''loop''' = (Optional) If true the sound will loop continuously.<br />
;Returned Value<br />
* Sound length in seconds for Trainz before TS12<br />
* Undefined for TS12 and TANE<br />
;Syntax<br />
// Play the sound and continues script execution.<br />
World.PlaySound(soundAsset,"sounds/allaboard.wav",1.0,10.0,100.0,Station,"a.loudspeaker"); <br />
// Wait until sound has completed before continuing (pre-TS12 only!)<br />
Sleep(World.PlaySound(soundAsset,"sounds/allaboard.wav",1000.0,10.0,100.0,Station,"a.loudspeaker"); <br />
;Notes<br />
*Plays a ''.wav'' sound file from the given asset's folder.<br />
*If the sound is to be directional a mono sound file is required. <br />
*This method does not return after the sound has finished playing: it returns as soon as it is called. <br />
*This means your code will keep on executing while Trainz is playing the sound.<br />
*If you want to wait for the sound to complete playing before moving on, wrap the PlaySound() call up in a Sleep() call. '''Note!''' This works only in Trainz versions before TS12. For newer versions, TS12 and TANE, you can hard-code the duration of the sound, or store it in the extensions container of the config.txt file.<br />
*The sound volume will be at a maximum for a camera position at or less than the value of the ''near'' parameter and will reduce with distance until the hearing position reaches ''far'', when the sound will be inaudible.<br />
<br><br />
<br />
==RemoveDriverCharacter==<br />
{{MethodHeader|public native void RemoveDriverCharacter([[Class DriverCharacter|DriverCharacter]] driver)}}<br />
;Parameters<br />
*'''driver''' = DriverCharacter to remove.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.RemoveDriverCharacter(dave);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==RemoveDriverCommand==<br />
{{MethodHeader|public native void RemoveDriverCommand([[Class DriverCommand|DriverCommand]] command)}}<br />
;Parameters<br />
*'''command''' = DriverCommand to remove.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.RemoveDriverCommand(driverCommand);<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==RestartSession==<br />
{{MethodHeader|public native bool RestartSession()}}<br />
;Parameters<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.RestartSession();<br />
;Notes<br />
*Valid in Driver mode only.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==SetBadWeatherFog==<br />
{{MethodHeader|public obsolete native void SetBadWeatherFog(float distance)}}<br />
;Parameters<br />
*'''distance''' = Bad weather fog distance to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetBadWeatherFog(0.5);<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==SetCamera==<br />
{{MethodHeader|public native bool SetCamera([[Class MapObject|MapObject]] focus)<br>public native void SetCamera([[Class Junction|Junction]] focus)<br>public native void SetCamera([[Class Vehicle|Vehicle]] focus, int cameraMode)<br>public native void SetCamera([[Class Train|Train]] focus, int cameraMode)}}<br />
;Parameters<br />
*'''focus''' = Object on which the camera is to be focused.<br />
*''cameraMode''' = One of the [[#Camera_View_Modes|Camera View Mode]] constants defining the view which should be assigned to the camera.<br />
;Returned Value<br />
*The first variant returns a boolean to indicate success or failure.<br />
*Remaining variants do not return a value<br />
;Syntax<br />
World.SetCamera(train.GetVehicles[0],World.CAMERA_TRACKING); // sets the camera to track the first vehicle in the train.<br />
;Notes<br />
*<font color=red>Junction alias removed in TRS19?</font><br />
<br><br />
<br />
==SetCameraAngle==<br />
{{MethodHeader|public void SetCameraAngle(float yaw, float pitch, float radius)<br>public obsolete void SetCameraAngle(int yaw, int pitch, float radius)}}<br />
;Parameters<br />
*'''yaw''' = Camera rotation in radians (float) or degrees (int), 90 is a direct front view.<br />
*'''pitch''' = Camera angle relative to the horizon in radians (float), or degrees (int), 0 is horizontal, 90 points vertically upwards.<br />
*'''radius''' = Distance in metres to the object in focus.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetCameraAngle(90,0,25); // Sets the camera to a direct frontal view at 25 metres from the currently focused object.<br />
;Notes<br />
*''Radius'' is measured from the object origin point (0,0,0). If there's no target object this will be the distance to the ground.<br />
*Note difference in units of ''yaw'' and ''pitch'' depending in the method signature used.<br />
*The integer version of this method call is obsolete in TRS19.<br />
<br><br />
<br />
==SetCameraFlags==<br />
{{MethodHeader|public native void SetCameraFlags(int flags)}}<br />
;Parameter<br />
*'''flags''' integer value defining what the user is permitted to do with the game camera.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
// User is permitted to select External or Tracking views only.<br />
World.SetCameraFlags(World.CAMERA_EXTERNAL | World.CAMERA_TRACKING);<br />
;Notes<br />
*Use any combination of [[#Camera_Flags|Camera Flags]] and [[#Camera_View_Modes|Camera View Modes]] to set the parameter.<br />
<br><br />
<br />
==SetCameraMode==<br />
{{MethodHeader|public void SetCameraMode(int mode)}}<br />
;Parameter<br />
*'''mode''' = Camera mode to select.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetCameraMode(World.CAMERA_TRACKING);<br />
;Notes<br />
*Use one of the [[#Camera_View_Modes|Camera View Modes]] to set the parameter.<br />
<br><br />
<br />
==SetEditingCamera==<br />
{{MethodHeader|public void SetEditingCamera([[Class GameObject|GameObject]] actor, bool bIsActorEditingCamera)}}<br />
;Parameter<br />
*'''actor''' = The script who is intended to edit the camera position.<br />
*'''bIsActorEditingCamera''' = True to begin editing, or False to end the editing operation. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetEditingCamera(myScript, true);<br />
;Notes<br />
*Hints to the caching systems that the camera position is in the process of being changed. This may reduce the amount of streaming that will occur until the change is complete.<br />
*This is intended for use-cases where the decision to move the camera happens in advance of the actual call to [[#SetCamera|SetCamera()]] or etc., for example when the new camera target needs to be streamed in first.<br />
*There is no advantage in calling this unless your code then sleeps/waits before undoing the call.<br />
*It is not required to call this before using SetCamera() etc.<br />
*A boolean state is stored per actor; multiple calls to enable editing on a single actor do not need to be matched to multiple calls to disable editing.<br />
*It is counterproductive to call this when transitioning the camera over a short distance (ie. where the source and target locations can see each other). If jumping to a new location, followed by a visual camera transition at the new location, camera editing may be enabled around the target-selection for the jump, and the jump itself, but should be disabled before proceeding with the transition.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==SetGameDate==<br />
{{MethodHeader|public void SetGameDate(int year, int month, int date)}}<br />
;Parameters<br />
*'''year''' = The year to set (1970-2038)<br />
*'''month''' = The month to set (1-12)<br />
*'''day''' = The day to set (1-31)<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameDate(2000, 12, 25); // sets date to 25 December 2000<br />
;Notes<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==SetGameTime==<br />
{{MethodHeader|public void SetGameTime(float time)}}<br />
;Parameters<br />
*'''time''' = new gane time to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameTime(0.5); // sets time to midnight<br />
;Notes<br />
*Game time is normalised to a value between 0.0 and 1.0<br />
*0.0 = midday<br />
*0.25 = 6 p.m.<br />
*0.5 = midnight<br />
*0.75 = 6 a.m.<br />
*1.0 = midday again<br />
*Use the [[#Time_Values|Time Value]] constants to convert human readable times to normalised values. <br />
<br><br />
<br />
==SetGameTimeRate==<br />
{{MethodHeader|public native void SetGameTimeRate(float rate)}}<br />
;Parameters<br />
*'''rate''' = New time rate to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameTimeRate(World.TIME_RATE_8X); // sets game time to advance by 8 minutes per minute of real world time.<br />
;Notes<br />
*Use one of the [[#Time_Rate_Constants|Time Rate Constants]] to define the parameter.<br />
*In multiplayer, this will only succeed on the server.<br />
<br><br />
<br />
==SetGoodWeatherFog==<br />
{{MethodHeader|public obsolete native void SetGoodWeatherFog(float distance)}}<br />
;Parameters<br />
*'''distance''' = Good weather fog distance to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGoodWeatherFog(0.5);<br />
;Notes<br />
*Obsolete in TRS19<br />
<br><br />
<br />
==SetGroundDrawDistance==<br />
{{MethodHeader|public obsolete native void SetGroundDrawDistance(float distance)}}<br />
;Parameters<br />
*'''distance''' = Ground draw distance in metres.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGroundDrawDistance(1000.0);<br />
;Notes<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==SetLayerVisible==<br />
{{MethodHeader|public native void IsLayerVisible(string layerName, bool visible)}}<br />
;Parameter<br />
*layerName = Name of the layer to check<br />
*visible = Whether to set the layer visible or not<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.IsLayerVisible("MyLayer", False);<br />
;Notes<br />
*Show/Hide a route/session layer.<br />
*In multiplayer, this will only succeed on the server.<br />
*<font color=red>Added in ...?</font><br />
<br><br />
<br />
==SetSceneryDrawDistance==<br />
{{MethodHeader|public obsolete native void SetSceneryDrawDistance(float distance)}}<br />
;Parameters<br />
*'''distance''' = unused.<br />
;Returned Value<br />
*None<br />
;Notes<br />
* Does nothing. Included for script compatibility only.<br />
<br><br />
<br />
==SetTargetObserver==<br />
{{MethodHeader|public void SetTargetObserver([[Class GameObject|GameObject]] observer)}}<br />
;Parameters<br />
*'''observer''' = The game object to receive targeting messages.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetTargetObserver(self);<br />
;Notes<br />
* It is unlikely a script programmer would ever need to use this method.<br />
* Causes the specified object to receive "Track", "LeftClick" messages when a track is clicked. Causes the specified object to receive "Interface-Event", "Left-Click" messages when a targetable MapObject is clicked. May cause the functionality of a left mouse click to change from what the user is expecting, so should be used with caution. Used in modal scripts to allow the user to indicate a location for train placement, etc. As there is only a single observer at any given time, the script must take care to only call this function when entering placement mode at the user's request.<br />
<br><br />
<br />
==SetWeather==<br />
{{MethodHeader|public native void SetWeather(int type, int changeability)}}<br />
;Parameters<br />
*'''type''' = Weather conditions as defined by one of the [[#Weather_Type_Constants|Weather Type Constants]].<br />
*'''change''' = Weather variation as defined by one of the [[#Weather_Changeability_Constants|Weather Changeability Constants]].<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetWeather(World.WEATHER_TYPE_HEAVY_SNOW,World.WEATHER_CHANGEABILITY_EXTREME); // April in Paris.<br />
;Notes<br />
<br><br />
<br />
==SetWorldEditModeEnabled==<br />
{{MethodHeader|public native bool SetWorldEditModeEnabled(int editFlags, bool enable)}}<br />
;Parameters<br />
*'''editFlags''' = Bitmask specifying which modes to alter, see PERMIT_EDIT_*<br />
*''cameraMode''' = Whether to enable or disable the mode<br />
;Returned Value<br />
*Whether the change was completely successful<br />
;Syntax<br />
World.SetWorldEditModeEnabled(World.PERMIT_EDIT_TRAINS | World.PERMIT_EDIT_CONSISTS, True); // Enable player editing of trains and consists<br />
;Notes<br />
*This does not affect scripts which may alter the world, only the availability of the player world editing tools (i.e, the Surveyor tabs).<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==SynchronouslyLoadGameObjectByID==<br />
{{MethodHeader|public [[Class GameObject|GameObject]] SynchronouslyLoadGameObjectByID([[Class GameObjectID|GameObjectID]] objectID)}}<br />
;Parameters<br />
*'''objectID''' = The ID of the object to find.<br />
;Returned Value<br />
* The object, if it exists.<br />
;Syntax<br />
GameObject my_object = World.SynchronouslyLoadGameObjectByID(objectID);<br />
if (my_object Interface.Print("Object exists and has been loaded if required");<br />
;Notes<br />
*This function is usable only by script 'thread' functions and will throw an exception if called incorrectly.<br />
*Added in TRS19<br />
<br><br />
<br />
==UpdatePositionToGroundHeight==<br />
{{MethodHeader|public native bool UpdatePositionToGroundHeight([[Class WorldCoordinate|WorldCoordinate]] position)}}<br />
;Parameters<br />
*'''position''' (in, out) = Position object to update with the ground height at it's location<br />
;Returned Value<br />
* True if the ground position was updated<br />
;Syntax<br />
if (World.UpdatePositionToGroundHeight(position) Interface.Print("Position was updated");<br />
;Notes<br />
*This updates the input ''position'' object with the ground height at that location.<br />
*This process may fail if the ground data at the specified location is not currently loaded.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==UpdatePositionToSurfaceHeight==<br />
{{MethodHeader|public native bool UpdatePositionToSurfaceHeight([[Class WorldCoordinate|WorldCoordinate]] position)}}<br />
;Parameters<br />
*'''position''' (in, out) = Position object to update with the water height at it's location<br />
;Returned Value<br />
* True if the ground position was updated<br />
;Syntax<br />
if (World.UpdatePositionToGroundHeight(position) Interface.Print("Position was updated");<br />
;Notes<br />
*This updates the input ''position'' object with the water height at that location. If no water is present, the position is adjusted to the ground height.<br />
*This process may fail if the ground data at the specified location is not currently loaded.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==UserSetCamera==<br />
{{MethodHeader|public native bool UserSetCamera([[Class GameObject|GameObject]] target)}}<br />
;Parameters<br />
*'''target''' = GameObject to set focus to.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.UserSetCamera(Router,GetGameObject("Junction 5"));<br />
;Notes<br />
<br><br />
<br />
==UserSetCameraMode==<br />
{{MethodHeader|public native void UserSetCameraMode(int mode)}}<br />
;Parameters<br />
*'''mode''' = One of the [[#Camera_View_Modes|Camera View Modes]]<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.UserSetCameraMode(World.CAMERA_ROAMING); // switches to roaming view if permitted.<br />
;Notes<br />
*This method respects the current [[#Camera_Flags|Camera Flag]] settings, disallowing any change which the flags do not permit.<br />
<br><br />
<br />
==UserSetCameraPosition==<br />
{{MethodHeader|public native bool UserSetCamera([[Class WorldCoordinate|WorldCoordinate]] camPos)}}<br />
;Parameters<br />
*'''camPos''' = World coordinates to set camera to<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.UserSetCamera(Router,GetGameObject("Junction 5"));<br />
;Notes<br />
* For camera modes which do not need to target specific objects, this allows the camera to be set to an arbitrary world position.<br />
*<font color=red>Added in TRS19?</font><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=HowTo/Search_for_objects_in_the_world&diff=33201HowTo/Search for objects in the world2022-07-27T20:18:42Z<p>Ciceronmt: /* Named Object Searches */</p>
<hr />
<div>Scripted asset may sometimes wish to search for other objects within the world, either in bulk lists, or for a specific single object. This page is intended to provide an overview of how this is achieved in the latest versions of Trainz. Details about certain legacy search methods and the best modern techniques to update them to are also provided in the final section of this page.<br />
<br />
==Object Identification==<br />
Scripted objects identified in script using several different methods, many of which have become obsolete as Trainz and the script environment has grown in complexity. As of trainz-build 4.5 (TANE SP2 and later) scripted objects should be identified using their GameObjectID, where present. This ID format has been designed to be future-proof/extensible, should the need arise, and supports various lookup and generic storage functions as per the legacy integer and string based IDs. For more information about legacy ID formats, see [[HowTo/Search_for_objects_in_the_world#Legacy_Search_Functions|here]].<br />
<br />
The GameObjectID class is defined within GameObjectID.gs, which can be found in the Trainz core script folder (resources/scripts). For the most up to date and accurate usage instructions please see the comments within that file.<br />
<br />
==Named Object Searches==<br />
It is occasionally desirable for scripted assets to be able to search for objects within the world. Most commonly, this is a requirement of session rules, which frequently require a session creator to specify target trains, junctions, signals, etc, in order to perform some gameplay function. Occasionally, placable assets such as industries etc may also require this feature. One such example is the Interlocking Tower asset type, which performs complex management of track blocks using management of user defined signals, junctions and crossings.<br />
<br />
As of trainz-build 4.5 (TANE SP2 and later) manual object searches are performed via the World.GetNamedObjectList() function. This function takes both a [[Category_List|category list]] and a partial name, allowing for very specific searches, or quite broad ones. Once called, this function returns an object of type AsyncObjectSearchResult, which is used to monitor for the search completion, and then to retrieve the results. For the most up to date and accurate information on how to use GetNamedObjectList and AsyncObjectSearchResult, please see their script comments in World.gs and AsyncObjectSearch.gs (respectively), which can be found in the Trainz core script folder (resources/scripts).<br />
<br />
Usage example:<br />
<br />
thread void SearchForTrains()<br />
{<br />
// Start a search for any traincars within the world<br />
AsyncObjectSearchResult asyncSearch = World.GetNamedObjectList(AssetCategory.TrainCar, "");<br />
<br />
// Sniff for search related messages, and then wait for either completion or failure<br />
Sniff(searchObj, "ObjectSearch", "", true);<br />
Message msg;<br />
wait()<br />
{<br />
on "ObjectSearch", "Failure", msg:<br />
if (msg.src == asyncSearch)<br />
break;<br />
continue;<br />
<br />
on "ObjectSearch", "AsyncLoadComplete", msg:<br />
if (msg.src == asyncSearch)<br />
break;<br />
continue;<br />
};<br />
<br />
// Check the results<br />
int errCode = asyncSearch.GetSearchErrorCode();<br />
if (errCode != AsyncObjectSearchResult.ERROR_NONE)<br />
{<br />
// TODO: Add any error handling here, such as waiting and reattempting the<br />
// search later, showing an error message, throwing script exceptions, etc.<br />
return;<br />
}<br />
<br />
// Get the search results<br />
NamedObjectInfo[] results = searchObj.GetResults();<br />
<br />
// TODO: Add any processing of the results here<br />
}<br />
<br />
==Storing References to Specific Objects==<br />
As shown in the example above, named object searches return their results as an array of NamedObjectInfo objects. Currently, this class has 4 member variables:<br />
* objectRef - A reference to the object, if it is currently loaded<br />
* objectId - The GameObjectID for the object (see GameObjectID.gs)<br />
* localisedUsername - The localised name of the object, for displaying to the player<br />
* categoryString - A category string, usable to further determine the exact type and features of the object<br />
<br />
Any script which wishes to save a reference to specific named object should /always/ do so via the GameObjectID. This is currently the /only/ safe and reliable way to store and later retrieve a specific object. If the object is currently loaded it is of course also safe to access and store a reference to the object itself, but note that Trainz may choose to unload the object at any time (if it is inactive, and sufficiently far enough away from the player, etc). Attempts to use an object which native code has unloaded may result in native call errors. To avoid this scripts should call Router.DoesGameObjectStillExist() before attempting to use any object reference that has been stored for some time.<br />
<br />
Unlike the named object itself, a referenced GameObjectID will never be deleted by native code, and may be held by a script indefinitely. It can also be stored directly into a [[Soup]] database for storage and retrieval between runs of the game, over a network, etc. For details about saving a GameObjectID into a Soup database please see the comments in Soup.gs, located in the core Trainz script folder (resources/scripts).<br />
<br />
In addition to Soup storage, a GameObjectID can be serialised to a string for *temporary* storage. This allows scripts to do things like store the ID directly in a trainzhttp link, etc (provided it is also appropriately escaped). However, it is crucial to note that the format of this string is *not* guaranteed and may change between versions of the game. As such, no attempt should be made to machine parse it, save it between runs or send it over a network. To convert the string back into a GameObjectID, use Router.SerialiseGameObjectIDFromString().<br />
<br />
It is also safe to cache and store the localised display name for an object, but it is important to remember that objects can be renamed, and that this object name may become out of date at any time. As such, scripts which store it should remember to update their cache whenever an opportunity arises (e.g. during any validation steps).<br />
<br />
==Searching for Specific Objects by ID==<br />
Several functions exist for looking up an object which has been saved via it's GameObjectID. Each of these serves a slightly different use-case, so it's important to understand them all before selecting the one that best suits the needs of a specific script.<br />
<br />
Two functions exist to retrieve a loaded object via it's ID. These both behave identically, and will return a reference to a matching object *only* if that object exists and is currently loaded. In all other cases the functions will return null. There is no way to determine the cause of a null result using these functions.<br />
<br />
GameObject objectRef1 = World.GetGameObjectByIDIfLoaded(mySavedID);<br />
<br />
GameObject objectRef2 = Router.GetGameObject(mySavedID);<br />
<br />
Another function exists to allow scripts to search for objects which are not currently loaded, and to optionally request that they are loaded. Scripts should only request loading of objects when absolutely necessary, and scripts which abuse this feature may have their requests ignored by native code in order to maintain performance. As this function may take a considerable amount of time to run, it uses an AsyncObjectSearchResult, much like the named object list functions described above.<br />
<br />
AsyncObjectSearchResult searchObj = World.GetGameObjectByID(mySavedID, false);<br />
<br />
As with GetNamedObjectList(), calling scripts must Sniff the returned search object and wait for the appropriate result message(s) to be posted. To avoid the need for frequent code duplication another function also exists which allows threaded objects to perform this functionality in a pseudo-synchronous way.<br />
<br />
GameObject loadedObjectRef = World.SynchronouslyLoadGameObjectByID(mySavedID);<br />
<br />
This function will throw exceptions if used incorrectly (e.g. if called outside of a thread function) so be sure to read and understand the comments on the function itself, before attempting to use it.<br />
<br />
==Script Library Lookups==<br />
Script [[KIND_Library|library assets]] are unique within script in that they exist without any visual presence to the end player, and are shared across all scripts that access them. i.e. It is not possible to instantiate multiple instances of the same library asset within a single script context. This makes them extremely useful for managing, organising or communicating between other scripted asset types. For more information about library assets, see the [[KIND_Library]] page.<br />
<br />
As libraries are added to the world by script, and the not the player or session creator, they require a script accessible function to create and load them. This function is TrainzScriptBase.GetLibrary(). When this function is called the library asset will be immediately loaded and returned by Trainz native code. Once loaded into the current script context, the library will remain loaded, and any future calls to GetLibrary() will return the same instance.<br />
<br />
Example usage:<br />
public void Init(Asset asset)<br />
{<br />
inherited(asset);<br />
<br />
// Load our shared library asset<br />
KUID libraryKuid = asset.LookupKUIDTable("shared-library");<br />
m_sharedLibrary = World.GetLibrary(libraryKuid);<br />
<br />
// TODO: Add any library specific init, registration, etc code here<br />
}<br />
<br />
==Legacy Search Functions==<br />
Prior to trainz-build 4.5 (TANE SP1 and earlier) all world objects were loaded on Route/Session load, and remained that way until the session was ended. As Routes grow larger and larger this technique becomes unmanageable, and it is thus necessary for Trainz (and it's scripted assets) to support the unloading of objects which are not currently gameplay relevant. As a result of this, numerous script functions have been declared obsolete, as they are incompatible with this concept. Below is a summary of these functions and a mention of their modern replacements.<br />
<br />
Note that none of the legacy functions listed here will operate correctly if the game has the "[[Compatibility mode]]" setting set to "Maximise performance" or "Show errors on legacy calls".<br />
<br />
=====GameObject.GetId()=====<br />
All GameObject instances within a Router are assigned a numeric integer ID. This ID was traditionally retrieved via this function. As the ID varies between runs it was never safe for long term storage, but it was suitable for short term storage and lookup. As objects can now be unloaded at any time, and these IDs then reused by totally different objects, the function has been declared obsolete. Any scripts which use it should be updated to instead use GameObjectID and the related storage functions. See the comments on GameObjectID.gs for more information.<br />
<br />
=====GameObject.GetName()=====<br />
In addition to their integer ID certain GameObject types also supported a "script name", which was generally automatically assigned on creation, but could also be edited by the player in some scenarios. Despite the script comments in certain older versions of Trainz, this name was never ''guaranteed'' unique, but it was generally considered to be so for ease of use (and that assumption rarely failed). This script name was typically used for object identification in medium to long term storage, including within Soups for session config, savegames, etc. Any scripts which use it should be updated to instead use GameObjectID and the related storage functions. See the comments on GameObjectID.gs for more information.<br />
<br />
=====Router.GetGameObject(int)=====<br />
Much like GetGameObject(GameObjectID), this function would return any loaded object with the integer Router ID passed. As this ID format is now considered obsolete, so is this lookup function. Any scripts which use it should be updated to instead use GameObjectID and that function variant (or the async search functions on World). See the comments on GameObjectID.gs for more information.<br />
<br />
=====Router.GetGameObject(string)=====<br />
Much like GetGameObject(GameObjectID), this function would return any loaded object with the "script name" string passed. As this ID format is now considered obsolete, so is this lookup function. Any scripts which use it should be updated to instead use GameObjectID and that function variant (or the async search functions on World). See the comments on GameObjectID.gs for more information.<br />
<br />
=====World.Get*List()=====<br />
Prior to GetNamedObjectList() multiple functions existed on World to manually retrieve lists of objects of a specific type (e.g. GetIndustryList(), GetTrainList(), etc). These search functions were slow, and scripts would often stall Trainz while the searches were performed. Because of this, and the fact that the functions can now only return those objects that are currently loaded, they have been declared obsolete. Any scripts which use them for custom functionality should be updated to instead call World.GetNamedObjectList() with an appropriate category string. See the comments on this function and the AsyncObjectSearchResult in World.gs for more information on their use. Alternatively, any scripts using them for PropertyObject "list" types may be better served by the new "map-object" type, detailed [[PropertyObject#GetPropertyType|here]].<br />
<br />
==See Also==<br />
* [[Asynchronous_Route_Streaming| Asynchronous Route Streaming]]<br />
* [[Compatibility_mode| Compatibility Mode Setting]]<br />
* [[HowTo/Upgrade_obsolete_script_functions| How to update obsolete script functions]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Browser&diff=29705Class Browser2021-06-19T10:32:51Z<p>Ciceronmt: /* SetWindowRect */</p>
<hr />
<div>*[[TrainzScript Library Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****Browser<br />
<br><br />
<br />
*This class provides an interface with the Trainz [[MiniBrowser]] allowing the programmer to provide a simple HTML interface.<br />
*The browser supports a small subset of HTML code.<br />
*Muliple browsers are supported.<br />
*To create a new Browser, use [[Class Constructors#NewBrowser|Constructors.NewBrowser()]].<br />
*To populate with HTML code use either [[#LoadHTMLString|LoadHTMLString]] or [[#LoadHTMLFile|LoadHTMLFile]]<br />
*Refer to the [[MiniBrowser]] page for details of supported tags.<br />
<br><br />
<br />
==Messages==<br />
*Messages sent to and from Browser objects are listed below:<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[Browser Messages|Browser-URL]]||''URL''||Browser||Broadcast<br />
|-<br />
|[[Browser Messages|Browser-Closed]]||null||Browser||Broadcast<br />
|}<br />
<br><br />
*The ''URL '' in a ''Browser-URL'' message uses a special hyperlink tag in the form ''live://linkname''.<br />
*If your HTML contains the link ''<a href=live://anthem>Play the national anthem</a>'' and the user clicks on the link, then the Browser-URL message will take the form of ''Browser-URL,live://anthem'' and your script can intercept the message and respond accordingly.<br />
*Since messages from Browser objects are always broadcast it is crucial that you ensure that the message is originating from the expected window. You can do this by inspecting the source of the message.<br />
*When the user closes the browser window by either clicking on the close button or pressing the Esc key, a message with a ''Browser-Closed'' message is broadcast. The Browser object would normally be reset to null in response, so that the browser window disappears. <br />
<br><br />
<br />
==Constants==<br />
*Constants defined in this class are:<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|bgcolor=#EEEEEE|<b>Browser Window Styles</b>||bgcolor=#EEEEEE| <br />
|-<br />
|width=300|public define int STYLE_NO_FRAME = 0 ||Frameless Browser (not in a bordered window).<br />
|-<br />
|public define int STYLE_DEFAULT = 1 ||Default browser style. This is defined by Trainz itself and usually means the browser window will have a framed border.<br />
|-<br />
|public define int STYLE_TOOLTIP = 2 ||Browser with no frame and no facility for user interaction.<br />
|}<br />
<br><br />
<br />
==General Methods==<br />
===BringToFront===<br />
{{MethodHeader|public native void BringToFront(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.BringToFront();<br />
;Notes<br />
*Brings the window in front of all other browsers.<br />
<br><br />
<br />
===GetAsset===<br />
{{MethodHeader|public native Asset GetAsset(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The Asset from which this Browser is loading html data and resources.<br />
;Syntax<br />
Asset asset = browser.GetAsset();<br />
;Notes<br />
*The returned asset will be the asset used in the last call to [[#LoadHTMLFile|LoadHTMLFile]] or [[#LoadHTMLString|LoadHTMLString]].<br />
*If there has been no such call the returned value will be null.<br />
<br><br />
<br />
===GetWindowVisible===<br />
{{MethodHeader|public native bool GetWindowVisible(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True to indicate that the browser is currently visible on screen, false that the browser is hidden.<br />
;Syntax<br />
hidden = !browser.GetWindowVisible();<br />
;Notes<br />
<br><br />
<br />
===LoadHTMLFile===<br />
{{MethodHeader|public native void LoadHTMLFile(Asset asset, string filename)}}<br />
;Parameters<br />
*'''asset''' = reference to the asset where the HTML file and other resources are located.<br />
*'''filename''' = HTML file to load, may include a relative path specifier.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.LoadHTMLFile(resourceAsset,"/html/File-01.html");<br />
;Notes<br />
*The asset may be of any type, as long as the appropriate files are included in its folder structure.<br />
<br><br />
<br />
===LoadHTMLString===<br />
{{MethodHeader|public native void LoadHTMLString(Asset asset, string htmlData)}}<br />
;Parameters<br />
*'''asset''' = reference to the asset where any resources required are located.<br />
*'''htmlData''' = string containing HTML code to load into browser.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.LoadHTMLString(resourceAsset,htmlData);<br />
;Notes<br />
*The asset may be of any type, as long as the appropriate files are included in its folder structure.<br />
<br><br />
<br />
===ResetScrollBar===<br />
{{MethodHeader|public native void ResetScrollBar(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.ResetScrollBar();<br />
;Notes<br />
*Moves the scrollbar grip and the html contents to the top.<br />
<br><br />
<br />
===SetCloseEnabled===<br />
{{MethodHeader|public native void SetCloseEnabled(bool enabled)}}<br />
;Parameters<br />
*'''enabled''' = Set to false to prevent the user from closing the browser, set to true to enable closure.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetCloseEnabled(false);<br />
;Notes<br />
<br><br />
<br />
===SetParam===<br />
{{MethodHeader|public native void SetParam(int index, string value)}}<br />
;Parameters<br />
*'''index''' = index of parameter to set.<br />
*'''value''' = string value to assign to the specified parameter.<br />
;Returnd Value<br />
*None<br />
;Syntax<br />
browser.SetParam(2,"Birmingham New Street");<br />
;Notes<br />
*HTML code may contain changeable parameters denoted by the placeholder characters ''$#'', where # is a number.<br />
*SetParam() intructs the parser to substitute the text in the function parameter for the placeholder when the browser is loaded.<br />
<br><br />
<br />
===SetScrollEnabled===<br />
{{MethodHeader|public native void SetScrollEnabled(bool enabled)}}<br />
;Parameters<br />
*'''enabled''' = Set to false to prevent the user from scrolling the browser, set to true to enable.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetScrollEnabled(false);<br />
;Notes<br />
<br><br />
<br />
===SetWindowStyle===<br />
{{MethodHeader|public native void SetWindowStyle(int style)}}<br />
;Parameters<br />
*'''style''' = One of the [[#Constants|Browser Window Style]] constants defining the type of browser to be provided.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetWindowStyle(Browser.STYLE_DEFAULT);<br />
;Notes<br />
<br><br />
<br />
===SetWindowVisible===<br />
{{MethodHeader|public native void SetWindowVisible(bool visible)}}<br />
;Parameters<br />
*'''visible''' = true to show the browser window, false to hide it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetWindowVisible(!GetWindowVisible());<br />
;Notes<br />
<br><br />
<br />
==Browser Size & Position==<br />
*This group of methods are used to retrieve and set the position and size of the Browser window.<br />
*A pixel coordinate system is used with 0,0 being the top left and ScreenWidth - 1, ScreenHeight - 1 being the bottom right.<br />
===GetWindowLeft===<br />
{{MethodHeader|public native int GetWindowLeft(void)}}<br />
*Retrieves the pixel coordinate of the left hand edge.<br />
===GetWindowTop===<br />
{{MethodHeader|public native int GetWindowTop(void)}}<br />
*Retrieves the pixel coordinate of the top edge.<br />
===GetWindowRight===<br />
{{MethodHeader|public native int GetWindowRight(void)}}<br />
*Retrieves the pixel coordinate of the right hand edge.<br />
===GetWindowBottom===<br />
{{MethodHeader|public native int GetWindowBottom(void)}}<br />
*Retrieves the pixel coordinate of the bottom edge.<br />
===GetWindowWidth===<br />
{{MethodHeader|public native int GetWindowWidth(void)}}<br />
*Retrieves the width of the window in pixels.<br />
===GetWindowHeight===<br />
{{MethodHeader|public native int GetWindowHeight(void)}}<br />
*Retrieves the height of the window in pixels.<br />
;Parameters<br />
*None<br />
;Syntax<br />
int width = browser.GetWindowWidth();<br />
;Notes<br />
<br><br />
<br />
===SetWindowLeft===<br />
{{MethodHeader|public native void SetWindowLeft(int left)}}<br />
*Sets the pixel coordinate of the left hand edge.<br />
===SetWindowTop===<br />
{{MethodHeader|public native void SetWindowTop(int top)}}<br />
*Sets the pixel coordinate of the top edge.<br />
===SetWindowRight===<br />
{{MethodHeader|public native void SetWindowRight(int right)}}<br />
*Sets the pixel coordinate of the right hand edge.<br />
===SetWindowBottom===<br />
{{MethodHeader|public native void SetWindowBottom(int bottom)}}<br />
*Sets the pixel coordinate of the bottom edge.<br />
===SetWindowRect===<br />
{{MethodHeader|public native void SetWindowRect(int left, int top, int right, int bottom)}}<br />
*Sets the pixel coordinates of all four edges in a single call.<br />
<br />
===SetWindowWidth===<br />
{{MethodHeader|public native void SetWindowWidth(int width)}}<br />
*Sets the width of the window in pixels.<br />
===SetWindowHeight===<br />
{{MethodHeader|public native void SetWindowHeight(int height )}}<br />
*Sets the height of the window in pixels.<br />
===SetWindowSize===<br />
{{MethodHeader|public native void SetWindowSize(int width, int height )}}<br />
*Sets the height and width of the window in pixels.<br />
===SetWindowPosition===<br />
{{MethodHeader|public native void SetWindowPosition(int left, int top)}}<br />
*Moves the window to the specified coordinates without affecting its size.<br />
;Parameters<br />
*'''left''' = Pixel coordinate of the left hand edge.<br />
*'''top''' = Pixel coordinate of the top edge.<br />
*'''right''' = Pixel coordinate of the right hand edge.<br />
*'''bottom''' = Pixel coordinate of the bottom edge.<br />
*'''width''' = Window width in pixels.<br />
*'''height''' = Window height in pixels.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetWindowRect(0,0,200,300);<br />
;Notes<br />
<br><br />
<br />
===SetWindowGrow===<br />
{{MethodHeader|public native void SetWindowGrow(int minWidth, int minHeight, int maxWidth, int maxHeight)}}<br />
;Parameters<br />
*'''minWidth,minHeight''' = Minimum width and height in pixels.<br />
*'''maxWidth,maxHeight''' = Maximum width and height in pixels.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetWindowGrow(100,100,300,300);<br />
;Notes<br />
*Defines a maximum and minimum height and width that the browser window will be constrained to.<br />
<br><br />
<br />
==Trainz Object HTML Element==<br />
*<nowiki><trainz-object></nowiki> tags define special browser objects which the user can interact with.<br />
*These include a graphic dial, a text entry box or a browser frame and a range of parameters can be applied.<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Property'''||bgcolor="#EEEEEE"|'''Value'''||bgcolor="#EEEEEE"|'''Description'''<br />
|-<br />
|style||string||Type of control, "dial", "text-line" or "browser"<br />
|-<br />
|id||string||Name of this object in the browser. <br />
|-<br />
|width||integer||Pixel width of area to display object in. <br />
|-<br />
|height||integer||Pixel height of area to display object in. <br />
|-<br />
|texture||filename||Filename of texture for the object. <br />
|-<br />
|min||float||Maximum value of control. <br />
|-<br />
|max||float||Maximum value of control. <br />
|-<br />
|valmin||float||Minimum possible value the object can be. <br />
|-<br />
|valmax||float||Maximum possible value the object can be. <br />
|-<br />
|step||integer||Steps in this control. <br />
|-<br />
|clickstep||integer||Number of steps per click <br />
|-<br />
|value||float||initial default value of the object. <br />
|}<br />
<br><br />
*The HTML definition for a dial would be<br />
<nowiki><a href="live://dial/dcc" tooltip="Speed control"></nowiki><br />
<trainz-object style=dial <br />
width=100 <br />
height=100<br />
id="dcc"<br />
texture="newdriver/dcc/dcc_controller.tga"<br />
min=0.1<br />
max=0.9<br />
valmin=-1.0<br />
valmax=1.0<br />
step=0<br />
clickstep=1<br />
value=0.5><br />
</trainz-object><br />
</a><br />
<br><br />
*This HTML code implements the issuing of a Browser-URL message whenever the dial is adjusted by the user.<br />
*When the asset script receives the message it will be able to query the control to determine what it needs to do.<br />
*Similarly if the script updates any of the dial's properties the HTML graphics will reflect the change.<br />
<br><br />
<br />
===GetElementProperty===<br />
{{MethodHeader|public native string GetElementProperty(string elementId, string propertyId)}}<br />
;Parameters<br />
*'''elementId''' = Name of HTML element to query.<br />
*'''propertyId''' = Name of trainz-object property to retrieve.<br />
;Returned Value<br />
*Current value of specified property.<br />
;Syntax<br />
float speed = (float)browser.GetElementProperty("dcc","value"); // returns the current dial position<br />
;Notes<br />
*All values are returned in string format and must be cast or converted as appropriate.<br />
<br><br />
<br />
===SetElementObjectProperty===<br />
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, object value)}}<br />
Sets the property of the named object element in this browser to the given object. <br />
<br />
This method is used to assign an object value to the property contained in an element that is in the HTML page this Browser is currently loaded with. <br />
<br />
An element in a HTML page is usually a something like a text entry box, dial or button defined by a <trainz-object> tag. Each element has multiple properties in it and this method allows those property items to be set by name.<br />
<br />
Parameters: <br />
*elementID Name of element to set the property of. <br />
*propertyID Property in the element to set. Properties the <trainz-object> tag supports can be used. <br />
*value Object the is the value the property will be assigned. <br><br />
<br />
Some element properties are references to objects, such as the "driver-commands" property of "driver-order-bar"-elements.<br />
With this method you can for example pass a DriverCommands object reference to the driver-order-bar element.<br />
Also an embedded browser can receive an Asset reference for it's "asset" property via this method. This will change the asset where images are loaded from.<br />
<br />
<br><br><br />
<br />
===SetElementProperty===<br />
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, string value)}}<br />
;Parameters<br />
*'''elementId''' = Name of HTML element to update.<br />
*'''propertyId''' = Name of trainz-object property to update.<br />
*'''value''' = New value to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetElementProperty("dcc","value",(string)speed); // updates the current dial position<br />
;Notes<br />
*All values must be cast or converted to string format for use in this method.<br />
<br><br />
<br />
==Trainz Text HTML Element==<br />
*<nowiki><trainz-text></nowiki> tags define text strings which can be updated without the need to reload the page.<br />
*These take the form <nowiki><trainz-text id="speed" text="0mph"></trainz-text></nowiki><br />
*The text tag specifies the default text that is displayed for the item when the page is initially created.<br />
*Once the page is loaded, a script can use SetTrainzText() to provide a dynamic update.<br />
<br><br />
<br />
===SetTrainzText===<br />
{{MethodHeader|public native void SetTrainzText(string id, string text)}}<br />
;Parameters<br />
*'''id''' = The id of the ''trainz-text'' item to update.<br />
*'''text''' = The string value to provide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
browser.SetTrainzText("speed","90mph");<br />
;Notes<br />
<br><br />
<br />
==Code Examples==<br />
*This code illustrates the basics of handling a browser.<br />
class TestBrowser isclass MapObject {<br />
<br />
<font color=#808080>// A global variable to hold the browser object</font><br />
Browser browser;<br />
<br />
void OpenBrowser(void) {<br />
<font color=#808080>// if the browser doesn't already exist it needs to be created</font><br />
if (!browser) browser = Constructors.NewBrowser();<br />
<font color=#808080>// define the size and style and load HTML, in this case from a file in the calling asset</font><br />
browser.SetWindowPosition(0,0);<br />
browser.SetWindowStyle(browser.STYLE_DEFAULT);<br />
browser.SetWindowSize(200,500);<br />
browser.LoadHTMLFile(GetAsset(),"HTMLSource.html");<br />
}<br />
<br />
void CloseBrowser(Message msg) {<br />
<font color=#808080>// if the browser has been closed we need to destroy the reference to it</font><br />
if (msg.src == browser) browser = null;<br />
}<br />
<br />
void BrowserLink(Message msg) {<br />
<font color=#808080>// make sure that we are responding to the correct browser object</font><br />
if (msg.src != browser) return;<br />
<font color=#808080>// carry out the appropriate response to the link</font><br />
string link = msg.minor;<br />
if (link == "live://anthem") {<br />
World.Play2DSound(GetAsset(),"God Save the Queen.wav");<br />
}<br />
else if (link == "live://travesty") {<br />
World.Play2DSound(GetAsset(),"Advance Australia Fair.wav");<br />
}<br />
}<br />
<br />
public void Init(void) {<br />
inherited();<br />
<font color=#808080>// create handlers for the browser messages</font><br />
AddHandler(me,"Browser-URL","","BrowserLink");<br />
AddHandler(me,"Browser-Closed","","CloseBrowser");<br />
<font color=#808080>// open the browser window</font><br />
OpenBrowser();<br />
}<br />
<br />
};<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Constructors#NewBrowser|Constructors.NewBrowser()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25398Class MapObject2020-11-21T12:19:33Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
* A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetMapObjectPosition===<br />
{{MethodHeader|public native Orientation GetMapObjectPosition(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute position of this MapObject.<br />
;Syntax<br />
float axis_z = cabin.Loco.GetMapObjectPosition().z;<br />
;Notes<br />
* A call to GetMapObjectPosition() which immediately follows a call to SetMapObjectPosition() is not guaranteed to return the input position, since various other position restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetMapObjectOrientation===<br />
{{MethodHeader|public native void SetMapObjectOrientation(Orientation orientation)}}<br />
;Parameters<br />
*'''orientation''' = The new orientation intended for this MapObject.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMapObjectOrientation(or);<br />
;Notes<br />
*Instantly reorients this MapObject to the specified absolute orientation, as best possible. This will not successfully reposition a MapObject which has a parent relationship (for example, a Trackside object.) Various object parameters and game states may restrict or remove the ability to reorient objects.<br />
<br><br />
<br />
===SetMapObjectPosition===<br />
{{MethodHeader|public native void SetMapObjectPosition(WorldCoordinate position)}}<br />
;Parameters<br />
*'''position''' = The new position intended for this MapObject.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMapObjectPosition(pos);<br />
;Notes<br />
*Instantly repositions this MapObject to the specified absolute position, as best possible. This will not successfully reposition a MapObject which has a parent relationship (for example, a Trackside object.) This function may be VERY slow and should generally not be used. Various object parameters and game states may restrict or remove the ability to position objects.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25395Class MapObject2020-11-21T12:12:37Z<p>Ciceronmt: /* GetMapObjectPosition */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
* A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetMapObjectPosition===<br />
{{MethodHeader|public native Orientation GetMapObjectPosition(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute position of this MapObject.<br />
;Syntax<br />
float axis_z = cabin.Loco.GetMapObjectPosition().z;<br />
;Notes<br />
* A call to GetMapObjectPosition() which immediately follows a call to SetMapObjectPosition() is not guaranteed to return the input position, since various other position restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetMapObjectPosition===<br />
{{MethodHeader|public native void SetMapObjectPosition(WorldCoordinate position)}}<br />
;Parameters<br />
*'''position''' = The new position intended for this MapObject.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMapObjectPosition(pos);<br />
;Notes<br />
*Instantly repositions this MapObject to the specified absolute position, as best possible. This will not successfully reposition a MapObject which has a parent relationship (for example, a Trackside object.) This function may be VERY slow and should generally not be used. Various object parameters and game states may restrict or remove the ability to position objects.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25394Class MapObject2020-11-21T12:10:10Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
* A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetMapObjectPosition===<br />
{{MethodHeader|public native Orientation GetMapObjectPosition(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute position of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectPosition().z;<br />
;Notes<br />
* A call to GetMapObjectPosition() which immediately follows a call to SetMapObjectPosition() is not guaranteed to return the input position, since various other position restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetMapObjectPosition===<br />
{{MethodHeader|public native void SetMapObjectPosition(WorldCoordinate position)}}<br />
;Parameters<br />
*'''position''' = The new position intended for this MapObject.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMapObjectPosition(pos);<br />
;Notes<br />
*Instantly repositions this MapObject to the specified absolute position, as best possible. This will not successfully reposition a MapObject which has a parent relationship (for example, a Trackside object.) This function may be VERY slow and should generally not be used. Various object parameters and game states may restrict or remove the ability to position objects.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25393Class MapObject2020-11-21T12:03:32Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
* A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetMapObjectPosition===<br />
{{MethodHeader|public native void SetMapObjectPosition(WorldCoordinate position)}}<br />
;Parameters<br />
*'''position''' = The new position intended for this MapObject.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMapObjectPosition(pos);<br />
;Notes<br />
*Instantly repositions this MapObject to the specified absolute position, as best possible. This will not successfully reposition a MapObject which has a parent relationship (for example, a Trackside object.) This function may be VERY slow and should generally not be used. Various object parameters and game states may restrict or remove the ability to position objects.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25392Class MapObject2020-11-21T11:54:23Z<p>Ciceronmt: /* GetMapObjectOrientation */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
* A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25391Class MapObject2020-11-21T11:50:11Z<p>Ciceronmt: /* GetMapObjectOrientation */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25390Class MapObject2020-11-21T11:46:32Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
* None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
* None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject. WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25389Class MapObject2020-11-21T11:44:31Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===AdjustMapObjectPosition===<br />
{{MethodHeader|public native void AdjustMapObjectPosition(float dx, float dy, float dz)}}<br />
;Parameters<br />
*'''dx''' = The distance (m) to move the object along its x axis (right).<br />
*'''dy''' = The distance (m) to move the object along its y axis (foward).<br />
*'''dz''' = The distance (m) to move the object along its z axis (upward).<br />
;Returned Value<br />
*= None.<br />
;Syntax<br />
AdjustMapObjectPosition(x, y, z);<br />
;Notes<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
= None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject. WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25388Class MapObject2020-11-21T11:34:09Z<p>Ciceronmt: /* GetMapObjectOrientation */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
= None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject. WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25387Class MapObject2020-11-21T11:33:31Z<p>Ciceronmt: /* GetMapObjectOrientation */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
= None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject. WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
float angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25386Class MapObject2020-11-21T11:32:06Z<p>Ciceronmt: /* GetMapObjectOrientation */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
= None.<br />
;Returned Value<br />
*The absolute orientation of this MapObject. WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25385Class MapObject2020-11-21T11:30:23Z<p>Ciceronmt: /* GetMapObjectOrientation */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
= None.<br />
;Returned Value<br />
*WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
angel_z = cabin.Loco.GetMapObjectOrientation().rz;<br />
;Notes<br />
Returns the absolute orientation of this MapObject. A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MapObject&diff=25384Class MapObject2020-11-21T11:27:37Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****[[Class MeshObject|MeshObject]]<br />
******MapObject<br />
<br><br />
<br />
*This class extends MeshObject to include product queues. <br />
*A MapObject can have a number of product queues as defined in the queues section of the config.txt file for the asset.<br />
*The class also provides methods to control particle emissions.<br />
<br><br />
<br />
==MapObject Messages==<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Details||?||MapObject<br />
|-<br />
|[[MapObject Messages|MapObject]]||View-Schedule||?||MapObject<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
<br />
===GetMapObjectOrientation===<br />
{{MethodHeader|public native Orientation GetMapObjectOrientation(void)}}<br />
;Parameters<br />
= None.<br />
;Returned Value<br />
*WorldCoordinate - The current orientation of this MapObject.<br />
;Syntax<br />
GetMapObjectOrientation();<br />
;Notes<br />
Returns the absolute orientation of this MapObject. A call to GetMapObjectOrientation() which immediately follows a call to SetMapObjectOrientation() is not guaranteed to return the input orientation, since various other orientation restrictions may be in effect.<br />
<br><br />
<br />
===GetPFXEmitterLifetime===<br />
{{MethodHeader|public native float GetPFXEmitterLifetime(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value of the lifetime of the effect at the specified phase.<br />
;Syntax<br />
float lifetime GetPFXEmitterLifetime(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxRate===<br />
{{MethodHeader|public native float GetPFXEmitterMaxRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float maxRate = GetPFXEmitterMaxRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMaxSize===<br />
{{MethodHeader|public native float GetPFXEmitterMaxSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Maximum size of particle at the specified phase.<br />
;Syntax<br />
float maxsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinRate===<br />
{{MethodHeader|public native float GetPFXEmitterMinRate(int id)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
;Returned Value<br />
*Maximum rate of emissions per second.<br />
;Syntax<br />
float minRtae = GetPFXEmitterMinRate(0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterMinSize===<br />
{{MethodHeader|public native float GetPFXEmitterMinSize(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Minimum size of particle at the specified phase.<br />
;Syntax<br />
float minsize = GetPFXEmitterMinSize();<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native float GetPFXEmitterPhysicsDelay(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Value for the physics delay in emission.<br />
;Syntax<br />
GetPFXEmitterPhysicsDelay(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterRate===<br />
{{MethodHeader|public native float GetPFXEmitterRate(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Rate of particle creation per second.<br />
;Syntax<br />
particlesPerSecond = GetPFXEmitterRate(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetPFXEmitterVelocity===<br />
{{MethodHeader|public native float GetPFXEmitterVelocity(int id, int phase)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
;Returned Value<br />
*Velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Syntax<br />
float speed = GetPFXEmitterVelocity(0,0);<br />
;Notes<br />
<br><br />
<br />
===GetQueue===<br />
{{MethodHeader|public native ProductQueue GetQueue(string queueName)}}<br />
;Parameters<br />
'''queueName''' = Name of the product queue to be returned.<br />
;Returned Value<br />
*A reference to the queue if possible, null otherwise.<br />
;Syntax<br />
ProductQueue queue = GetQueue("passengers");<br />
<br><br />
<br />
===GetQueues===<br />
{{MethodHeader|public native ProductQueue[ ] GetQueues(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of product queues, if there are no queues the array will be empty.<br />
;Syntax<br />
ProductQueue[] queues = GetQueues();<br />
<br><br />
<br />
===PlaySoundScriptEvent===<br />
{{MethodHeader|public native void PlaySoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
PlaySoundScriptEvent("dayloop");<br />
;Notes<br />
*Plays the specified sound event from the asset's SoundScript. <br />
*SoundScripts are defined as sub-containers in the soundscript container of the asset's configuration. <br />
*For details on creating assets with SoundScripts, see [["Soundscript" container|here]]. <br />
*This method will start playing the sound. <br />
*Depending on the SoundScript configuration, the sound will either be played just once or played continuously in a looping cycle such that [[#StopSoundScriptEvent|StopSoundScriptEvent()]] will need to be called to stop it.<br />
<br><br />
<br />
===SetPFXEmitterConeSize===<br />
{{MethodHeader|public native void SetPFXEmitterConeSize(int id, float x, float y, float z)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''x,y,z''' = New X,Y and Z components of the particle cone size.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterConeSize(0,2.0,3.0,2.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEmitParticles===<br />
{{MethodHeader|public native void SetPFXEmitterEmitParticles(int id, int number,float time)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''number''' = The number of particles to emit.<br />
*'''time''' = The time in seconds over which the particles are to be created.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterEmitParticles(0,100,10.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterEndColor===<br />
{{MethodHeader|public native void SetPFXEmitterEndColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterLifetime===<br />
{{MethodHeader|public native void SetPFXEmitterLifetime(int id, int phase, float life)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''life''' = The new lifetime of particles in seconds at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterLifetime(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxRate===<br />
{{MethodHeader|public native void SetPFXEmitterMaxRate(int id, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new maximum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMaxSize===<br />
{{MethodHeader|public native void SetPFXEmitterMaxSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new maximum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMaxSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinRate===<br />
{{MethodHeader|public native void SetPFXEmitterMinRate(int id, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''rate''' = The new minimum rate of emission per second.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinRate(0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterMinSize===<br />
{{MethodHeader|public native void SetPFXEmitterMinSize(int id, int phase, float newsize)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''newsize''' = The new minimum size of particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterMinSize(0,0,10);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterPhysicsDelay===<br />
{{MethodHeader|public native void SetPFXEmitterPhysicsDelay(int id, int phase, float value)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''value''' = The new physics delay value to set for the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterPhysicsDelay(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterRate===<br />
{{MethodHeader|public native void SetPFXEmitterRate(int id, int phase, float rate)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''rate''' = New rate of particle creation per second at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterRate(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterStartColor===<br />
{{MethodHeader|public native void SetPFXEmitterStartColor(int id, int phase, float r, float g, float b, float a)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''r,g,b''' = Red, green and blue components of the required color.<br />
*'''a''' = Alpha value of the color.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterStartColor(0,0,128,128,128,64);<br />
SetPFXEmitterStartColor(0,0,0.5,0.5,0.5,0.25);<br />
;Notes<br />
*Red, green, blue and alpha may be entered as integer or float values in the ranges 0..255 and 0.0..1.0 respectively.<br />
*Both of the examples above give the same result.<br />
*Note that 1,1,1,1 will be interpreted as float input and will produce white, whereas 2,2,2,2 will be interpreted as integers and will give a result which is almost black.<br />
<br><br />
<br />
===SetPFXEmitterTexture===<br />
{{MethodHeader|public native void SetPFXEmitterTexture(int id, KUID textureKUID)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''textureKUID''' = The kuid of the new texture.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterTexture(0,<kuid:1234:5678>);<br />
;Notes<br />
<br><br />
<br />
===SetPFXEmitterVelocity===<br />
{{MethodHeader|public native void SetPFXEmitterVelocity(int id, int phase, float velocity)}}<br />
;Parameters<br />
*'''id''' = The ID of the particle effect, starting at zero and in the order defined in ''config.txt''.<br />
*'''phase''' = The phase of the effect, if there is only one phase use zero.<br />
*'''velocity''' = New velocity in metres per second along the direction vector of emitted particles at the specified phase.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPFXEmitterVelocity(0,0,5.0);<br />
;Notes<br />
<br><br />
<br />
===StopSoundScriptEvent===<br />
{{MethodHeader|public native void StopSoundScriptEvent(string soundTrigger)}}<br />
;Parameters<br />
'''soundTrigger''' = Name of the sound event to start playing, this equates to the ''trigger'' tag of the sound script subcontainer in ''config.txt''.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopSoundScriptEvent("dayloop");<br />
;Notes<br />
*Terminates a looped sound script previously started with [[#PlaySoundScriptEvent|PlaySoundScriptEvent()]].<br />
<br><br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_World&diff=24590Class World2020-10-31T05:33:45Z<p>Ciceronmt: /* GetTrainzVersion */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**World<br />
<br><br />
*World is a static class used to access various aspects of the Trainz environment.<br />
<br><br />
<br />
==Constants==<br />
*These constants are used to define various values and can be used as mnenomics.<br />
*If accessed from scripts the values must be prefixed ''World.'', for example:<br />
World.SetWeather(World.WEATHER_TYPE_LIGHT_SNOW,World.WEATHER_CHANGEABILITY_PERIODIC);<br />
<br><br />
<br />
===Camera View Modes===<br />
----<br />
*These values can be used either to choose the current camera viewing mode through World.SetCameraMode(), or to restrict certain camera modes from being accessed through methods such as World.SetCamera().<br />
<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CAMERA_INTERNAL = 1||Internal cabin camera view.<br />
|-<br />
|public define int CAMERA_EXTERNAL = 2||External train camera view<br />
|-<br />
|public define int CAMERA_TRACKING = 4||External tracking camera view.<br />
|-<br />
|public define int CAMERA_ROAMING = 128||Roaming camera view.<br />
|}<br />
<br><br />
<br />
===Camera Flags===<br />
----<br />
*These flags are used in addition to the Camera Mode Flags to allow or disallow specific camera actions. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CAMERA_SWITCH_VIEWS = 8||User permitted to swap between the camera views.<br />
|-<br />
|public define int CAMERA_SWITCH_VEHICLES = 16||User permitted to swap vehicles within the current train.<br />
|-<br />
|public define int CAMERA_SWITCH_TRAINS = 32||User permitted to swap to other trains which are in the consist menu.<br />
|-<br />
|public define int CAMERA_LOCKED = 64||User is NOT permitted to adjust camera (i.e. zoom, pan etc.).<br />
|-<br />
|public define int CAMERA_NORMAL = * ||Normal camera mode where everything is permitted.<br />
|-<br />
|colspan=2|<sup>* NOTE: CAMERA_NORMAL = CAMERA_INTERNAL | CAMERA_EXTERNAL | CAMERA_TRACKING | CAMERA_SWITCH_VIEWS | CAMERA_SWITCH_VEHICLES | CAMERA_SWITCH_TRAINS</sup><br />
|}<br />
<br><br />
<br />
===Weather Type Constants===<br />
----<br />
*Define the current state of the weather in Trainz. <br />
*A variety of weather conditions are supported and can be changed by using one of these values with the World.SetWeather() method. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int WEATHER_TYPE_CLEAR = 0||Clear weather, no clouds, rain or snow.<br />
|-<br />
|public define int WEATHER_TYPE_CLOUDY = 1||Cloudy weather, no rain.<br />
|-<br />
|public define int WEATHER_TYPE_DRIZZLE = 2||Drizzle, light rain.<br />
|-<br />
|public define int WEATHER_TYPE_RAIN = 3||Rainy weather.<br />
|-<br />
|public define int WEATHER_TYPE_STORMY = 4||Stormy weather that includes lightning and thunder.<br />
|-<br />
|public define int WEATHER_TYPE_LIGHT_SNOW = 5||Snowing lightly.<br />
|-<br />
|public define int WEATHER_TYPE_MEDIUM_SNOW = 6||Medium level snow fall.<br />
|-<br />
|public define int WEATHER_TYPE_HEAVY_SNOW = 7||Heavy snow fall.<br />
|}<br />
<br><br />
<br />
===Weather Changeability Constants===<br />
----<br />
*Define the changeability settings for the weather. <br />
*Weather changeability refers to variability of weather conditions rather than to a specific weather type.<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int WEATHER_CHANGEABILITY_NONE = 0||Weather remains static.<br />
|-<br />
|public define int WEATHER_CHANGEABILITY_PERIODIC = 1||Periodic changes in weather.<br />
|-<br />
|public define int WEATHER_CHANGEABILITY_EXTREME = 2||Extreme and frequent changes in weather. <br />
|}<br />
<br><br />
<br />
===Time Values===<br />
----<br />
*Time constants defined in seconds.<br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TIME_SECOND = 1.0f||One second.<br />
|-<br />
|public define float TIME_MINUTE = TIME_SECOND * 60.0f||One minute, 60.0 seconds.<br />
|-<br />
|public define float TIME_HOUR = TIME_MINUTE * 60.0f||One hour, 60.0 minutes, 3600.0 seconds.<br />
|-<br />
|public define float TIME_DAY = TIME_HOUR * 24.0f||One day, 24 hours, 1440.0 minutes, 86400.0 seconds.<br />
|}<br />
<br><br />
<br />
===Time Rate Constants===<br />
----<br />
*Values that define the time rates relative to normal time. <br />
*These constants can be used to set the time rate that Trainz runs out through the World.SetGameTimeRate() method. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TIME_RATE_1X = 0||Real time (i.e. time in Trainz passes at the same rate as in the real world)<br />
|-<br />
|public define int TIME_RATE_2X = 1||Time passes at twice normal speed.<br />
|-<br />
|public define int TIME_RATE_4X = 2||<br />
|-<br />
|public define int TIME_RATE_8X = 3||<br />
|-<br />
|public define int TIME_RATE_16X = 4||<br />
|-<br />
|public define int TIME_RATE_32X = 5||<br />
|-<br />
|public define int TIME_RATE_60X = 6||<br />
|-<br />
| public define int TIME_RATE_120X = 7||<br />
|-<br />
| public define int TIME_RATE_240X = 8||<br />
|-<br />
|public define int TIME_RATE_360X = 9||<br />
|-<br />
|public define int TIME_RATE_480X = 10||<br />
|-<br />
|public define int TIME_RATE_720X = 11||<br />
|-<br />
|public define int TIME_RATE_960X = 12||<br />
|-<br />
|public define int TIME_RATE_1200X = 13||<br />
|-<br />
|public define int TIME_RATE_1440X = 14||<br />
|}<br />
<br><br />
<br />
===Trainz Modules===<br />
----<br />
*Trainz module mode constants. <br />
*These values define the various module environments that Trainz can be in. <br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int NO_MODULE = 0||Trainz not running in a module.<br />
|-<br />
|public define int SURVEYOR_MODULE = 1||Trainz is currently running in Surveyor.<br />
|-<br />
|public define int DRIVER_MODULE = 2||Trainz is currently running in Driver.<br />
|}<br />
<br> <br />
<br />
==Related Messages==<br />
* [[TrainzScript Message Reference]]<br><br />
* [[Camera Messages]]<br><br />
* [[Interface Messages]]<br><br />
* [[ModuleInit Message]]<br><br />
<br><br />
<br />
==AddDriverCharacter==<br />
{{MethodHeader|public native DriverCharacter AddDriverCharacter(Asset driverCharacterAsset)}}<br />
;Parameters<br />
*'''driverCharacterAsset''' = Asset containing character to be added.<br />
;Returned Value<br />
*Reference to the DriverCharacter if successful, null otherwise.<br />
;Syntax<br />
DriverCharacter Casey = World.AddDriverCharacter(CaseyJones);<br />
;Notes<br />
<br><br />
<br />
==AddDriverCommand==<br />
{{MethodHeader|public native DriverCommand AddDriverCommand(Asset driverCommandAsset)}}<br />
;Parameters<br />
*'''driverCommandAsset''' = Asset containing command to be added.<br />
;Returned Value<br />
*Reference to the DriverCommand if successful, null otherwise.<br />
;Syntax<br />
DriverCommand GoFaster = World.AddDriverCommand(accelerate);<br />
;Notes<br />
<br><br />
<br />
==CreateBehavior==<br />
{{MethodHeader|public native ScenarioBehavior CreateBehavior(KUID kuid, Soup initialProperties)}}<br />
;Parameters<br />
*'''kuid''' = KUID of scenario.<br />
'''initialProperties''' = Soup object containing initial properties for scenario.<br />
;Returned Value<br />
*Reference to the ScenarioBehavior created if successful, null otherwise.<br />
;Syntax<br />
ScenarioBehavior scenario = World.CreateBehavior(scenarioAsset, scenarioSoup);<br />
;Notes<br />
*The returned ScenarioBehavior object may be ended by releasing all references to it (resetting all references to null).<br />
<br><br />
<br />
==CreateTrain==<br />
{{MethodHeader|public native Train CreateTrain(KUID[ ] consist, string trackmarkName, bool direction)<br>public native Train CreateTrain(KUID[ ] consist, TrackMark trackmark, bool direction)<br>public native Train CreateTrain(KUID[ ] consist, Buildable buildable, string trackName, float position, bool direction)}}<br />
;Parameters<br />
*'''consist''' = An array of vehicle KUIDs used to describe the required Train object.<br />
*'''trackmarkName''' = Name of Trackmark at which the consist is to be formed.<br />
*'''buildable''' = Buildable on which the consist is to be formed.<br />
*'''trackName''' = Name of track within Buildable object.<br />
*'''position''' = Distance at which the Train is to be placed relative to the start of the track.<br />
*'''trackmark''' = Reference to Trackmark at which the consist is to be formed.<br />
*'''direction''' = Orientation of Train relative to direction of track or trackmark.<br />
;Returned Value<br />
*Reference to the Train created if successful, null otherwise.<br />
;Syntax<br />
Train train = World.CreateTrain(consist, buildable, "Track 1", 10.0, true);<br />
;Notes<br />
*These methods create a train from a list of vehicles in a consist array.<br />
*Depending on the variant of the method used, the train can be created at a Trackmark, specified by name or reference, or at a Buildable or Industry object.<br />
*It is the responsibility of the script programmer to ensure that sufficient track exists at the given location to allow the train to be created.<br />
<br><br />
<br />
==DeleteTrain==<br />
{{MethodHeader|public native void DeleteTrain(Train train)}}<br />
;Parameters<br />
*'''train''' = train to be deleted from map.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.DeleteTrain(flyingScotsman);<br />
;Notes<br />
*Once a train has been deleted, care should be taken to avoid using its reference.<br />
<br><br />
<br />
==DeleteVehicle==<br />
{{MethodHeader|public native void DeleteVehicle(Vehicle vehicle)}}<br />
;Parameters<br />
*'''vehicle''' = vehicle to be deleted from its train.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.DeleteVehicle(vehicles[vehicles.size()-1]);<br />
;Notes<br />
*Use Train.GetVehicles() to obtain an array of vehicles for a given train.<br />
*Use Vehicle.GetMyTrain() to obtain a train reference for a given vehicle.<br />
<br><br />
<br />
==FindAsset==<br />
{{MethodHeader|public native Asset FindAsset(KUID kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of Asset to return.<br />
;Returned Value<br />
*Given a valid KUID parameter, this method return an Asset reference if successful, null otherwise.<br />
;Syntax<br />
Asset asset = World.FindAsset(kuid);<br />
;Notes<br />
*See also Asset.FindAsset()<br />
<br><br />
<br />
==FindDriverCommand==<br />
{{MethodHeader|public native DriverCommand FindDriverCommand(Asset driverCommandAsset)}}<br />
;Parameters<br />
*'''driverCommandAsset''' = Asset containing command to be added.<br />
;Returned Value<br />
*Reference to the DriverCommand if successful, null otherwise.<br />
;Syntax<br />
DriverCommand GoFaster = World.FindDriverCommand(accelerate);<br />
;Notes<br />
<br><br />
<br />
==GetAssetList==<br />
{{MethodHeader|public native Asset[ ] GetAssetList(string kind)}}<br />
;Parameters<br />
*'''kind''' = String representing the Kind of asset to return.<br />
;Returned Value<br />
*A list of all assets of the given ''kind''<br />
;Syntax<br />
Asset[] Libraries = World.GetAssetList("Library");<br />
;Notes<br />
*All installed assets of the given ''kind'' are returned, irrespective of whether or not they are in use on the current map.<br />
<br><br />
<br />
==GetBadWeatherFog==<br />
{{MethodHeader|public native float GetBadWeatherFog(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Bad weather fog distance as a float in the range 0.0..1.0.<br />
;Syntax<br />
float dist = World.GetBadWeatherFog();<br />
;Notes<br />
<br><br />
<br />
==GetBehaviors==<br />
{{MethodHeader|public native ScenarioBehavior[ ] GetBehaviors(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A list of top-level behaviors or rules on the currently loaded route.<br />
;Syntax<br />
ScenarioBehavior[] rules = World.GetBehaviors();<br />
;Notes<br />
<br><br />
<br />
==GetCameraPositionX==<br />
{{MethodHeader|public native float GetCameraPositionX(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*X Coordinate of the current camera position.<br />
;Syntax<br />
float X = World.GetCameraPositionX();<br />
*Notes<br />
<br><br />
<br />
==GetCameraPositionY==<br />
{{MethodHeader|public native float GetCameraPositionY(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Y Coordinate of the current camera position.<br />
;Syntax<br />
float Y = World.GetCameraPositionY();<br />
*Notes<br />
<br><br />
<br />
==GetCameraPositionZ==<br />
{{MethodHeader|public native float GetCameraPositionZ(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Z Coordinate of the current camera position.<br />
;Syntax<br />
float Z = World.GetCameraPositionZ();<br />
*Notes<br />
<br><br />
<br />
==GetCurrentModule==<br />
{{MethodHeader|public native int GetCurrentModule(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An integer representing the current Trainz module.<br />
;Syntax<br />
int module = World.GetCurrentModule();<br />
;Notes<br />
* See [[#Trainz Modules|Trainz Modules]] for details of the constants associated with this method. <br />
* See [[ModuleInit Message]] for further details.<br />
<br><br />
<br />
==GetDriverCharacterList==<br />
{{MethodHeader|public native DriverCharacter[ ] GetDriverCharacterList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of DriverCharacter objects installed in the current world.<br />
;Syntax<br />
DriverCharacter[] drivers = World.GetDriverCharacterList();<br />
;Notes<br />
<br><br />
<br />
==GetDriverCommandList==<br />
{{MethodHeader|public native DriverCommand[ ] GetDriverCommandList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of DriverCommand objects installed in the current world.<br />
;Syntax<br />
DriverCommand[] commands = World.GetDriverCommandList();<br />
;Notes<br />
<br><br />
<br />
==GetGameTime==<br />
{{MethodHeader|public native float GetGameTime(void)}}<br />
;Parameters<br />
*None<br />
;Returned value<br />
*Current game time.<br />
;Syntax<br />
float Now = World.GetGameTime();<br />
;Notes<br />
*The returned time is normalised to a value between 0.0 and 1.0<br />
*0.0 = midday.<br />
*0.5 = midnight<br />
*Use the [[#Time_Values|Time Value]] constants to convert the normalised values to human readable times.<br />
<br><br />
<br />
==GetGoodWeatherFog==<br />
{{MethodHeader|public native float GetGoodWeatherFog(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Good weather fog distance as a float in the range 0.0..1.0.<br />
;Syntax<br />
float dist = World.GetGoodWeatherFog();<br />
;Notes<br />
<br><br />
<br />
==GetGroundDrawDistance==<br />
{{MethodHeader|public native float GetGroundDrawDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Ground draw distance in metres.<br />
;Syntax<br />
float dist = World.GetGroundDrawDistance();<br />
;Notes<br />
<br><br />
<br />
==GetIndustryList==<br />
{{MethodHeader|public native GameObject[ ] GetIndustryList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the Industry objects for the current route.<br />
;Syntax<br />
GameObject[] Industries = World.GetIndustryList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
<br><br />
<br />
==GetJunctionList==<br />
{{MethodHeader|public native Junction[ ] GetJunctionList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trackside junction objects for the current route.<br />
;Syntax<br />
Junction[] junctions = World.GetJunctionList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
*Junction objects attached to fixed track junctions are not returned by this method.<br />
<br><br />
<br />
==GetLibrary==<br />
{{MethodHeader|public native Library GetLibrary(KUID kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of script library asset to load.<br />
;Returned Value<br />
*A reference to the script library asset if successful, null otherwise.<br />
;Syntax<br />
Library codelib = World.GetLibrary(LibraryKUID);<br />
;Notes<br />
*The [[Class Library|Library]] asset is initialised when this method is first called in a session.<br />
*Since only one instance can exist, subsequent calls return a reference to the existing Library object.<br />
*See [[Class Library|Library]] for notes on how to use this method.<br />
<br><br />
<br />
==GetSceneryDrawDistance==<br />
{{MethodHeader|public native float GetSceneryDrawDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Undefined.<br />
;Notes<br />
*Included for legacy script compatibility only. Has no effect.<br />
<br><br />
<br />
==GetSeconds==<br />
{{MethodHeader|public native float GetSeconds(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current value of a floating point number incrementing once per second in real time.<br />
;Syntax<br />
float start = World.GetSeconds();<br />
// do stuff<br />
float finish = World.GetSeconds();<br />
float period = finish - start;<br />
;Notes<br />
*Each call will return a float value containing the current value of an internal counter.<br />
*Subtracting a later value from a value saved at an earlier call will enable the delay between the two calls to be established.<br />
<br><br />
<br />
==GetSignalList==<br />
{{MethodHeader|public native Signal[ ] GetSignalList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the signal objects for the current route.<br />
;Syntax<br />
Signal[] signals = World.GetSignalList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
<br><br />
<br />
==GetStringTable==<br />
{{MethodHeader|public native StringTable GetStringTable(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*The StringTable for the current session.<br />
;Syntax<br />
StringTable data = World.GetStringTable();<br />
;Notes<br />
<br><br />
<br />
==GetSurveyorSavedConsist==<br />
{{MethodHeader|public native Soup GetSurveyorSavedConsistList(string name)}}<br />
;Parameters <br />
*'''name''' = Name of the consist to retireiev.<br />
;Returned Value<br />
*Returns a Soup definition of the named consist if it exists, null otherwise.<br />
;Syntax<br />
Soup consist = World.GetSurveyorSavedConsist("Brighton Belle");<br />
;Notes<br />
*Remember that the returned data is in a Soup format, which is not the same thing as a Train. <br />
*TrainUtil.CreateTrainFormSoup() can be used to create a train from the returned Soup.<br />
*This method only works in Surveyor.<br />
<br><br />
<br />
==GetSurveyorSavedConsistList==<br />
{{MethodHeader|public native string[ ] GetSurveyorSavedConsistList()}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of names of all the saved consist objects in Surveyor.<br />
;Syntax<br />
string[] consists = World.GetSurveyorSavedConsistList();<br />
;Notes<br />
*This method only works in Surveyor.<br />
<br><br />
<br />
==GetTrackmarkList==<br />
{{MethodHeader|public native TrackMark[ ] GetTrackmarkList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trackmark objects for the current route.<br />
;Syntax<br />
Trackmark[] trackmarks = World.GetTrackmarkList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
<br><br />
<br />
==GetTrainList==<br />
{{MethodHeader|public native Train[ ] GetTrainList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trains for the current route.<br />
;Syntax<br />
Train[] trains = World.GetTrainList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
<br><br />
<br />
==GetTrainzBuild==<br />
{{MethodHeader|public native int GetTrainzBuild(void)}}<br />
;Parameters;<br />
*None<br />
;Returned Value<br />
*Gets the current build number of Trainz. <br />
;Syntax<br />
int build = World.GetTrainzBuild();<br />
;Notes<br />
*The value returned corresponds to the build number you can see in the bottom-right side of the main Trainz menu screen.<br />
<br><br />
<br />
==GetTrainzVersion==<br />
{{MethodHeader|public native float GetTrainzVersion(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The TRS version number.<br />
;Syntax<br />
float version = World.GetTrainzVersion();<br />
;Notes<br />
*The value returned corresponds to the version number of Content manager (for example 4.6). <br />
<br><br />
<br />
==GetTriggerList==<br />
{{MethodHeader|public native Trigger[ ] GetTriggerList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the trigger objects for the current route.<br />
;Syntax<br />
Trigger[] triggers = World.GetTriggerList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
*This method does not return scenery triggers, ie those attached to SceneryWithTrack objects and their descendants.<br />
<br><br />
<br />
==GetVehicleList==<br />
{{MethodHeader|public native Vehicle[ ] GetVehicleList(void)}}<br />
;Parameters <br />
*None<br />
;Returned Value<br />
*An array of references to all of the vehicles in the current route.<br />
;Syntax<br />
Vehicle[] vehicles = World.GetVehicleList();<br />
;Notes<br />
*This function is obsolete and should not be used.<br />
<br><br />
<br />
==GetWeatherChangeability==<br />
{{MethodHeader|public native int GetWeatherChangeability(void)}}<br />
;Parameter<br />
*None<br />
;Returned Value<br />
*One of the [[#Weather_Changeability_Constants|Weather Changeability Constants]] denoting the variability of weather conditions.<br />
;Syntax<br />
int variability = World.GetWeatherChangeability();<br />
;Notes<br />
<br><br />
<br />
==GetWeatherType==<br />
{{MethodHeader|public native int GetWeatherType(void)}}<br />
;Parameter<br />
*None<br />
;Returned Value<br />
*One of the [[#Weather_Type_Constants|Weather Type Constants]] denoting the current weather conditions.<br />
;Syntax<br />
int weather = World.GetWeatherType();<br />
;Notes<br />
<br><br />
<br />
==LoadMap==<br />
{{MethodHeader|public native bool LoadMap(KUID kuid)}}<br />
;Parameters<br />
*'''kuid''' = KUID of map to load.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
if (World.LoadMap(mapKUID) Interface.Print("Map loaded OK");<br />
else Interface.Print("Map load failed");<br />
;Notes<br />
<br><br />
<br />
==Play2DSound==<br />
{{MethodHeader|public float Play2DSound(Asset asset, string wave)}}<br />
;Parameters<br />
*'''asset''' = Asset where the sound file is located.<br />
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.<br />
;Returned Value<br />
* Undefined.<br />
;Syntax<br />
// Play the sound and continues script execution.<br />
World.Play2DSound(soundAsset,"sounds/allaboard.wav"); <br />
// Wait until sound has completed before continuing (pre-TS12 only!)<br />
Sleep(World.Play2DSound(soundAsset,"sounds/allaboard.wav")); <br />
;Notes<br />
*Plays a ''.wav" sound file from the given asset's folder.<br />
*The sound is non directional and can be mono or stereo. <br />
*This method does not return after the sound has finished playing, it returns with the length of the sound as soon as it is called. <br />
*This means your code will keep on executing while Trainz is playing the sound.<br />
<br><br />
<br />
==PlaySound==<br />
{{MethodHeader|public native float PlaySound<br>&nbsp;&nbsp;&nbsp;&nbsp;(Asset asset, string wave, float vol, float near, float far, GameObject target, string pt)<br>&nbsp;&nbsp;&nbsp;&nbsp;(Asset asset, string wave, float vol, float near, float far, GameObject target, string pt, bool loop)}}<br />
;Parameters<br />
*'''asset''' = Asset where the sound file is located.<br />
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.<br />
*'''vol''' = Volume level to play the sound at (0 to 1)<- These values taken from TRS2019 world.gs file comments<br />
*'''near''' = Distance from the target asset at which the sound will be played at maximum volume.<br />
*'''far''' = Distance from the target asset at which the sound will become inaudible.<br />
*'''target''' = GameObject to which the sound will be attached if a 3d sound is required, null for 2D.<br />
*'''pt''' = Name of attachment point in the target object if a 3d sound is required, null for 2D.<br />
*'''loop''' = (Optional) If true the sound will loop continuously.<br />
;Returned Value<br />
* Sound length in seconds for Trainz before TS12<br />
* Undefined for TS12 and TANE<br />
;Syntax<br />
// Play the sound and continues script execution.<br />
World.PlaySound(soundAsset,"sounds/allaboard.wav",1.0,10.0,100.0,Station,"a.loudspeaker"); <br />
// Wait until sound has completed before continuing (pre-TS12 only!)<br />
Sleep(World.PlaySound(soundAsset,"sounds/allaboard.wav",1000.0,10.0,100.0,Station,"a.loudspeaker"); <br />
;Notes<br />
*Plays a ''.wav'' sound file from the given asset's folder.<br />
*If the sound is to be directional a mono sound file is required. <br />
*This method does not return after the sound has finished playing: it returns as soon as it is called. <br />
*This means your code will keep on executing while Trainz is playing the sound.<br />
*If you want to wait for the sound to complete playing before moving on, wrap the PlaySound() call up in a Sleep() call. '''Note!''' This works only in Trainz versions before TS12. For newer versions, TS12 and TANE, you can hard-code the duration of the sound, or store it in the extensions container of the config.txt file.<br />
*The sound volume will be at a maximum for a camera position at or less than the value of the ''near'' parameter and will reduce with distance until the hearing position reaches ''far'', when the sound will be inaudible.<br />
<br><br />
<br />
==RemoveDriverCharacter==<br />
{{MethodHeader|public native void RemoveDriverCharacter(DriverCharacter driver)}}<br />
;Parameters<br />
*'''driver''' = DriverCharacter to remove.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.RemoveDriverCharacter(dave);<br />
;Notes<br />
<br><br />
<br />
==RemoveDriverCommand==<br />
{{MethodHeader|public native void RemoveDriverCommand(DriverCommand command)}}<br />
;Parameters<br />
*'''command''' = DriverCommand to remove.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.RemoveDriverCommand(driverCommand);<br />
;Notes<br />
<br><br />
<br />
==SetBadWeatherFog==<br />
{{MethodHeader|public native void SetBadWeatherFog(float distance)}}<br />
;Parameters<br />
*'''distance''' = Bad weather fog distance to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetBadWeatherFog(0.5);<br />
;Notes<br />
<br><br />
<br />
==SetCamera==<br />
{{MethodHeader|public native bool SetCamera(MapObject focus)<br>public native void SetCamera(Junction focus)<br>public native void SetCamera(Vehicle focus, int cameraMode)<br>public native void SetCamera(Train focus, int cameraMode)}}<br />
;Parameters<br />
*'''focus''' = Object on which the camera is to be focused.<br />
*''cameraMode''' = One of the [[#Camera_View_Modes|Camera View Mode]] constants defining the view which should be assigned to the camera.<br />
;Returned Value<br />
*The first variant returns a boolean to indicate success or failure.<br />
*Remaining variants do not return a value<br />
'Syntax<br />
World.SetCamera(train.GetVehicles[0],World.CAMERA_TRACKING); // sets the camera to track the first vehicle in the train.<br />
<br><br />
<br />
==SetCameraAngle==<br />
{{MethodHeader|public void SetCameraAngle(int yaw, int pitch, float radius)}}<br />
;Parameters<br />
*'''yaw''' = Camera rotation in degrees, 90 is a direct front view.<br />
*'''pitch''' = Camera angle relative to the horizon, 0 is horizontal, 90 points vertically upwards.<br />
*'''radius''' = Distance in metres to the object in focus.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetCameraAngle(90,0,25); // Sets the camera to a direct frontal view at 25 metres from the currently focused object.<br />
;Notes<br />
*''Radius'' is measured from the object origin point (0,0,0).<br />
<br><br />
<br />
==SetCameraFlags==<br />
{{MethodHeader|public native void SetCameraFlags(int flags)}}<br />
;Parameter<br />
*'''flags''' integer value defining what the user is permitted to do with the game camera.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
// User is permitted to select External or Tracking views only.<br />
World.SetCameraFlags(World.CAMERA_EXTERNAL | World.CAMERA_TRACKING);<br />
;Notes<br />
*Use any combination of [[#Camera_Flags|Camera Flags]] and [[#Camera_View_Modes|Camera View Modes]] to set the parameter.<br />
<br><br />
<br />
==SetCameraMode==<br />
{{MethodHeader|public void SetCameraMode(int mode)}}<br />
;Parameter<br />
*'''mode''' = Camera mode to select.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetCameraMode(World.CAMERA_TRACKING);<br />
;Notes<br />
*Use one of the [[#Camera_View_Modes|Camera View Modes]] to set the parameter.<br />
<br><br />
<br />
==SetGameTime==<br />
{{MethodHeader|public void SetGameTime(float time)}}<br />
;Parameters<br />
*'''time''' = new gane time to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameTime(0.5); // sets time to midnight<br />
;Notes<br />
*Game time is normalised to a value between 0.0 and 1.0<br />
*0.0 = midday.<br />
*0.5 = midnight<br />
*Use the [[#Time_Values|Time Value]] constants to convert human readable times to normalised values. <br />
<br><br />
<br />
==SetGameTimeRate==<br />
{{MethodHeader|public native void SetGameTimeRate(float rate)}}<br />
;Parameters<br />
*'''rate''' = New time rate to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGameTimeRate(World.TIME_RATE_8X); // sets game time to advance by 8 minutes per minute of real world time.<br />
;Notes<br />
*Use one of the [[#Time_Rate_Constants|Time Rate Constants]] to define the parameter.<br />
<br><br />
<br />
==SetGoodWeatherFog==<br />
{{MethodHeader|public native void SetGoodWeatherFog(float distance)}}<br />
;Parameters<br />
*'''distance''' = Good weather fog distance to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGoodWeatherFog(0.5);<br />
;Notes<br />
<br><br />
<br />
==SetGroundDrawDistance==<br />
{{MethodHeader|public native void SetGroundDrawDistance(float distance)}}<br />
;Parameters<br />
*'''distance''' = Ground draw distance in metres.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetGroundDrawDistance(1000.0);<br />
;Notes<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==SetSceneryDrawDistance==<br />
{{MethodHeader|public native void SetSceneryDrawDistance(float distance)}}<br />
;Parameters<br />
*'''distance''' = unused.<br />
;Returned Value<br />
*None<br />
;Notes<br />
* Does nothing. Included for script compatibility only.<br />
<br><br />
<br />
==SetTargetObserver==<br />
{{MethodHeader|public void SetTargetObserver(GameObject observer)}}<br />
;Parameters<br />
*'''observer''' = The game object to receive targeting messages.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetTargetObserver(self);<br />
;Notes<br />
* Causes the specified object to receive "Track", "LeftClick" messages when a track is clicked. Causes the specified object to receive "Interface-Event", "Left-Click" messages when a targetable MapObject is clicked. May cause the functionality of a left mouse click to change from what the user is expecting, so should be used with caution. Used in modal scripts to allow the user to indicate a location for train placement, etc. As there is only a single observer at any given time, the script must take care to only call this function when entering placement mode at the user's request.<br />
<br><br />
<br />
==SetWeather==<br />
{{MethodHeader|public native void SetWeather(int type, int changeability)}}<br />
;Parameters<br />
*'''type''' = Weather conditions as defined by one of the [[#Weather_Type_Constants|Weather Type Constants]].<br />
*'''change''' = Weather variation as defined by one of the [[#Weather_Changeability_Constants|Weather Changeability Constants]].<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.SetWeather(World.WEATHER_TYPE_HEAVY_SNOW,World.WEATHER_CHANGEABILITY_EXTREME); // April in Paris.<br />
;Notes<br />
<br><br />
<br />
==UserSetCamera==<br />
{{MethodHeader|public native bool UserSetCamera(GameObject target)}}<br />
;Parameters<br />
*'''target''' = GameObject to set focus to.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
World.UserSetCamera(Router,GetGameObject("Junction 5"));<br />
;Notes<br />
<br><br />
<br />
==UserSetCameraMode==<br />
{{MethodHeader|public native void UserSetCameraMode(int mode)}}<br />
;Parameters<br />
*'''mode''' = One of the [[#Camera_View_Modes|Camera View Modes]]<br />
;Returned Value<br />
*None<br />
;Syntax<br />
World.UserSetCameraMode(World.CAMERA_ROAMING); // switches to roaming view if permitted.<br />
;Notes<br />
*This method respects the current [[#Camera_Flags|Camera Flag]] settings, disallowing any change which the flags do not permit.<br />
<br><br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MeshObject&diff=24280Class MeshObject2020-10-04T10:36:35Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****MeshObject<br />
<br><br />
<br />
This is a base class for [[class Asset|Asset]] based game objects that have meshes, effects, animations and particles. Interface methods to deal with these are provided so things like showing or hiding a mesh, attaching a mesh to an attachment point or controlling an animation can be done from a script.<br />
<br />
For animation Trainz interpolates between key frames. This means an intermediate animation frame is calculated dynamically to be-in-synch with the game's framerate.<br />
<br />
Trainzscript is an interpreted scripting language intended to be used to monitor and react to events in the Trainz world, not to perform sophisticated real-time animation tasks. Using a script to start an animation in response to an event in a thread is reasonable. However trying to control animation tightly down to short intervals is likely to provide unsatisfactory results and to adversely affect overall performance of the game.<br />
<br />
<br />
<br />
<br />
<br />
==MeshObject Messages==<br />
Messages related to MeshObject assets:<br />
*[[Animation-Event Message]]<br />
*[[pfx Message]]<br />
<br><br />
<br />
==GetFXAttachment==<br />
{{MethodHeader|public native MeshObject GetFXAttachment(string effect)}}<br />
;Parameters<br />
*'''effect''' = name of the mesh effect to query. <br />
;Returned Value<br />
*Returns a reference to the MeshObject currently attached to the named effect.<br />
;Syntax<br />
MeshObject attachment = GetFXAttachment("coupler");<br />
;Notes<br />
*The method returns null if the effect is unoccupied.<br />
<br><br />
<br />
==GetMeshAnimationFrame==<br />
{{MethodHeader|public native float GetMeshAnimationFrame(string mesh)'''}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be queried.<br />
;Returned Value<br />
*Current fame of the animation file within the specified mesh container.<br />
;Syntax<br />
float height = GetMeshAnimationFrame("zPosition")<br />
;Notes<br />
*Note that the returned value is likely to be an interpreted floating point value.<br />
<br><br />
<br />
==GetMeshAnimationFrameCount==<br />
{{MethodHeader|public native float GetMeshAnimationFrameCount(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be queried.<br />
;Returned Value<br />
*The number of frames in the specified animation.<br />
;Syntax<br />
float positions = GetMeshAnimationFrameCount("lever");<br />
;Notes<br />
*Note that the returned value is a float rather than an integer.<br />
<br><br />
<br />
==GetTextureSelfIlluminationState==<br />
{{MethodHeader|public native bool GetTextureSelfIlluminationState(string texture)'''}}<br />
;Parameters<br />
*'''texture''' = root name of ''*.texture.text'' file to query.<br />
;Returned Value<br />
*Returns true if the specified texture has self illumination set.<br />
;Syntax<br />
bool isEmissive = GetTextureSelfIlluminationState("texture");<br />
;Notes<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==HasMesh==<br />
{{MethodHeader|public native bool HasMesh(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be queried.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (HasMesh("ventilation")) StartMeshAnimationLoop("fans");<br />
;Notes<br />
*<br />
<br><br />
<br />
==SetFXAnimationState==<br />
{{MethodHeader|public native void SetFXAnimationState(string effect, bool state)}}<br />
;Parameters<br />
*'''effect''' = name of attached-animation effect containing the animation to play.<br />
*'''state''' = true to start the animation loop, false to stop.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (gateClosed) SetFXAnimationState("gate",false);<br />
;Notes<br />
<br><br />
<br />
==SetFXAttachment==<br />
{{MethodHeader|public native MeshObject SetFXAttachment(string effect, Asset asset)'''}}<br />
;Parameters<br />
*'''effect''' = effect containing the attachment to be manipulated.<br />
*'''asset''' = mesh asset to attach to the effect. If asset is null any existing asset will be removed and nothing will be added.<br />
;Returned Value<br />
*Returns a reference to the MeshObject which has been attached to the named effect. If the mesh asset isn't "kind mesh", returns null.<br />
;Syntax<br />
MeshObject lamp = SetFXAttachment("lamp0",redlamp);<br />
;Notes<br />
*Returns null if the effect is unoccupied when the method returns.<br />
<br><br />
<br />
==SetFXCoronaTexture==<br />
{{MethodHeader|public native void SetFXCoronaTexture(string effect, Asset texture)}}<br />
;Parameters<br />
*'''effect''' = effect containg the corona to be manipulated.<br />
*'''asset''' = corona texture asset to attach to the effect. If asset is null the corona will be turned off.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXCoronaTexture("stopLight",redCorona);<br />
;Notes<br />
*Other corona parameters such as frequency and size are defined in ''config.txt'' and cannot be altered by script code.<br />
<br><br />
<br />
==SetFXNameText==<br />
{{MethodHeader|public native void SetFXNameText(string effect, string text)}}<br />
;Parameters<br />
*'''effect''' = effect containg the name effect to be changed.<br />
*'''text''' = new string value.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXNameText("home","Shangri-La");<br />
;Notes<br />
*Method will not accept an empty string in the ''text'' parameter.<br />
<br><br />
<br />
==SetFXTextureReplacement==<br />
{{MethodHeader|public native void SetFXTextureReplacement(string effect, Asset textureGroup, int index)}}<br />
;Parameters<br />
*'''effect''' = texture-replacement effect to be changed.<br />
*'''textureGroup''' = reference to texture group asset which is the source of the texture to be applied.<br />
*'''index''' = index into ''textures'' table of texture-group indicating which texture to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXTextureReplacement("load",loadTextures,5); // applies texture 5 from texture-group<br />
SetFXTextureReplacement("load",null,0); // clears the effect, reinstating the texture defined in the asset.<br />
;Notes<br />
*Use null in the textureGroup parameter to turn texture replacement off.<br />
<br><br />
<br />
==SetFXTextureReplacementTexture==<br />
{{MethodHeader|public native void SetFXTextureReplacementTexture(string effectName, string textureName)}}<br />
;Parameters<br />
*'''effectName''' = the name of the texture-replacement effect that is in the effects container of the mesh.<br />
*'''textureName''' = the ''*.texture.txt'' file that will replace the current texture being used on the mesh.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXTextureReplacementTexture("fk_parameter","lms_p3_fk_body/fk_parameter.texture");<br />
;Notes<br />
*This should replace any instance of SwapTextureOnMesh.<br />
*Unlike SwapTextureOnMesh, there is no need to mention what the previous texture being used was. Simply telling Trainz to load the new texture is all that is needed for this to work.<br />
*Swap one texture against another texture on specified mesh.<br />
*Similar to texture-replacement effects, but without the need for an extra texture asset. <br />
<br><br />
<br />
==SetMesh==<br />
{{MethodHeader|public native void SetMesh(string mesh, float fadeDuration)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be displayed.<br />
*'''fadeDuration''' = period in seconds during which mesh visibility will be faded in or out.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMesh("default",0.5);<br />
;Notes<br />
*Shows the specified mesh and hides all other meshes.<br />
*If fadeDuration is 0.0 the mesh transition will be instantaneous.<br />
<br><br />
<br />
==SetMeshAnimationFrame==<br />
{{MethodHeader|public native void SetMeshAnimationFrame(string mesh, float frame)<br><br />
public native void SetMeshAnimationFrame(string mesh, float frame, float period)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be manipulated.<br />
*'''frame''' = the frame position to which the animation is to be moved, this may be an interpolated value.<br />
*'''period''' = the period over which the animation will be moved from its current position to the newly specified point.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationFrame("default",5.0); // move the animation to frame 5 instantaneously<br />
SetMeshAnimationFrame("default",5.0,2.0); // move the animation to frame 5 over 2 seconds<br />
;Notes<br />
*Moves the specified animation to the specified frame.<br />
*For the first variant the transition is instant.<br />
*For the second variant the transition will complete during the specified period.<br />
<br><br />
<br />
==SetMeshAnimationSpeed==<br />
{{MethodHeader|public native void SetMeshAnimationSpeed(string mesh, float speed)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be manipulated.<br />
*'''speed''' = multiplication factor to apply to the original animation speed.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationSpeed("fans",2.0); // run fans at double speed<br />
SetMeshAnimationSpeed("fans",-1.0); // run fans backwards at original speed<br />
;Notes<br />
*Modifies the speed at which the animation is played.<br />
*The original speed is multiplied by the new speed factor.<br />
*Use negative values to make the animation run in reverse.<br />
*It is ''not'' compatible with SetMeshAnimationState function for the same mesh. <br />
<br><br />
<br />
==SetMeshAnimationState==<br />
{{MethodHeader|public native void SetMeshAnimationState(string mesh, bool state)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be played.<br />
*'''state''' = the direction in which the file is to be played, true for forwards, false for backwards.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationState("door",true); // opens the door<br />
SetMeshAnimationState("door",false); // closes the door<br />
;Notes<br />
*This method plays animations and is best suited to those which have defined start and end points such as the opening and closing of a gate or door.<br />
*If ''state'' is true the animation plays forwards from its current position to the last frame. If the current position is already at the last frame the call has no effect.<br />
*If ''state'' is false the animation plays backwards from its current position to the first frame. If the current position is already at the first frame the call has no effect.<br />
<br><br />
<br />
==SetMeshOrientation==<br />
{{MethodHeader|public native void SetMeshOrientation(string meshName, float x, float y, float z)}}<br />
;Parameters<br />
*'''meshName''' = name of the mesh to set the visibility of.<br />
*'''x,y,z''' = rotations about each axis for the new orientation (radians).<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshOrientation("controllershunt",0,0.5,0);<br />
;Notes<br />
*Sets the orientation of the specified mesh relative to the object orientation or attachment point.<br />
<br><br />
<br />
==SetMeshTranslation==<br />
{{MethodHeader|public native void SetMeshTranslation(string meshName, float x, float y, float z)}}<br />
;Parameters<br />
*'''meshName''' = the name of the mesh or submesh to be displayed.<br />
*'''x, y, z''' = new position in the coordinate axis.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshTranslation("controllershunt",0,0,0);<br />
;Notes<br />
*Sets the translation of the specified mesh relative to the object origin or attachment point.<br />
<br><br />
<br />
==SetTextureSelfIllumination==<br />
{{MethodHeader|public native void SetTextureSelfIllumination(string texture, float r, float g, float b)}}<br />
;Parameters<br />
*'''texture''' = root name of ''*.texture.text'' file to query.<br />
*'''r,g,b''' = red green and blue components of self illumination value to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetTextureSelfIllumination("interior",0.5,0.5,0.5);<br />
;Notes<br />
*Applies a [[material emissive color]] to materials that use the texture, using the red, green and blue components specified.<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==StartMeshAnimationLoop==<br />
{{MethodHeader|public native void StartMeshAnimationLoop(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be played.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StartMeshAnimationLoop("windmill");<br />
;Notes<br />
*This method plays animations and is best suited to those which are designed to run in a continuous loop.<br />
*The speed of the animation can be altered using [[#SetMeshAnimationSpeed|SetMeshAnimationSpeed()]]<br />
*Using [[#SetMeshAnimationSpeed|SetMeshAnimationSpeed()]] with a negative value will cause the animation to play in reverse.<br />
*[[#StopMeshAnimation|StopMeshAnimation()]] will halt the animation.<br />
<br><br />
<br />
==StopMeshAnimation==<br />
{{MethodHeader|public native void StopMeshAnimation(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be stopped.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopMeshAnimation("default");<br />
;Notes<br />
*Turns animation off for the specified mesh.<br />
<br><br />
<br />
==SwapTextureOnMesh==<br />
{{MethodHeader|public native void SwapTextureOnMesh(string mesh, string oldTexture, string newTexture)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the texture to be changed.<br />
*'''oldTexture''' = the original ''*.texture.txt'' file to use as the source of the transition.<br />
*'''newTexture''' = the new ''*.texture.txt'' file to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SwapTextureOnMesh("left-passenger-door","gwr","lms");<br />
;Notes<br />
*'''Obsolete: Use SetFXTextureReplacementTexture instead.'''<br />
*Swap one texture against another texture on specified mesh.<br />
*Similar to texture-replacement effects, but without the need for an extra texture asset. <br />
*'''possible bug''' Texture names in the .im file must be lower case for this function to work properly.<br />
<br><br />
<br />
==Code Examples==<br />
<br />
<br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MeshObject&diff=24279Class MeshObject2020-10-04T10:27:44Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****MeshObject<br />
<br><br />
<br />
This is a base class for [[class Asset|Asset]] based game objects that have meshes, effects, animations and particles. Interface methods to deal with these are provided so things like showing or hiding a mesh, attaching a mesh to an attachment point or controlling an animation can be done from a script.<br />
<br />
For animation Trainz interpolates between key frames. This means an intermediate animation frame is calculated dynamically to be-in-synch with the game's framerate.<br />
<br />
Trainzscript is an interpreted scripting language intended to be used to monitor and react to events in the Trainz world, not to perform sophisticated real-time animation tasks. Using a script to start an animation in response to an event in a thread is reasonable. However trying to control animation tightly down to short intervals is likely to provide unsatisfactory results and to adversely affect overall performance of the game.<br />
<br />
<br />
<br />
<br />
<br />
==MeshObject Messages==<br />
Messages related to MeshObject assets:<br />
*[[Animation-Event Message]]<br />
*[[pfx Message]]<br />
<br><br />
<br />
==GetFXAttachment==<br />
{{MethodHeader|public native MeshObject GetFXAttachment(string effect)}}<br />
;Parameters<br />
*'''effect''' = name of the mesh effect to query. <br />
;Returned Value<br />
*Returns a reference to the MeshObject currently attached to the named effect.<br />
;Syntax<br />
MeshObject attachment = GetFXAttachment("coupler");<br />
;Notes<br />
*The method returns null if the effect is unoccupied.<br />
<br><br />
<br />
==GetMeshAnimationFrame==<br />
{{MethodHeader|public native float GetMeshAnimationFrame(string mesh)'''}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be queried.<br />
;Returned Value<br />
*Current fame of the animation file within the specified mesh container.<br />
;Syntax<br />
float height = GetMeshAnimationFrame("zPosition")<br />
;Notes<br />
*Note that the returned value is likely to be an interpreted floating point value.<br />
<br><br />
<br />
==GetMeshAnimationFrameCount==<br />
{{MethodHeader|public native float GetMeshAnimationFrameCount(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be queried.<br />
;Returned Value<br />
*The number of frames in the specified animation.<br />
;Syntax<br />
float positions = GetMeshAnimationFrameCount("lever");<br />
;Notes<br />
*Note that the returned value is a float rather than an integer.<br />
<br><br />
<br />
==GetTextureSelfIlluminationState==<br />
{{MethodHeader|public native bool GetTextureSelfIlluminationState(string texture)'''}}<br />
;Parameters<br />
*'''texture''' = root name of ''*.texture.text'' file to query.<br />
;Returned Value<br />
*Returns true if the specified texture has self illumination set.<br />
;Syntax<br />
bool isEmissive = GetTextureSelfIlluminationState("texture");<br />
;Notes<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==HasMesh==<br />
{{MethodHeader|public native bool HasMesh(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be queried.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (HasMesh("ventilation")) StartMeshAnimationLoop("fans");<br />
;Notes<br />
*<br />
<br><br />
<br />
==SetFXAnimationState==<br />
{{MethodHeader|public native void SetFXAnimationState(string effect, bool state)}}<br />
;Parameters<br />
*'''effect''' = name of attached-animation effect containing the animation to play.<br />
*'''state''' = true to start the animation loop, false to stop.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (gateClosed) SetFXAnimationState("gate",false);<br />
;Notes<br />
<br><br />
<br />
==SetFXAttachment==<br />
{{MethodHeader|public native MeshObject SetFXAttachment(string effect, Asset asset)'''}}<br />
;Parameters<br />
*'''effect''' = effect containing the attachment to be manipulated.<br />
*'''asset''' = mesh asset to attach to the effect. If asset is null any existing asset will be removed and nothing will be added.<br />
;Returned Value<br />
*Returns a reference to the MeshObject which has been attached to the named effect. If the mesh asset isn't "kind mesh", returns null.<br />
;Syntax<br />
MeshObject lamp = SetFXAttachment("lamp0",redlamp);<br />
;Notes<br />
*Returns null if the effect is unoccupied when the method returns.<br />
<br><br />
<br />
==SetFXCoronaTexture==<br />
{{MethodHeader|public native void SetFXCoronaTexture(string effect, Asset texture)}}<br />
;Parameters<br />
*'''effect''' = effect containg the corona to be manipulated.<br />
*'''asset''' = corona texture asset to attach to the effect. If asset is null the corona will be turned off.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXCoronaTexture("stopLight",redCorona);<br />
;Notes<br />
*Other corona parameters such as frequency and size are defined in ''config.txt'' and cannot be altered by script code.<br />
<br><br />
<br />
==SetFXNameText==<br />
{{MethodHeader|public native void SetFXNameText(string effect, string text)}}<br />
;Parameters<br />
*'''effect''' = effect containg the name effect to be changed.<br />
*'''text''' = new string value.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXNameText("home","Shangri-La");<br />
;Notes<br />
*Method will not accept an empty string in the ''text'' parameter.<br />
<br><br />
<br />
==SetFXTextureReplacement==<br />
{{MethodHeader|public native void SetFXTextureReplacement(string effect, Asset textureGroup, int index)}}<br />
;Parameters<br />
*'''effect''' = texture-replacement effect to be changed.<br />
*'''textureGroup''' = reference to texture group asset which is the source of the texture to be applied.<br />
*'''index''' = index into ''textures'' table of texture-group indicating which texture to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXTextureReplacement("load",loadTextures,5); // applies texture 5 from texture-group<br />
SetFXTextureReplacement("load",null,0); // clears the effect, reinstating the texture defined in the asset.<br />
;Notes<br />
*Use null in the textureGroup parameter to turn texture replacement off.<br />
<br><br />
<br />
==SetFXTextureReplacementTexture==<br />
{{MethodHeader|public native void SetFXTextureReplacementTexture(string effectName, string textureName)}}<br />
;Parameters<br />
*'''effectName''' = the name of the texture-replacement effect that is in the effects container of the mesh.<br />
*'''textureName''' = the ''*.texture.txt'' file that will replace the current texture being used on the mesh.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXTextureReplacementTexture("fk_parameter","lms_p3_fk_body/fk_parameter.texture");<br />
;Notes<br />
*This should replace any instance of SwapTextureOnMesh.<br />
*Unlike SwapTextureOnMesh, there is no need to mention what the previous texture being used was. Simply telling Trainz to load the new texture is all that is needed for this to work.<br />
*Swap one texture against another texture on specified mesh.<br />
*Similar to texture-replacement effects, but without the need for an extra texture asset. <br />
<br><br />
<br />
==SetMesh==<br />
{{MethodHeader|public native void SetMesh(string mesh, float fadeDuration)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be displayed.<br />
*'''fadeDuration''' = period in seconds during which mesh visibility will be faded in or out.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMesh("default",0.5);<br />
;Notes<br />
*Shows the specified mesh and hides all other meshes.<br />
*If fadeDuration is 0.0 the mesh transition will be instantaneous.<br />
<br><br />
<br />
==SetMeshAnimationFrame==<br />
{{MethodHeader|public native void SetMeshAnimationFrame(string mesh, float frame)<br><br />
public native void SetMeshAnimationFrame(string mesh, float frame, float period)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be manipulated.<br />
*'''frame''' = the frame position to which the animation is to be moved, this may be an interpolated value.<br />
*'''period''' = the period over which the animation will be moved from its current position to the newly specified point.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationFrame("default",5.0); // move the animation to frame 5 instantaneously<br />
SetMeshAnimationFrame("default",5.0,2.0); // move the animation to frame 5 over 2 seconds<br />
;Notes<br />
*Moves the specified animation to the specified frame.<br />
*For the first variant the transition is instant.<br />
*For the second variant the transition will complete during the specified period.<br />
<br><br />
<br />
==SetMeshAnimationSpeed==<br />
{{MethodHeader|public native void SetMeshAnimationSpeed(string mesh, float speed)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be manipulated.<br />
*'''speed''' = multiplication factor to apply to the original animation speed.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationSpeed("fans",2.0); // run fans at double speed<br />
SetMeshAnimationSpeed("fans",-1.0); // run fans backwards at original speed<br />
;Notes<br />
*Modifies the speed at which the animation is played.<br />
*The original speed is multiplied by the new speed factor.<br />
*Use negative values to make the animation run in reverse.<br />
*It is ''not'' compatible with SetMeshAnimationState function for the same mesh. <br />
<br><br />
<br />
==SetMeshAnimationState==<br />
{{MethodHeader|public native void SetMeshAnimationState(string mesh, bool state)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be played.<br />
*'''state''' = the direction in which the file is to be played, true for forwards, false for backwards.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationState("door",true); // opens the door<br />
SetMeshAnimationState("door",false); // closes the door<br />
;Notes<br />
*This method plays animations and is best suited to those which have defined start and end points such as the opening and closing of a gate or door.<br />
*If ''state'' is true the animation plays forwards from its current position to the last frame. If the current position is already at the last frame the call has no effect.<br />
*If ''state'' is false the animation plays backwards from its current position to the first frame. If the current position is already at the first frame the call has no effect.<br />
<br><br />
<br />
==SetMesh==<br />
{{MethodHeader|public native void SetMesh(string mesh, float fadeDuration)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be displayed.<br />
*'''fadeDuration''' = period in seconds during which mesh visibility will be faded in or out.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMesh("default",0.5);<br />
;Notes<br />
*Shows the specified mesh and hides all other meshes.<br />
*If fadeDuration is 0.0 the mesh transition will be instantaneous.<br />
<br><br />
<br />
==SetMeshTranslation==<br />
{{MethodHeader|public native void SetMeshTranslation(string meshName, float x, float y, float z)}}<br />
;Parameters<br />
*'''meshName''' = the name of the mesh or submesh to be displayed.<br />
*'''x, y, z''' = new position in the coordinate axis.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshTranslation("controllershunt",0,0,0);<br />
;Notes<br />
*Sets the translation of the specified mesh relative to the object origin or attachment point.<br />
<br><br />
<br />
==SetTextureSelfIllumination==<br />
{{MethodHeader|public native void SetTextureSelfIllumination(string texture, float r, float g, float b)}}<br />
;Parameters<br />
*'''texture''' = root name of ''*.texture.text'' file to query.<br />
*'''r,g,b''' = red green and blue components of self illumination value to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetTextureSelfIllumination("interior",0.5,0.5,0.5);<br />
;Notes<br />
*Applies a [[material emissive color]] to materials that use the texture, using the red, green and blue components specified.<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==StartMeshAnimationLoop==<br />
{{MethodHeader|public native void StartMeshAnimationLoop(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be played.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StartMeshAnimationLoop("windmill");<br />
;Notes<br />
*This method plays animations and is best suited to those which are designed to run in a continuous loop.<br />
*The speed of the animation can be altered using [[#SetMeshAnimationSpeed|SetMeshAnimationSpeed()]]<br />
*Using [[#SetMeshAnimationSpeed|SetMeshAnimationSpeed()]] with a negative value will cause the animation to play in reverse.<br />
*[[#StopMeshAnimation|StopMeshAnimation()]] will halt the animation.<br />
<br><br />
<br />
==StopMeshAnimation==<br />
{{MethodHeader|public native void StopMeshAnimation(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be stopped.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopMeshAnimation("default");<br />
;Notes<br />
*Turns animation off for the specified mesh.<br />
<br><br />
<br />
==SwapTextureOnMesh==<br />
{{MethodHeader|public native void SwapTextureOnMesh(string mesh, string oldTexture, string newTexture)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the texture to be changed.<br />
*'''oldTexture''' = the original ''*.texture.txt'' file to use as the source of the transition.<br />
*'''newTexture''' = the new ''*.texture.txt'' file to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SwapTextureOnMesh("left-passenger-door","gwr","lms");<br />
;Notes<br />
*'''Obsolete: Use SetFXTextureReplacementTexture instead.'''<br />
*Swap one texture against another texture on specified mesh.<br />
*Similar to texture-replacement effects, but without the need for an extra texture asset. <br />
*'''possible bug''' Texture names in the .im file must be lower case for this function to work properly.<br />
<br><br />
<br />
==Code Examples==<br />
<br />
<br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Interface&diff=23199Class Interface2020-04-13T15:02:05Z<p>Ciceronmt: /* SetAlert */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**Interface<br />
<br><br />
<br />
*The Interface class provides scripts with methods to handle the user interface.<br />
<br><br />
<br />
==Constants & Messages==<br />
<br />
===RGB Color Constants===<br />
<br><br />
{{TableHeader|width=55%|margin=15px}}<br />
|bgcolor=#EEEEEE|'''Predefined 24 bit Red,Green,Blue color values'''||bgcolor=#EEEEEE|<br />
|-<br />
|width=375|public define int Colour_Red = 0xFF0000||width=225|Red<br />
|-<br />
|public define int Colour_Green = 0x00FF00||Green<br />
|-<br />
|public define int Colour_Blue = 0x0000FF||Blue<br />
|-<br />
|public define int Colour_Yellow = 0xFFFF20||Yellow<br />
|-<br />
|public define int Colour_Cyan = 0xB0C0FF||Cyan<br />
|-<br />
|public define int Colour_White = 0xFFFFFF||White<br />
|-<br />
|public define int Colour_Black = 0x000000||Black<br />
|}<br />
<br><br />
<br />
===Button Element Indices===<br />
<br><br />
{{TableHeader|width=55%|margin=15px}}<br />
|bgcolor=#EEEEEE|'''Constants referring to the buttons on the Driver menu'''||bgcolor=#EEEEEE|<br />
|-<br />
|width=375|public define int ButtonBar_Element_Close = 0||width=225|Exit button<br />
|-<br />
|public define int ButtonBar_Element_Pause = 1||Pause button.<br />
|-<br />
|public define int ButtonBar_Element_Save = 2||Save button.<br />
|-<br />
|public define int ButtonBar_Element_Performance = 3||Performance Settings button.<br />
|-<br />
|public define int ButtonBar_Element_MetricImp = 4||Imperial/Metric button.<br />
|-<br />
|public define int ButtonBar_Element_Find = 5||Find button.<br />
|-<br />
|public define int ButtonBar_Element_Help = 6||On Screen Help button.<br />
|}<br />
<br><br />
<br />
===Related Messages===<br />
*Messages sent to and from Industry objects are listed below:<br />
<br><br />
{{TableHeader|width=55%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|[[Interface Messages|Interface-Event]]||MapViewOff||?||Broadcast<br />
|-<br />
|[[Interface Messages|Interface-Event]]||MapViewOn||?||Broadcast<br />
|-<br />
|[[Interface Messages|Interface-Event]]||Mouse-Enter||MapObject||Broadcast<br />
|-<br />
|[[Interface Messages|Interface-Event]]||Mouse-Leave||?||Broadcast<br />
|-<br />
|[[Interface Messages|Interface-Event]]||Set-Metric-Mode||?||Broadcast<br />
|-<br />
|[[Interface Messages|Interface-Event]]||Toggle-Interface||?||Broadcast<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br />
===AdjustScore===<br />
{{MethodHeader|public void AdjustScore(int delta)}}<br />
;Parameters<br />
*'''delta''' = Positive or negative increment to apply to score.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
AdjustScore(-5);<br />
;Notes<br />
<br><br />
<br />
===Exception===<br />
{{MethodHeader|public native void Exception(string message)}}<br />
;Parameters<br />
*'''message''' = Message to be displayed and logged when the Exception occurs.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.Exception("Fatal Error");<br />
;Notes<br />
*Allows an exception to be explicitly raised by a script in the event of a major error condition.<br />
<br><br />
<br />
===GetDecoupleMode===<br />
{{MethodHeader|public native bool GetDecoupleMode(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*Returns the current decoupling mode from the Driver interface.<br />
;Syntax<br />
bool dcMode = Interface.GetDecoupleMode();<br />
;Notes<br />
*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''.<br />
*When the interface is in decouple mode, the decouple icon will be highlighted.<br />
<br><br />
<br />
===GetDisplayHeight===<br />
{{MethodHeader|public native int GetDisplayHeight(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The height of the user's display in pixels.<br />
;Syntax<br />
int height = Interface.GetDisplayHeight();<br />
;Notes<br />
<br><br />
<br />
===GetDisplayWidth===<br />
{{MethodHeader|public native int GetDisplayWidth(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The width of the user's display in pixels.<br />
;Syntax<br />
int width = Interface.GetDisplayWidth();<br />
;Notes<br />
<br><br />
<br />
===GetElementProperty===<br />
{{MethodHeader|public native string GetElementProperty(string elementId, string propertyId)}}<br />
;Parameters<br />
*'''elementId''' = Element to query.<br />
*'''propertyId''' = Property to query.<br />
;Returned Value<br />
*The value of the specified property if it exists, null otherwise.<br />
;Syntax<br />
<br />
;Notes<br />
*This method is used to read element properties of browser windows in the Trainz interface such as the Minimap.<br />
*See also [[#SetElementProperty|SetElementProperty()]]<br />
<br><br />
<br />
===GetInterfaceVisible===<br />
{{MethodHeader|public native bool GetInterfaceVisible(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the Driver interface is visible, false otherwise.<br />
;Syntax<br />
bool visible = Interface.GetInterfaceVisible();<br />
;Notes<br />
*The entire Driver mode interface can be hidden from view with the ''F5'' key.<br />
<br><br />
<br />
===GetMapView===<br />
{{MethodHeader|public native bool GetMapView(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the map view window is visible, false otherwise.<br />
;Syntax<br />
bool visible = Interface.GetMapView();<br />
;Notes<br />
*The minimap can be displayed or hidden by pressing ''M'' or ''Control + M'';<br />
<br><br />
<br />
===GetMessageWindowVisible===<br />
{{MethodHeader|public native bool GetMessageWindowVisible(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the message window at the top of the screen is visible, false otherwise.<br />
;Syntax<br />
bool visible = Interface.GetMessageWindowVisible();<br />
;Notes<br />
<br><br />
<br />
===GetMetricMode===<br />
{{MethodHeader|public native bool GetMetricMode(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the interface is displaying metric units, false for imperial.<br />
;Syntax<br />
bool imperial = !Interface.GetMetricMode();<br />
;Notes<br />
<br><br />
<br />
===GetObjectiveBarVisible===<br />
{{MethodHeader|public native bool GetObjectiveBarVisible()}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the Driver objective panel is visible, false otherwise.<br />
;Syntax<br />
bool objectivesShown = Interface.GetObjectiveBarVisible();<br />
;Notes<br />
*The objective bar visibility can be toggled with the ''F6'' key.<br />
<br><br />
<br />
===GetScore===<br />
{{MethodHeader|public int GetScore(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current score.<br />
;Syntax<br />
int score = GetScore();<br />
;Notes<br />
<br><br />
<br />
===GetTimeStamp===<br />
{{MethodHeader|public native string GetTimeStamp(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A real time timestamp in seconds.<br />
;Syntax<br />
string timestamp = Interface.GetTimeStamp();<br />
;Notes<br />
*Returns the current time expressed as seconds elapsed since midnight on January 1, 1970 UTC.<br />
*The return value is a string as Trainzscript does not support any extended integer types.<br />
<br><br />
<br />
===GetWaybillWindowVisible===<br />
{{MethodHeader|public bool GetWaybillWindowVisible()}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the Waybill Window is displayed, false otherwise.<br />
;Syntax<br />
bool waybillVisible = GetWaybillWindowVisible();<br />
;Notes<br />
<br><br />
<br />
===HasUnseenMessages===<br />
{{MethodHeader|public native bool HasUnseenMessages(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if there are messages intended for the Driver message window which have not been displayed, false otherwise.<br />
;Syntax<br />
if (Interface.HasUnseenMessages()) Interface.SetMessageWindowVisible(true);<br />
;Notes<br />
*There are unseen messages if the message window is invisible yet messages have been received.<br />
*This is indicated to the user by the highlighted microphone icon on the Driver button bar.<br />
<br><br />
<br />
===HighlightButtonBarElement===<br />
{{MethodHeader|public native void HighlightButtonBarElement(int buttonIndex, bool state)}}<br />
;Parameters<br />
*'''buttonIndex''' = One of the [[#Button Element Indices|Button Element Index]] values defining the button to highlight.<br />
*'''state''' = True to turn highlighting on, false to turn it off.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.HighlightButtonBarElement(ButtonBar_Element_Pause,true);<br />
;Notes<br />
*Turns highlighting for a button on the Driver Menu either on or off.<br />
*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.<br />
*Note that the Driver Menu is not always visible, but you can explicitly show it with [[#ShowDriverButtonMenu|ShowDriverButtonMenu()]]<br />
<br><br />
<br />
===Log===<br />
{{MethodHeader|public native void Log(string message)}}<br />
;Parameters<br />
*'''message''' = Text string to print to log file.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.Log("Session ended");<br />
;Notes<br />
*Prints a string of text to the ''jetlog.txt'' log file.<br />
*See also [[#Print|Print()]].<br />
*Disabled by default in TS12. See [[CCG/Modelling: TrainzOptions File]].<br />
<br><br />
<br />
===LogCallStack===<br />
{{MethodHeader|public native void LogCallStack(string message)}}<br />
;Parameters<br />
*'''message''' = Text string to be included with the call stack and printed to the log file.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.LogCallStack("Call Stack Contents");<br />
;Notes<br />
<br><br />
<br />
===LogResult===<br />
{{MethodHeader|public void LogResult(string message)}}<br />
;Parameters<br />
*'''message''' = Text string to be included with the result and printed to the result log.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.LogResult("Result Appended");<br />
;Notes<br />
<br><br />
<br />
===Print===<br />
{{MethodHeader|Print()}}<br />
;Parameters<br />
*'''message''' = Text string to print to log file and to the message window.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.Print("Session ended");<br />
;Notes<br />
*Prints a string of text to the ''jetlog.txt'' log file and echoes it to the messag window.<br />
*See also [[#Log|Log()]].<br />
<br><br />
<br />
===ResetResults===<br />
{{MethodHeader|public void ResetResults()}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.ResetResults();<br />
;Notes<br />
*Clears the result log.<br />
<br><br />
<br />
===SetAlert===<br />
{{MethodHeader|public native void SetAlert(string message, string iconTexture, float duration, int colour)}}<br />
;Parameters<br />
*'''message''' = Text of message to display.<br />
*'''iconTexture''' = Icon for alert, use an empty string for no icon.<br />
*'''duration''' = Time in seconds to keep the alert displayed.<br />
*'''colour''' = Color of alert text as a 24 bit RGB or as one of the [[#RGB Color Constants|RGB Color Constants]].<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetAlert("Train Halted due to leaves on line","",10.0,Interface.Colour_Red);<br />
;Notes: do not use in "Trainz 2019".<br />
<br><br />
<br />
===SetDecoupleMode===<br />
{{MethodHeader|public native void SetDecoupleMode(bool enabled)}}<br />
;Parameters<br />
*'''enabled''' = Use true to enable decoupling, false to prevent.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetDecoupleMode(false);<br />
;Notes<br />
*The driver interface decoupling mode can be enabled or disabled using the icon on the Driver button bar or by keypress ''Ctrl + D''.<br />
*When the interface is in decouple mode, the decouple icon will be highlighted.<br />
<br><br />
<br />
===SetElementProperty===<br />
{{MethodHeader|public native void SetElementProperty(string elementId, string propertyId, string value)}}<br />
;Parameters<br />
*'''elementId''' = Element to update.<br />
*'''propertyId''' = Property to update.<br />
*'''value''' = New value to set.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetElementProperty(elementId,propertyId,value);<br />
;Notes<br />
*This method is used to modify element properties of browser windows in the Trainz interface such as the Minimap<br />
*See also [[#GetElementProperty|GetElementProperty()]]<br />
<br><br />
<br />
===SetHelperIconScale===<br />
{{MethodHeader|public native void SetHelperIconScale(float scale)}}<br />
;Parameters<br />
*'''scale''' = Scale factor to apply to on screen junction icons etc, range 0.5..1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetHelperIconScale(0.5); // set to 50% of default size<br />
;Notes<br />
<br><br />
<br />
===SetMapView===<br />
{{MethodHeader|public native void SetMapView(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetMapView(true);<br />
;Notes<br />
*The user can show or hide the map view window by pressing ''M'' or ''Ctrl + M'' on the keyboard<br />
<br><br />
<br />
===SetMessageWindowVisible===<br />
{{MethodHeader|public native void SetMessageWindowVisible(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (Interface.HasUnseenMessages()) Interface.SetMessageWindowVisible(true);<br />
;Notes<br />
*See Also [[#GetMessageWindowVisible|GetMessageWindowVisible()]] and [[#HasUnseenMessages|HasUnseenMessages()]].<br />
<br><br />
<br />
===SetMetricMode===<br />
{{MethodHeader|public native mode SetMetricMode(bool useMetric)}}<br />
;Parameters<br />
*'''useMetric''' = Use true to select metric units, false to select imperial.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetMetricMode(false);<br />
;Notes<br />
**See also [[#GetMetricMode|GetMetricMode()]].<br />
<br><br />
<br />
===SetObjective===<br />
{{MethodHeader|public native void SetObjective(string message, string iconTexture)}}<br />
;Parameters<br />
*'''message''' = Text for objective message.<br />
*'''iconTexture''' = Icon to display, use an empty string to omit the icon.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetObjective("Line closed ahead","");<br />
;Notes<br />
*This method will cause the driver objective panel to become visible.<br />
*The User can hide or show the panel at their discretion.<br />
<br><br />
<br />
===SetObjectiveBarVisible===<br />
{{MethodHeader|public native void SetObjectiveBarVisible(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetObjectiveBarVisible(false);<br />
;Notes<br />
*The Driver objective bar can be toggled between invisible and visible by pressing the ''F6'' key.<br />
<br><br />
<br />
===SetObjectiveIcon===<br />
{{MethodHeader|public native void SetObjectiveIcon(string iconTexture)}}<br />
;Parameters<br />
*'''iconTexture''' = Icon to display, use an empty string to remove a previous icon.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetObjectiveIcon("");<br />
;Notes<br />
*The image file to use as the icon must be a 32x32 *.tga image.<br />
<br><br />
<br />
===SetResults===<br />
{{MethodHeader|public native void SetResults(string message)}}<br />
;Parameters<br />
*'''message''' = String to display in results box.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetResults("Result text to display");<br />
;Notes<br />
*Displays the results of a scenario.<br />
*This method will change the activities menu to the results screen and fill out the results box with the given string.<br />
*The results will be visible when the user closes the activity module.<br />
<br><br />
<br />
===SetScore===<br />
{{MethodHeader|public native void SetScore(string message)}}<br />
;Parameters<br />
*'''message''' = Message to display in the activity bar.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetScore("Score");<br />
;Notes<br />
<br><br />
<br />
===SetTooltip===<br />
{{MethodHeader|public native void SetTooltip(Browser tooltip)}}<br />
;Parameters<br />
*'''tooltip''' = Browser to use as a tooltip window, if null the current tooltip will be removed.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetTooltip(tooltip);<br />
;Notes<br />
*Sets the tooltip that should follow the mouse around.<br />
*This method specifies that tooltip should follow the mouse.<br />
*Any existing tooltip will be replaced.<br />
*If this Browser is released, it will be removed automatically.<br />
<br><br />
<br />
===SetWaybillWindowVisible===<br />
{{MethodHeader|public void SetWaybillWindowVisible(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.SetWaybillWindowVisible(false);<br />
;Notes<br />
<br><br />
<br />
===ShowDriverButtonMenu===<br />
{{MethodHeader|public native void ShowDriverButtonMenu(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.ShowDriverButtonMenu(true);<br />
;Notes<br />
*Showing and hiding is not immediate, there may be a delay before it slides on or off.<br />
<br><br />
<br />
===ShowObjective===<br />
{{MethodHeader|public native void ShowObjective(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.ShowObjective(true);<br />
;Notes<br />
<br><br />
<br />
===ShowOnScreenHelp===<br />
{{MethodHeader|public native void ShowOnScreenHelp(bool visible)}}<br />
;Parameters<br />
*'''visible''' = Use true to display and false to hide.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.ShowOnScreenHelp(true);<br />
;Notes<br />
*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.<br />
<br><br />
<br />
===WarnObsolete===<br />
{{MethodHeader|public native void WarnObsolete(string warning)}}<br />
;Parameters<br />
*'''warning''' = Message to log to ''jetlog.txt'' at the first time this method is called.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Interface.WarnObsolete("Method is obsolete");<br />
;Notes<br />
*Generates a runtime warning that a given function or usage is obsolete.<br />
*The warning goes to the JetLog.txt file and is not visible to the casual user within Trainz. <br />
*Only one warning is generated for any given warning string.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21456Class Locomotive2019-09-29T15:34:52Z<p>Ciceronmt: /* SetEngineSetting */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBellState===<br />
{{MethodHeader|public native void SetBellState(bool state)}}<br />
;Parameters<br />
*'''state''' = If true plays and loops the sound of a bell, a value of false will deactivation it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBellState(true);<br />
;Notes<br />
*Asset of kind "hornsound" must be in the locomotive config.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*For a slow increase in pressure of the main reservoir.<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight" (value 0,0.5,1 only)<br />
**"horn"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21455Class Locomotive2019-09-29T15:34:25Z<p>Ciceronmt: /* SetEngineSetting */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBellState===<br />
{{MethodHeader|public native void SetBellState(bool state)}}<br />
;Parameters<br />
*'''state''' = If true plays and loops the sound of a bell, a value of false will deactivation it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBellState(true);<br />
;Notes<br />
*Asset of kind "hornsound" must be in the locomotive config.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*For a slow increase in pressure of the main reservoir.<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"(value 0,0.5,1 only)<br />
**"horn"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21445Class Locomotive2019-09-24T09:32:22Z<p>Ciceronmt: /* SetBellState */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBellState===<br />
{{MethodHeader|public native void SetBellState(bool state)}}<br />
;Parameters<br />
*'''state''' = If true plays and loops the sound of a bell, a value of false will deactivation it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBellState(true);<br />
;Notes<br />
*Asset of kind "hornsound" must be in the locomotive config.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*For a slow increase in pressure of the main reservoir.<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"<br />
**"horn"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21444Class Locomotive2019-09-24T09:30:02Z<p>Ciceronmt: /* SetEngineSetting */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBellState===<br />
{{MethodHeader|public native void SetBellState(bool state)}}<br />
;Parameters<br />
*'''state''' = If true plays and loops the sound of a bell, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBellState(true);<br />
;Notes<br />
*Asset of kind "hornsound" must be in the locomotive config.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*For a slow increase in pressure of the main reservoir.<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"<br />
**"horn"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21443Class Locomotive2019-09-24T09:27:52Z<p>Ciceronmt: /* Methods */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBellState===<br />
{{MethodHeader|public native void SetBellState(bool state)}}<br />
;Parameters<br />
*'''state''' = If true plays and loops the sound of a bell, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBellState(true);<br />
;Notes<br />
*Asset of kind "hornsound" must be in the locomotive config.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*For a slow increase in pressure of the main reservoir.<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21442Class Locomotive2019-09-23T16:01:04Z<p>Ciceronmt: /* SetCompressorEfficiency */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*For a slow increase in pressure of the main reservoir.<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=List_of_Standard_Messages&diff=21344List of Standard Messages2019-09-14T13:43:20Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
<br />
*This list is a first step towards documenting Trainz use of messages. It has been generated by scanning one or two copies of jetlog.txt from TC, together with the TC scripts folder and the TRS2006 copy of index.chm. There are probably many standard messages missing and there are some obscure ones listed. Please add anything that is missing. I will progressively link and document the list. <br />
__NOTOC__ __NOEDITSECTION__<br />
<br><br />
<br />
{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"<br />
|-<br />
|width="15"|<br />
|width="250"|Message<br />
|width="165"|Source & Destination<br />
|Purpose<br />
|<br />
{{IndexSplit|A}}<br />
|-<br />
|<br />
|[[Animation-Event Message|Animation-Event,''eventname'']]<br />
|meshobject > meshobject<br />
|Sent when an animation triggers an event. These events are included in *.kin files generated by Max when the 'Query for Event' box is checked during animation export. They are used to enable code to be executed in sync with animations.<br />
{{IndexSplit|B}}<br />
|-<br />
|<br />
|BaseIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|[[Browser Messages|Browser-Closed,''null'']]<br />
|browser > broadcast<br />
|Sent when any in game browser is closed.<br />
|-<br />
|<br />
|Browser-Key,ScriptObjectives<br />
|? > ?<br />
|Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?<br />
|-<br />
|<br />
|[[Browser Messages|Browser-URL,''live://linkname'']]<br />
|browser > broadcast<br />
|Sent when the user clicks in a link in a custom browser<br />
|-<br />
|<br />
|Build,Cancelled<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Completed<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Started<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
{{IndexSplit|C}}<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Interior-Changed]]<br />
|new train? > broadcast<br />
|Sent when a different train is selected.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Target-Changed]]<br />
|new target? > broadcast<br />
|Sent when the camera selects a different target, may not be a train.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,External-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Internal-View]]<br />
|? > Broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Roaming-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Tracking-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|Check,Speed<br />
|vehicle > vehicle<br />
|Sent continuously to ensure that jetlog isn't allowed to remain legible :-)<br />
{{IndexSplit|D}}<br />
|-<br />
|<br />
|DriverCharacter,BoardedTrain<br />
|driver > broadcast<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|DriverCharacter,Created<br />
|driver > broadcast<br />
|Sent when a driver character is initialised<br />
|-<br />
|<br />
|DriverCharacter,LeftTrain<br />
|driver > broadcast<br />
|Sent when a driver leaves a train<br />
|-<br />
|<br />
|DriverDisplay,ResetTripMeter<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|DriverModule,DCC-Panel-Created]]<br />
|? > broadcast<br />
|Sent when driver selection widget has been created<br />
|-<br />
|<br />
|DriverSetup,CharactersDone<br />
|? > broadcast<br />
|Sent when driver characters have been initialised<br />
{{IndexSplit|G}}<br />
|-<br />
|<br />
|GenericIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|GenericIndustry,ProcessComplete<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|H}}<br />
|-<br />
|<br />
|HandleTrain,Release<br />
|industry > train<br />
|Sent when an industry loading operation has completed<br />
{{IndexSplit|I}}<br />
|-<br />
|<br />
|[[Interface Messages|Interface,ClickSystemButton]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOff]]<br />
|? > broadcast<br />
|Sent when the minimap is opened<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOn]]<br />
|? > broadcast<br />
|Sent when the minimap is closed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,New-Driver-Message]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Enter]]<br />
|object > broadcast<br />
|Sent on mouseover an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Leave]]<br />
|? > broadcast<br />
|Sent on mouseout of an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]<br />
|? > broadcast<br />
|Sent when the interface units are changed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-Interface]]<br />
|? > broadcast<br />
|Sent when the main HUD is turned on or off<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Left-Click]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]<br />
|<br />
|<br />
{{IndexSplit|J}}<br />
|-<br />
|<br />
|[[Object Messages|Junction,Enter]]<br />
|junction > train<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerEnter]]<br />
|junction > train<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerLeave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Leave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Stopped]]<br />
|junction > train<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|Junction,Toggled<br />
|junction > broadcast<br />
|Sent when a junctionbase object is toggled<br />
{{IndexSplit|M}}<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Details]]<br />
|? > object<br />
|Sent when the user right-clicks an object and selects 'View Details' from the resulting menu, some assets provide a built-in browser in response to this message.<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Schedule]]<br />
|? > ?<br />
|Sent when the user right-clicks an object and selects 'View Schedule' from the resulting menu. The vehicle must have a timetable for this menu item to be displayed.<br />
|-<br />
|<br />
|MeshObject-Click,*<br />
|<br />
|<br />
{{IndexSplit|O}}<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|crossing > crossing<br />
|Train has entered crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|crossing > crossing<br />
|Train has left crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > junction<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|train > junction<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > junction<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trackmark<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trackmark<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trackmark<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trigger<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trigger<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trigger<br />
|Sent when a train stops at a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|OnlineAccess,ReceiveMessage<br />
|? > onlineaccess<br />
|Message awaiting collection<br />
|-<br />
|<br />
|OnlineAccess,StatusChange<br />
|? > onlineaccess<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,StatusChange<br />
|? > onlinegroup<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,UsersChange<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserRemoved,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserAdded,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserStatus,*<br />
|? > onlinegroup<br />
|Network users change<br />
{{IndexSplit|P}}<br />
|-<br />
|<br />
|Permit,Granted<br />
|? > objectrequesting<br />
|Sent when a track or junction permit is granted<br />
|-<br />
|<br />
|PortalTunnel,EmitTrain<br />
|portal > portal<br />
|Sent when a portal produces a train<br />
|-<br />
|<br />
|[[pfx Message|pfx,''particledata'']]<br />
|script > object<br />
|Sent by script to control particle effects<br />
|-<br />
|<br />
|Process-Start,''processname''<br />
|industry > industry<br />
|Sent when an industry process has started<br />
|-<br />
|<br />
|Process-Stop,''processname''<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|S}}<br />
|-<br />
|<br />
|Scenario,KillMonitor<br />
|? > ?<br />
|Sent to terminate a scenario thread<br />
|-<br />
|<br />
|Scenario,Quit<br />
|? > ?<br />
|Sent to terminate a scenario<br />
|-<br />
|<br />
|ScenarioBehaviour,Touch<br />
|? > ?<br />
|Called on a parent rule when the child rule completes. May also indicate other state changes.<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Enter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerEnter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerLeave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Leave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Stopped]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|Schedule,Abort<br />
|train > train<br />
|Sent when a command schedule is abandoned<br />
|-<br />
|<br />
|Schedule,Complete<br />
|train > broadcast<br />
|Sent when a command schedule is completed<br />
|-<br />
|<br />
|Schedule,Touch<br />
|train > train<br />
|Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.<br />
|-<br />
|<br />
|[[Signal Messages|Signal,StateChanged]]<br />
|signal > broadcast<br />
|Signal aspect has changed<br />
|-<br />
|<br />
|StationMain.Timer,Tick<br />
|station > station<br />
|Sent by stations to initiate a periodic update<br />
{{IndexSplit|T}}<br />
|-<br />
|<br />
|Timer,Tick<br />
|? > ?<br />
|A common custom message used by various scripts to implement timed polling.<br />
|-<br />
|<br />
|Timetable,<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Enter]]<br />
|trackmark > train<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Leave]]<br />
|trackmark > train<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Stopped]]<br />
|trackmark > train<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal]]<br />
|signal > train<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal notify]]<br />
|train > broadcast<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Passed Signal]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Over speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Cleanup]]<br />
|? > ?<br />
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.<br />
|-<br />
|<br />
|[[Train Messages|Train,Deleted]]<br />
|train > ?<br />
|Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.<br />
|-<br />
|<br />
|Train,ThreadAITrainStoppedMovingFailed<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to enter the expected junction.<br />
|-<br />
|<br />
|Train,CommandCoupleVehicleTimer<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.<br />
|-<br />
|<br />
|Train,CommandReverseTrain.Pulse<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.<br />
|-<br />
|<br />
|[[Train Messages|Train,DriverBoarded]]<br />
|train > driver<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|Train,NotifyBell<br />
|train > train<br />
|Sent when the interface bell button is clicked.<br />
|-<br />
|<br />
|Train,BrakeLightChanged<br />
|train > ?<br />
|Sent if the train's brake is moved to Modes 0 or from Modes 0.<br />
|-<br />
|<br />
|Train,ThrottleChanged<br />
|train > ?<br />
|Sent if throttle position changes.<br />
|-<br />
|<br />
|Train,NotifyHeadlights<br />
|train > train<br />
|Sent when the interface headlight button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHorn<br />
|train > train<br />
|Sent when the interface horn button is clicked<br />
|-<br />
|<br />
|Train,NotifyPantographs<br />
|train > train<br />
|Sent when the interface pantograph button is clicked.<br />
|-<br />
|<br />
|Train,NotifySanding<br />
|<br />
|<br />
|-<br />
|<br />
|Train,TurnAround<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,ReachedTarget]]<br />
|? > ?<br />
|Sent by Trainz when a train reaches the specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,SlowingForTarget]]<br />
|train > train<br />
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Apply]]<br />
|<br />
|It works?<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Release]]<br />
|<br />
|It works?<br />
|-<br />
|<br />
|[[Train Messages|Train,StartedMoving]]<br />
|train > train<br />
|Sent when a train starts to move<br />
|-<br />
|<br />
|[[Train Messages|Train,StoppedMoving]]<br />
|train > train<br />
|Sent when a train stops<br />
|-<br />
|<br />
|Train,Tick<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,EnterTrack]]<br />
|track > train<br />
|Sent when a train enters a track section<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerEnterTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerLeaveTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,LeaveTrack]]<br />
|track > train<br />
|Sent when a train leaves a track section<br />
|-<br />
|<br />
|Train.ThreadAITrainStuck,Touch<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|TrainTimetable,Touch<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Enter]]<br />
|trigger > train<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Leave]]<br />
|trigger > train<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Stopped]]<br />
|trigger > train<br />
|Sent when a train stops at a trigger<br />
{{IndexSplit|V}}<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,BadCouple]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples at excessive speed<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Collided]]<br />
|vehicle > broadcast<br />
|Sent on a collision between vehicles<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Coupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples to another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Decoupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle uncouples from another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Derailed]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle is derailed<br />
|-<br />
|<br />
|Vehicle,LoadComplete<br />
|industry > vehicle<br />
|Sent when loading of a vehicle from an industry is complete<br />
|-<br />
|<br />
|Vehicle,Coupler breakage<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler breakage notify<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler Repaired<br />
|<br />
|<br />
{{IndexSplit|W}}<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[ModuleInit Message|World,ModuleInit]]<br />
|? > broadcast<br />
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes<br />
|-<br />
|<br />
|World,Paused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Unpaused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Day<br />
|? > broadcast<br />
|Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver<br />
|-<br />
|<br />
|World,Night<br />
|? > broadcast<br />
|Sent 1.) at ca. 18:15 ~ 0.260611 GameTime 2.) whenever TS starts Driver or Surveyor and Playtime is beween 18:15 and 05:45 3.) sometimes when TS switched to Driver or Surveyor<br />
|}</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=List_of_Standard_Messages&diff=21342List of Standard Messages2019-09-14T12:23:43Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
<br />
*This list is a first step towards documenting Trainz use of messages. It has been generated by scanning one or two copies of jetlog.txt from TC, together with the TC scripts folder and the TRS2006 copy of index.chm. There are probably many standard messages missing and there are some obscure ones listed. Please add anything that is missing. I will progressively link and document the list. <br />
__NOTOC__ __NOEDITSECTION__<br />
<br><br />
<br />
{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"<br />
|-<br />
|width="15"|<br />
|width="250"|Message<br />
|width="165"|Source & Destination<br />
|Purpose<br />
|<br />
{{IndexSplit|A}}<br />
|-<br />
|<br />
|[[Animation-Event Message|Animation-Event,''eventname'']]<br />
|meshobject > meshobject<br />
|Sent when an animation triggers an event. These events are included in *.kin files generated by Max when the 'Query for Event' box is checked during animation export. They are used to enable code to be executed in sync with animations.<br />
{{IndexSplit|B}}<br />
|-<br />
|<br />
|BaseIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|[[Browser Messages|Browser-Closed,''null'']]<br />
|browser > broadcast<br />
|Sent when any in game browser is closed.<br />
|-<br />
|<br />
|Browser-Key,ScriptObjectives<br />
|? > ?<br />
|Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?<br />
|-<br />
|<br />
|[[Browser Messages|Browser-URL,''live://linkname'']]<br />
|browser > broadcast<br />
|Sent when the user clicks in a link in a custom browser<br />
|-<br />
|<br />
|Build,Cancelled<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Completed<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Started<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
{{IndexSplit|C}}<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Interior-Changed]]<br />
|new train? > broadcast<br />
|Sent when a different train is selected.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Target-Changed]]<br />
|new target? > broadcast<br />
|Sent when the camera selects a different target, may not be a train.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,External-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Internal-View]]<br />
|? > Broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Roaming-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Tracking-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|Check,Speed<br />
|vehicle > vehicle<br />
|Sent continuously to ensure that jetlog isn't allowed to remain legible :-)<br />
{{IndexSplit|D}}<br />
|-<br />
|<br />
|DriverCharacter,BoardedTrain<br />
|driver > broadcast<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|DriverCharacter,Created<br />
|driver > broadcast<br />
|Sent when a driver character is initialised<br />
|-<br />
|<br />
|DriverCharacter,LeftTrain<br />
|driver > broadcast<br />
|Sent when a driver leaves a train<br />
|-<br />
|<br />
|DriverDisplay,ResetTripMeter<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|DriverModule,DCC-Panel-Created]]<br />
|? > broadcast<br />
|Sent when driver selection widget has been created<br />
|-<br />
|<br />
|DriverSetup,CharactersDone<br />
|? > broadcast<br />
|Sent when driver characters have been initialised<br />
{{IndexSplit|G}}<br />
|-<br />
|<br />
|GenericIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|GenericIndustry,ProcessComplete<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|H}}<br />
|-<br />
|<br />
|HandleTrain,Release<br />
|industry > train<br />
|Sent when an industry loading operation has completed<br />
{{IndexSplit|I}}<br />
|-<br />
|<br />
|[[Interface Messages|Interface,ClickSystemButton]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOff]]<br />
|? > broadcast<br />
|Sent when the minimap is opened<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOn]]<br />
|? > broadcast<br />
|Sent when the minimap is closed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,New-Driver-Message]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Enter]]<br />
|object > broadcast<br />
|Sent on mouseover an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Leave]]<br />
|? > broadcast<br />
|Sent on mouseout of an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]<br />
|? > broadcast<br />
|Sent when the interface units are changed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-Interface]]<br />
|? > broadcast<br />
|Sent when the main HUD is turned on or off<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Left-Click]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]<br />
|<br />
|<br />
{{IndexSplit|J}}<br />
|-<br />
|<br />
|[[Object Messages|Junction,Enter]]<br />
|junction > train<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerEnter]]<br />
|junction > train<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerLeave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Leave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Stopped]]<br />
|junction > train<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|Junction,Toggled<br />
|junction > broadcast<br />
|Sent when a junctionbase object is toggled<br />
{{IndexSplit|M}}<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Details]]<br />
|? > object<br />
|Sent when the user right-clicks an object and selects 'View Details' from the resulting menu, some assets provide a built-in browser in response to this message.<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Schedule]]<br />
|? > ?<br />
|Sent when the user right-clicks an object and selects 'View Schedule' from the resulting menu. The vehicle must have a timetable for this menu item to be displayed.<br />
|-<br />
|<br />
|MeshObject-Click,*<br />
|<br />
|<br />
{{IndexSplit|O}}<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|crossing > crossing<br />
|Train has entered crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|crossing > crossing<br />
|Train has left crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > junction<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|train > junction<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > junction<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trackmark<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trackmark<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trackmark<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trigger<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trigger<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trigger<br />
|Sent when a train stops at a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|OnlineAccess,ReceiveMessage<br />
|? > onlineaccess<br />
|Message awaiting collection<br />
|-<br />
|<br />
|OnlineAccess,StatusChange<br />
|? > onlineaccess<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,StatusChange<br />
|? > onlinegroup<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,UsersChange<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserRemoved,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserAdded,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserStatus,*<br />
|? > onlinegroup<br />
|Network users change<br />
{{IndexSplit|P}}<br />
|-<br />
|<br />
|Permit,Granted<br />
|? > objectrequesting<br />
|Sent when a track or junction permit is granted<br />
|-<br />
|<br />
|PortalTunnel,EmitTrain<br />
|portal > portal<br />
|Sent when a portal produces a train<br />
|-<br />
|<br />
|[[pfx Message|pfx,''particledata'']]<br />
|script > object<br />
|Sent by script to control particle effects<br />
|-<br />
|<br />
|Process-Start,''processname''<br />
|industry > industry<br />
|Sent when an industry process has started<br />
|-<br />
|<br />
|Process-Stop,''processname''<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|S}}<br />
|-<br />
|<br />
|Scenario,KillMonitor<br />
|? > ?<br />
|Sent to terminate a scenario thread<br />
|-<br />
|<br />
|Scenario,Quit<br />
|? > ?<br />
|Sent to terminate a scenario<br />
|-<br />
|<br />
|ScenarioBehaviour,Touch<br />
|? > ?<br />
|Called on a parent rule when the child rule completes. May also indicate other state changes.<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Enter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerEnter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerLeave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Leave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Stopped]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|Schedule,Abort<br />
|train > train<br />
|Sent when a command schedule is abandoned<br />
|-<br />
|<br />
|Schedule,Complete<br />
|train > broadcast<br />
|Sent when a command schedule is completed<br />
|-<br />
|<br />
|Schedule,Touch<br />
|train > train<br />
|Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.<br />
|-<br />
|<br />
|[[Signal Messages|Signal,StateChanged]]<br />
|signal > broadcast<br />
|Signal aspect has changed<br />
|-<br />
|<br />
|StationMain.Timer,Tick<br />
|station > station<br />
|Sent by stations to initiate a periodic update<br />
{{IndexSplit|T}}<br />
|-<br />
|<br />
|Timer,Tick<br />
|? > ?<br />
|A common custom message used by various scripts to implement timed polling.<br />
|-<br />
|<br />
|Timetable,<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Enter]]<br />
|trackmark > train<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Leave]]<br />
|trackmark > train<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Stopped]]<br />
|trackmark > train<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal]]<br />
|signal > train<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal notify]]<br />
|train > broadcast<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Passed Signal]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Over speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Cleanup]]<br />
|? > ?<br />
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.<br />
|-<br />
|<br />
|[[Train Messages|Train,Deleted]]<br />
|train > ?<br />
|Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.<br />
|-<br />
|<br />
|Train,ThreadAITrainStoppedMovingFailed<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to enter the expected junction.<br />
|-<br />
|<br />
|Train,CommandCoupleVehicleTimer<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.<br />
|-<br />
|<br />
|Train,CommandReverseTrain.Pulse<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.<br />
|-<br />
|<br />
|[[Train Messages|Train,DriverBoarded]]<br />
|train > driver<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|Train,NotifyBell<br />
|train > train<br />
|Sent when the interface bell button is clicked.<br />
|-<br />
|<br />
|Train,BrakeLightChanged<br />
|train > ?<br />
|Sent when the interface train brake button is clicked.<br />
|-<br />
|<br />
|Train,ThrottleChanged<br />
|train > ?<br />
|Sent when the interface throttle button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHeadlights<br />
|train > train<br />
|Sent when the interface headlight button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHorn<br />
|train > train<br />
|Sent when the interface horn button is clicked<br />
|-<br />
|<br />
|Train,NotifyPantographs<br />
|train > train<br />
|Sent when the interface pantograph button is clicked.<br />
|-<br />
|<br />
|Train,NotifySanding<br />
|<br />
|<br />
|-<br />
|<br />
|Train,TurnAround<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,ReachedTarget]]<br />
|? > ?<br />
|Sent by Trainz when a train reaches the specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,SlowingForTarget]]<br />
|train > train<br />
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Apply]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Release]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,StartedMoving]]<br />
|train > train<br />
|Sent when a train starts to move<br />
|-<br />
|<br />
|[[Train Messages|Train,StoppedMoving]]<br />
|train > train<br />
|Sent when a train stops<br />
|-<br />
|<br />
|[[Train Messages|Train,ThrottleChanged]]<br />
|<br />
|<br />
|-<br />
|<br />
|Train,Tick<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,EnterTrack]]<br />
|track > train<br />
|Sent when a train enters a track section<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerEnterTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerLeaveTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,LeaveTrack]]<br />
|track > train<br />
|Sent when a train leaves a track section<br />
|-<br />
|<br />
|Train.ThreadAITrainStuck,Touch<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|TrainTimetable,Touch<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Enter]]<br />
|trigger > train<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Leave]]<br />
|trigger > train<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Stopped]]<br />
|trigger > train<br />
|Sent when a train stops at a trigger<br />
{{IndexSplit|V}}<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,BadCouple]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples at excessive speed<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Collided]]<br />
|vehicle > broadcast<br />
|Sent on a collision between vehicles<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Coupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples to another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Decoupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle uncouples from another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Derailed]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle is derailed<br />
|-<br />
|<br />
|Vehicle,LoadComplete<br />
|industry > vehicle<br />
|Sent when loading of a vehicle from an industry is complete<br />
|-<br />
|<br />
|Vehicle,Coupler breakage<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler breakage notify<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler Repaired<br />
|<br />
|<br />
{{IndexSplit|W}}<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[ModuleInit Message|World,ModuleInit]]<br />
|? > broadcast<br />
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes<br />
|-<br />
|<br />
|World,Paused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Unpaused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Day<br />
|? > broadcast<br />
|Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver<br />
|-<br />
|<br />
|World,Night<br />
|? > broadcast<br />
|Sent 1.) at ca. 18:15 ~ 0.260611 GameTime 2.) whenever TS starts Driver or Surveyor and Playtime is beween 18:15 and 05:45 3.) sometimes when TS switched to Driver or Surveyor<br />
|}</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=List_of_Standard_Messages&diff=21340List of Standard Messages2019-09-14T11:58:42Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
<br />
*This list is a first step towards documenting Trainz use of messages. It has been generated by scanning one or two copies of jetlog.txt from TC, together with the TC scripts folder and the TRS2006 copy of index.chm. There are probably many standard messages missing and there are some obscure ones listed. Please add anything that is missing. I will progressively link and document the list. <br />
__NOTOC__ __NOEDITSECTION__<br />
<br><br />
<br />
{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"<br />
|-<br />
|width="15"|<br />
|width="250"|Message<br />
|width="165"|Source & Destination<br />
|Purpose<br />
|<br />
{{IndexSplit|A}}<br />
|-<br />
|<br />
|[[Animation-Event Message|Animation-Event,''eventname'']]<br />
|meshobject > meshobject<br />
|Sent when an animation triggers an event. These events are included in *.kin files generated by Max when the 'Query for Event' box is checked during animation export. They are used to enable code to be executed in sync with animations.<br />
{{IndexSplit|B}}<br />
|-<br />
|<br />
|BaseIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|[[Browser Messages|Browser-Closed,''null'']]<br />
|browser > broadcast<br />
|Sent when any in game browser is closed.<br />
|-<br />
|<br />
|Browser-Key,ScriptObjectives<br />
|? > ?<br />
|Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?<br />
|-<br />
|<br />
|[[Browser Messages|Browser-URL,''live://linkname'']]<br />
|browser > broadcast<br />
|Sent when the user clicks in a link in a custom browser<br />
|-<br />
|<br />
|Build,Cancelled<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Completed<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Started<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
{{IndexSplit|C}}<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Interior-Changed]]<br />
|new train? > broadcast<br />
|Sent when a different train is selected.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Target-Changed]]<br />
|new target? > broadcast<br />
|Sent when the camera selects a different target, may not be a train.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,External-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Internal-View]]<br />
|? > Broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Roaming-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Tracking-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|Check,Speed<br />
|vehicle > vehicle<br />
|Sent continuously to ensure that jetlog isn't allowed to remain legible :-)<br />
{{IndexSplit|D}}<br />
|-<br />
|<br />
|DriverCharacter,BoardedTrain<br />
|driver > broadcast<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|DriverCharacter,Created<br />
|driver > broadcast<br />
|Sent when a driver character is initialised<br />
|-<br />
|<br />
|DriverCharacter,LeftTrain<br />
|driver > broadcast<br />
|Sent when a driver leaves a train<br />
|-<br />
|<br />
|DriverDisplay,ResetTripMeter<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|DriverModule,DCC-Panel-Created]]<br />
|? > broadcast<br />
|Sent when driver selection widget has been created<br />
|-<br />
|<br />
|DriverSetup,CharactersDone<br />
|? > broadcast<br />
|Sent when driver characters have been initialised<br />
{{IndexSplit|G}}<br />
|-<br />
|<br />
|GenericIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|GenericIndustry,ProcessComplete<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|H}}<br />
|-<br />
|<br />
|HandleTrain,Release<br />
|industry > train<br />
|Sent when an industry loading operation has completed<br />
{{IndexSplit|I}}<br />
|-<br />
|<br />
|[[Interface Messages|Interface,ClickSystemButton]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOff]]<br />
|? > broadcast<br />
|Sent when the minimap is opened<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOn]]<br />
|? > broadcast<br />
|Sent when the minimap is closed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,New-Driver-Message]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Enter]]<br />
|object > broadcast<br />
|Sent on mouseover an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Leave]]<br />
|? > broadcast<br />
|Sent on mouseout of an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]<br />
|? > broadcast<br />
|Sent when the interface units are changed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-Interface]]<br />
|? > broadcast<br />
|Sent when the main HUD is turned on or off<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Left-Click]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]<br />
|<br />
|<br />
{{IndexSplit|J}}<br />
|-<br />
|<br />
|[[Object Messages|Junction,Enter]]<br />
|junction > train<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerEnter]]<br />
|junction > train<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerLeave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Leave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Stopped]]<br />
|junction > train<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|Junction,Toggled<br />
|junction > broadcast<br />
|Sent when a junctionbase object is toggled<br />
{{IndexSplit|M}}<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Details]]<br />
|? > object<br />
|Sent when the user right-clicks an object and selects 'View Details' from the resulting menu, some assets provide a built-in browser in response to this message.<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Schedule]]<br />
|? > ?<br />
|Sent when the user right-clicks an object and selects 'View Schedule' from the resulting menu. The vehicle must have a timetable for this menu item to be displayed.<br />
|-<br />
|<br />
|MeshObject-Click,*<br />
|<br />
|<br />
{{IndexSplit|O}}<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|crossing > crossing<br />
|Train has entered crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|crossing > crossing<br />
|Train has left crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > junction<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|train > junction<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > junction<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trackmark<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trackmark<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trackmark<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trigger<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trigger<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trigger<br />
|Sent when a train stops at a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|OnlineAccess,ReceiveMessage<br />
|? > onlineaccess<br />
|Message awaiting collection<br />
|-<br />
|<br />
|OnlineAccess,StatusChange<br />
|? > onlineaccess<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,StatusChange<br />
|? > onlinegroup<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,UsersChange<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserRemoved,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserAdded,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserStatus,*<br />
|? > onlinegroup<br />
|Network users change<br />
{{IndexSplit|P}}<br />
|-<br />
|<br />
|Permit,Granted<br />
|? > objectrequesting<br />
|Sent when a track or junction permit is granted<br />
|-<br />
|<br />
|PortalTunnel,EmitTrain<br />
|portal > portal<br />
|Sent when a portal produces a train<br />
|-<br />
|<br />
|[[pfx Message|pfx,''particledata'']]<br />
|script > object<br />
|Sent by script to control particle effects<br />
|-<br />
|<br />
|Process-Start,''processname''<br />
|industry > industry<br />
|Sent when an industry process has started<br />
|-<br />
|<br />
|Process-Stop,''processname''<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|S}}<br />
|-<br />
|<br />
|Scenario,KillMonitor<br />
|? > ?<br />
|Sent to terminate a scenario thread<br />
|-<br />
|<br />
|Scenario,Quit<br />
|? > ?<br />
|Sent to terminate a scenario<br />
|-<br />
|<br />
|ScenarioBehaviour,Touch<br />
|? > ?<br />
|Called on a parent rule when the child rule completes. May also indicate other state changes.<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Enter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerEnter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerLeave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Leave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Stopped]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|Schedule,Abort<br />
|train > train<br />
|Sent when a command schedule is abandoned<br />
|-<br />
|<br />
|Schedule,Complete<br />
|train > broadcast<br />
|Sent when a command schedule is completed<br />
|-<br />
|<br />
|Schedule,Touch<br />
|train > train<br />
|Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.<br />
|-<br />
|<br />
|[[Signal Messages|Signal,StateChanged]]<br />
|signal > broadcast<br />
|Signal aspect has changed<br />
|-<br />
|<br />
|StationMain.Timer,Tick<br />
|station > station<br />
|Sent by stations to initiate a periodic update<br />
{{IndexSplit|T}}<br />
|-<br />
|<br />
|Timer,Tick<br />
|? > ?<br />
|A common custom message used by various scripts to implement timed polling.<br />
|-<br />
|<br />
|Timetable,<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Enter]]<br />
|trackmark > train<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Leave]]<br />
|trackmark > train<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Stopped]]<br />
|trackmark > train<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal]]<br />
|signal > train<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal notify]]<br />
|train > broadcast<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Passed Signal]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Over speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Cleanup]]<br />
|? > ?<br />
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.<br />
|-<br />
|<br />
|[[Train Messages|Train,Deleted]]<br />
|train > ?<br />
|Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.<br />
|-<br />
|<br />
|Train,ThreadAITrainStoppedMovingFailed<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to enter the expected junction.<br />
|-<br />
|<br />
|Train,CommandCoupleVehicleTimer<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.<br />
|-<br />
|<br />
|Train,CommandReverseTrain.Pulse<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.<br />
|-<br />
|<br />
|[[Train Messages|Train,DriverBoarded]]<br />
|train > driver<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|Train,NotifyBell<br />
|train > train<br />
|Sent when the interface bell button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHeadlights<br />
|train > train<br />
|Sent when the interface headlight button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHorn<br />
|train > train<br />
|Sent when the interface horn button is clicked<br />
|-<br />
|<br />
|Train,NotifyPantographs<br />
|train > train<br />
|Sent when the interface pantograph button is clicked.<br />
|-<br />
|<br />
|Train,NotifySanding<br />
|<br />
|<br />
|-<br />
|<br />
|Train,TurnAround<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,ReachedTarget]]<br />
|? > ?<br />
|Sent by Trainz when a train reaches the specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,SlowingForTarget]]<br />
|train > train<br />
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Apply]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Release]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,StartedMoving]]<br />
|train > train<br />
|Sent when a train starts to move<br />
|-<br />
|<br />
|[[Train Messages|Train,StoppedMoving]]<br />
|train > train<br />
|Sent when a train stops<br />
|-<br />
|<br />
|[[Train Messages|Train,ThrottleChanged]]<br />
|<br />
|<br />
|-<br />
|<br />
|Train,Tick<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,EnterTrack]]<br />
|track > train<br />
|Sent when a train enters a track section<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerEnterTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerLeaveTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,LeaveTrack]]<br />
|track > train<br />
|Sent when a train leaves a track section<br />
|-<br />
|<br />
|Train.ThreadAITrainStuck,Touch<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|TrainTimetable,Touch<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Enter]]<br />
|trigger > train<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Leave]]<br />
|trigger > train<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Stopped]]<br />
|trigger > train<br />
|Sent when a train stops at a trigger<br />
{{IndexSplit|V}}<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,BadCouple]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples at excessive speed<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Collided]]<br />
|vehicle > broadcast<br />
|Sent on a collision between vehicles<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Coupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples to another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Decoupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle uncouples from another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Derailed]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle is derailed<br />
|-<br />
|<br />
|Vehicle,LoadComplete<br />
|industry > vehicle<br />
|Sent when loading of a vehicle from an industry is complete<br />
|-<br />
|<br />
|Vehicle,Coupler breakage<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler breakage notify<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler Repaired<br />
|<br />
|<br />
{{IndexSplit|W}}<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[ModuleInit Message|World,ModuleInit]]<br />
|? > broadcast<br />
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes<br />
|-<br />
|<br />
|World,Paused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Unpaused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Day<br />
|? > broadcast<br />
|Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver<br />
|-<br />
|<br />
|World,Night<br />
|? > broadcast<br />
|Sent 1.) at ca. 18:15 ~ 0.260611 GameTime 2.) whenever TS starts Driver or Surveyor and Playtime is beween 18:15 and 05:45 3.) sometimes when TS switched to Driver or Surveyor<br />
|}</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=List_of_Standard_Messages&diff=21336List of Standard Messages2019-09-14T11:20:45Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
<br />
*This list is a first step towards documenting Trainz use of messages. It has been generated by scanning one or two copies of jetlog.txt from TC, together with the TC scripts folder and the TRS2006 copy of index.chm. There are probably many standard messages missing and there are some obscure ones listed. Please add anything that is missing. I will progressively link and document the list. <br />
__NOTOC__ __NOEDITSECTION__<br />
<br><br />
<br />
{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"<br />
|-<br />
|width="15"|<br />
|width="250"|Message<br />
|width="165"|Source & Destination<br />
|Purpose<br />
|<br />
{{IndexSplit|A}}<br />
|-<br />
|<br />
|[[Animation-Event Message|Animation-Event,''eventname'']]<br />
|meshobject > meshobject<br />
|Sent when an animation triggers an event. These events are included in *.kin files generated by Max when the 'Query for Event' box is checked during animation export. They are used to enable code to be executed in sync with animations.<br />
{{IndexSplit|B}}<br />
|-<br />
|<br />
|BaseIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|[[Browser Messages|Browser-Closed,''null'']]<br />
|browser > broadcast<br />
|Sent when any in game browser is closed.<br />
|-<br />
|<br />
|Browser-Key,ScriptObjectives<br />
|? > ?<br />
|Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?<br />
|-<br />
|<br />
|[[Browser Messages|Browser-URL,''live://linkname'']]<br />
|browser > broadcast<br />
|Sent when the user clicks in a link in a custom browser<br />
|-<br />
|<br />
|Build,Cancelled<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Completed<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Started<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
{{IndexSplit|C}}<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Interior-Changed]]<br />
|new train? > broadcast<br />
|Sent when a different train is selected.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Target-Changed]]<br />
|new target? > broadcast<br />
|Sent when the camera selects a different target, may not be a train.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,External-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Internal-View]]<br />
|? > Broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Roaming-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Tracking-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|Check,Speed<br />
|vehicle > vehicle<br />
|Sent continuously to ensure that jetlog isn't allowed to remain legible :-)<br />
{{IndexSplit|D}}<br />
|-<br />
|<br />
|DriverCharacter,BoardedTrain<br />
|driver > broadcast<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|DriverCharacter,Created<br />
|driver > broadcast<br />
|Sent when a driver character is initialised<br />
|-<br />
|<br />
|DriverCharacter,LeftTrain<br />
|driver > broadcast<br />
|Sent when a driver leaves a train<br />
|-<br />
|<br />
|DriverDisplay,ResetTripMeter<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|DriverModule,DCC-Panel-Created]]<br />
|? > broadcast<br />
|Sent when driver selection widget has been created<br />
|-<br />
|<br />
|DriverSetup,CharactersDone<br />
|? > broadcast<br />
|Sent when driver characters have been initialised<br />
{{IndexSplit|G}}<br />
|-<br />
|<br />
|GenericIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|GenericIndustry,ProcessComplete<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|H}}<br />
|-<br />
|<br />
|HandleTrain,Release<br />
|industry > train<br />
|Sent when an industry loading operation has completed<br />
{{IndexSplit|I}}<br />
|-<br />
|<br />
|[[Interface Messages|Interface,ClickSystemButton]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOff]]<br />
|? > broadcast<br />
|Sent when the minimap is opened<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOn]]<br />
|? > broadcast<br />
|Sent when the minimap is closed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,New-Driver-Message]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Enter]]<br />
|object > broadcast<br />
|Sent on mouseover an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Leave]]<br />
|? > broadcast<br />
|Sent on mouseout of an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]<br />
|? > broadcast<br />
|Sent when the interface units are changed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-Interface]]<br />
|? > broadcast<br />
|Sent when the main HUD is turned on or off<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Left-Click]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]<br />
|<br />
|<br />
{{IndexSplit|J}}<br />
|-<br />
|<br />
|[[Object Messages|Junction,Enter]]<br />
|junction > train<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerEnter]]<br />
|junction > train<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerLeave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Leave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Stopped]]<br />
|junction > train<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|Junction,Toggled<br />
|junction > broadcast<br />
|Sent when a junctionbase object is toggled<br />
{{IndexSplit|M}}<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Details]]<br />
|? > object<br />
|Sent when the user right-clicks an object and selects 'View Details' from the resulting menu, some assets provide a built-in browser in response to this message.<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Schedule]]<br />
|? > ?<br />
|Sent when the user right-clicks an object and selects 'View Schedule' from the resulting menu. The vehicle must have a timetable for this menu item to be displayed.<br />
|-<br />
|<br />
|MeshObject-Click,*<br />
|<br />
|<br />
{{IndexSplit|O}}<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|crossing > crossing<br />
|Train has entered crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|crossing > crossing<br />
|Train has left crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > junction<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|train > junction<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > junction<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trackmark<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trackmark<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trackmark<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trigger<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trigger<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trigger<br />
|Sent when a train stops at a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|OnlineAccess,ReceiveMessage<br />
|? > onlineaccess<br />
|Message awaiting collection<br />
|-<br />
|<br />
|OnlineAccess,StatusChange<br />
|? > onlineaccess<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,StatusChange<br />
|? > onlinegroup<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,UsersChange<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserRemoved,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserAdded,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserStatus,*<br />
|? > onlinegroup<br />
|Network users change<br />
{{IndexSplit|P}}<br />
|-<br />
|<br />
|Permit,Granted<br />
|? > objectrequesting<br />
|Sent when a track or junction permit is granted<br />
|-<br />
|<br />
|PortalTunnel,EmitTrain<br />
|portal > portal<br />
|Sent when a portal produces a train<br />
|-<br />
|<br />
|[[pfx Message|pfx,''particledata'']]<br />
|script > object<br />
|Sent by script to control particle effects<br />
|-<br />
|<br />
|Process-Start,''processname''<br />
|industry > industry<br />
|Sent when an industry process has started<br />
|-<br />
|<br />
|Process-Stop,''processname''<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|S}}<br />
|-<br />
|<br />
|Scenario,KillMonitor<br />
|? > ?<br />
|Sent to terminate a scenario thread<br />
|-<br />
|<br />
|Scenario,Quit<br />
|? > ?<br />
|Sent to terminate a scenario<br />
|-<br />
|<br />
|ScenarioBehaviour,Touch<br />
|? > ?<br />
|Called on a parent rule when the child rule completes. May also indicate other state changes.<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Enter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerEnter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerLeave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Leave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Stopped]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|Schedule,Abort<br />
|train > train<br />
|Sent when a command schedule is abandoned<br />
|-<br />
|<br />
|Schedule,Complete<br />
|train > broadcast<br />
|Sent when a command schedule is completed<br />
|-<br />
|<br />
|Schedule,Touch<br />
|train > train<br />
|Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.<br />
|-<br />
|<br />
|[[Signal Messages|Signal,StateChanged]]<br />
|signal > broadcast<br />
|Signal aspect has changed<br />
|-<br />
|<br />
|StationMain.Timer,Tick<br />
|station > station<br />
|Sent by stations to initiate a periodic update<br />
{{IndexSplit|T}}<br />
|-<br />
|<br />
|Timer,Tick<br />
|? > ?<br />
|A common custom message used by various scripts to implement timed polling.<br />
|-<br />
|<br />
|Timetable,<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Enter]]<br />
|trackmark > train<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Leave]]<br />
|trackmark > train<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Stopped]]<br />
|trackmark > train<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal]]<br />
|signal > train<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal notify]]<br />
|train > broadcast<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Passed Signal]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Over speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Cleanup]]<br />
|? > ?<br />
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.<br />
|-<br />
|<br />
|[[Train Messages|Train,Deleted]]<br />
|train > ?<br />
|Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.<br />
|-<br />
|<br />
|Train,ThreadAITrainStoppedMovingFailed<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to enter the expected junction.<br />
|-<br />
|<br />
|Train,CommandCoupleVehicleTimer<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.<br />
|-<br />
|<br />
|Train,CommandReverseTrain.Pulse<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.<br />
|-<br />
|<br />
|[[Train Messages|Train,DriverBoarded]]<br />
|train > driver<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|Train,NotifyBell<br />
|train > train<br />
|Sent when the interface bell button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHeadlights<br />
|train > train<br />
|Sent when the interface headlight button is clicked.<br />
|-<br />
|<br />
|Train,NotifyHorn<br />
|train > train<br />
|Sent when the interface horn button is clicked<br />
|-<br />
|<br />
|Train,NotifyPantographs<br />
|train > train<br />
|Sent when the interface pantograph button is clicked.<br />
|-<br />
|<br />
|Train,NotifySanding<br />
|<br />
|<br />
|-<br />
|<br />
|Train,TurnAround<br />
|<br />
|Does not work since build 4.3<br />
|-<br />
|<br />
|[[Train Messages|Train,ReachedTarget]]<br />
|? > ?<br />
|Sent by Trainz when a train reaches the specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,SlowingForTarget]]<br />
|train > train<br />
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Apply]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Release]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,StartedMoving]]<br />
|train > train<br />
|Sent when a train starts to move<br />
|-<br />
|<br />
|[[Train Messages|Train,StoppedMoving]]<br />
|train > train<br />
|Sent when a train stops<br />
|-<br />
|<br />
|[[Train Messages|Train,ThrottleChanged]]<br />
|<br />
|<br />
|-<br />
|<br />
|Train,Tick<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,EnterTrack]]<br />
|track > train<br />
|Sent when a train enters a track section<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerEnterTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerLeaveTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,LeaveTrack]]<br />
|track > train<br />
|Sent when a train leaves a track section<br />
|-<br />
|<br />
|Train.ThreadAITrainStuck,Touch<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|TrainTimetable,Touch<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Enter]]<br />
|trigger > train<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Leave]]<br />
|trigger > train<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Stopped]]<br />
|trigger > train<br />
|Sent when a train stops at a trigger<br />
{{IndexSplit|V}}<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,BadCouple]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples at excessive speed<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Collided]]<br />
|vehicle > broadcast<br />
|Sent on a collision between vehicles<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Coupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples to another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Decoupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle uncouples from another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Derailed]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle is derailed<br />
|-<br />
|<br />
|Vehicle,LoadComplete<br />
|industry > vehicle<br />
|Sent when loading of a vehicle from an industry is complete<br />
|-<br />
|<br />
|Vehicle,Coupler breakage<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler breakage notify<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler Repaired<br />
|<br />
|<br />
{{IndexSplit|W}}<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[ModuleInit Message|World,ModuleInit]]<br />
|? > broadcast<br />
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes<br />
|-<br />
|<br />
|World,Paused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Unpaused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Day<br />
|? > broadcast<br />
|Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver<br />
|-<br />
|<br />
|World,Night<br />
|? > broadcast<br />
|Sent 1.) at ca. 18:15 ~ 0.260611 GameTime 2.) whenever TS starts Driver or Surveyor and Playtime is beween 18:15 and 05:45 3.) sometimes when TS switched to Driver or Surveyor<br />
|}</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21280Class Locomotive2019-09-11T18:56:51Z<p>Ciceronmt: /* SetCompressorEfficiency */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
*From personal experience: for a slow increase in pressure of the main reservoir, the optimal value is 0.01-0.1<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Locomotive&diff=21279Class Locomotive2019-09-11T18:45:21Z<p>Ciceronmt: /* SetEngineSetting */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********[[Class Vehicle|Vehicle]]<br />
*********Locomotive<br />
<br><br />
<br />
*A Locomotive is a specialised instance of a vehicle.<br />
*In practice many of the methods in [[Class Vehicle]] apply to powered vehicles.<br />
*A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.<br />
<br><br />
<br />
==Methods==<br />
<br><br />
===GetCabinData===<br />
{{MethodHeader|public CabinData GetCabinData(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to a data object which stores the state of the locomotive's cabin.<br />
;Syntax<br />
MyCabinData = loco.GetCabinData();<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===GetEngineSetting===<br />
{{MethodHeader|public native float GetEngineSetting(string setting)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to retrieve.<br />
;Returned Value<br />
*The value of the named setting.<br />
;Syntax<br />
float throttle = GetEngineSetting("throttle");<br />
;Notes<br />
*See [[#SetEngineSetting|SetEngineSetting()]] for details of the values which can be used for the ''setting'' parameter.<br />
<br><br />
<br />
===SetBrokenReverser===<br />
{{MethodHeader|public native void SetBrokenReverser(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the reverser will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenReverser(true); <br />
;Notes<br />
*When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetBrokenThrottle===<br />
{{MethodHeader|public native void SetBrokenThrottle(bool broken)}}<br />
;Parameters<br />
*'''broken''' = If true the throttle will not function, a value of false will reactivate it.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenThrottle(true);<br />
;Notes<br />
*When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.<br />
<br><br />
<br />
===SetCabinData===<br />
{{MethodHeader|public void SetCabinData(CabinData data)}}<br />
;Parameters<br />
*'''data''' = A reference to the data object used to store details of the locomotive's cabin controls.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinData(MyCabinData);<br />
;Notes<br />
*See [[Class CabinData]]<br />
*The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.<br />
*This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.<br />
<br><br />
<br />
===SetCompressorEfficiency===<br />
{{MethodHeader|public native void SetCompressorEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = Efficiency of the compressor in the range 0.0 .. 1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCompressorEfficiency(0.5);<br />
;Notes<br />
<br><br />
<br />
===SetEngineSetting===<br />
{{MethodHeader|public native void SetEngineSetting(string setting, float value)}}<br />
;Parameters<br />
*'''setting''' = The name of the setting to save.<br />
*'''value''' = The value of the named setting.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetEngineSetting("regulator",0.5);<br />
;Notes<br />
*Settings you can write to with this method are:<br />
**"dynamic-brake"<br />
**"headlight"<br />
**"injector"<br />
**"loco-auto-brake" (i.e independantbrake_lever)<br />
**"pantograph"<br />
**"regulator"<br />
**"reverser"<br />
**"steam-blower"<br />
**"throttle"<br />
**"train-auto-brake" (i.e. trainbrake_lever')<br />
**"train-lap-brake"<br />
**"script-brake-pressure" - A script-only brake pressure which does not correspond to any real brake device, specified in kPa. This may be used by interior scripts for implementing custom cab-mode braking behaviour, and is intended to be directly mapped from the cab controls rather than updated on a regular frame-by-frame basis from script. Native brake controls should be used where possible to avoid significant performance problems.<br />
*Some apply to steam locomotives only.<br />
*From personal experience: the settings for the electric locomotive are set in whole numbers ("dynamic-brake" 0-1-2; "reverser" 0-1-2 and so on).<br />
<br><br />
<br />
===SetHasDriver===<br />
{{MethodHeader|public native void SetHasDriver(bool hasDriver)}}<br />
;Parameters<br />
*'''hasDriver''' = If true the locomotive has an assigned driver, if false it does not.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHasDriver(true);<br />
;Notes<br />
*Only one locomotive in a train may have a driver. <br />
*If you attempt to place a driver in this loco, any other driver on the train will be removed. <br />
*The consist name and id will always stay with the driver.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetFrontmostLocomotive|Train.GetFrontmostLocomotive()]]<br><br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Vehicle&diff=21278Class Vehicle2019-09-10T15:23:38Z<p>Ciceronmt: /* GetEngineParam */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******[[Class MapObject|MapObject]]<br />
*******[[Class Trackside|Trackside]]<br />
********Vehicle<br />
<br><br />
<br />
*A vehicle is a single piece of rolling stock including locomotives and tenders.<br />
*A vehicle is always part of a train, if a vehicle is decoupled and left alone Trainz will create a new consist to include it.<br />
<br><br />
<br />
==Related Messages==<br />
*Messages sent to and from Vehicle objects are listed below:<br />
<br><br />
{{TableHeader|width=75%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''||bgcolor="#EEEEEE" |<br />
|-<br />
|[[Vehicle Messages|Vehicle]]||Derailed||Vehicle||Broadcast||Vehicle has derailed and can no longer be used. <br />
|-<br />
|[[Vehicle Messages|Vehicle]]||Coupled||Vehicle||Broadcast||Vehicle has coupled up with another vehicle. <br />
|-<br />
|[[Vehicle Messages|Vehicle]]||Decoupled||Vehicle||Broadcast||Vehicle has decoupled from another vehicle. <br />
|-<br />
|[[Vehicle Messages|Vehicle]]||Bad Couple||Vehicle||Broadcast||Vehicle has coupled with another vehicle at too high a velocity. <br />
|-<br />
|[[Vehicle Messages|Vehicle]]||Collided||Vehicle||Broadcast||Vehicle has collided with another vehicle.<br />
|}<br />
<br><br />
<br />
==Constants==<br />
<br><br />
===Coupler Flags===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=425|public define int COUPLE_NONE = 0||Neither coupler.<br />
|-<br />
|public define int COUPLE_FRONT = 1||Front coupler.<br />
|-<br />
|public define int COUPLE_BACK = 2||Back coupler.<br />
|-<br />
|public define int COUPLE_BOTH = COUPLE_FRONT &#166; COUPLE_BACK||Both couplers.<br />
|}<br />
<br><br />
<br />
===Direction Relationships===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=425|public define int DIRECTION_NONE = 0||No known relationship.<br />
|-<br />
|public define int DIRECTION_FORWARD = 1||Forward, facing in the same direction.<br />
|-<br />
|public define int DIRECTION_BACKWARD = -1||Backward, facing in opposite directions.<br />
|}<br />
<br><br />
<br />
===Engine Types===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=425|public define int ENGINE_NONE = 0||Not a powered vehicle.<br />
|-<br />
|public define int ENGINE_STANDARD = 1||Diesel, Diesel-Electric, Electric.<br />
|-<br />
|public define int ENGINE_STEAM = 2||Steam powered.<br />
|}<br />
<br><br />
<br />
===Vehicle Type Flags===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=425|public define int TYPE_LOCOMOTIVE = 1||Vehicle is a powered locomotive.<br />
|-<br />
|public define int TYPE_TENDER = 2||Vehicle carries fuel for a locomotive.<br />
|-<br />
|public define int TYPE_HAS_INTERIOR = 4||Vehicle has an interior. This does not necessarily mean that it is a lcomotive.<br />
|}<br />
<br><pre style="color: red"><br />
Having tested these values with the associated function 'GetVehicleTypeFlags', it seems that the 'Vehicle Type Flag' for a loco is '5' and not '1'<br />
vincentrh<br />
<br />
Perhaps they are bit flags? Therefore a value of 1 (loco) and 4 (has interior) would result in 5 being returned for a loco with an interior. i.e. 1 and 4 "OR"ed together.<br />
PCAS1986<br />
</pre>''<br />
<br />
==Members==<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=425|<b>public IndustryProductInfoCollection vehicleProductInfoCollection</b>||A data object that allows tracking of products and associated assets & queues.<br />
|}<br />
<br><br />
<br />
==Methods==<br />
<br><br />
<br />
===BeginLoad===<br />
{{MethodHeader|float BeginLoad(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*The time required, in seconds, for the activity to complete.<br />
;Syntax<br />
float BeginLoad(LoadingReport report) {<br />
DoStuff(report);<br />
return 10.0;<br />
}<br />
;Notes<br />
*This is a callback method which should be overridden by the script writer to perform customised activities before loading at an industry.<br />
*These include such operations as particle effects and animations.<br />
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship. <br />
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.<br />
<br><br />
<br />
===BeginUnload===<br />
{{MethodHeader|float BeginUnload(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*The time required, in seconds, for the activity to complete.<br />
;Syntax<br />
float BeginLoad(LoadingReport report) {<br />
DoStuff(report);<br />
return 10.0;<br />
}<br />
;Notes<br />
*This is a callback method which should be overridden by the script writer to perform customised activities before loading at an industry.<br />
*These include such operations as particle effects and animations.<br />
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship. <br />
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.<br />
<br><br />
<br />
===CanLoadProductFromQueue===<br />
{{MethodHeader|public bool CanLoadProductFromQueue(ProductQueue queue)}}<br />
;Parameters<br />
*'''queue''' = The queue to be queried.<br />
;Returned Value<br />
*True if the vehicle and queue are compatible and the queue can be used to load the vehicle, false otherwise.<br />
*None<br />
;Syntax<br />
if (CanLoadProductFromQueue(industryOutQueue)) {<br />
DoTheProcess();<br />
}<br />
;Notes<br />
<br><br />
<br />
===CanUnloadProductToQueue===<br />
{{MethodHeader|public bool CanUnloadProductToQueue(ProductQueue queue)}}<br />
;Parameters<br />
*'''queue''' = The queue to be queried.<br />
;Returned Value<br />
*True if the vehicle and queue are compatible and the queue can be used to unload the vehicle, false otherwise.<br />
;Syntax<br />
if (CanUnloadProductToQueue(industryOutQueue)) {<br />
DoTheProcess();<br />
}<br />
;Notes<br />
<br><br />
<br />
===Couple===<br />
{{MethodHeader|public native bool Couple(Vehicle other)}}<br />
;Parameters<br />
*''other''' = Adjacent vehicle to couple to.<br />
;Returned Value<br />
*True if the operation was successfully completed, fale otherwise.<br />
;Syntax<br />
if (Couple(vehicle2)) Interface.Print("Success!");<br />
;Notes<br />
*Couples this vehicle to the given vehicle which must already be adjacent. <br />
*When a vehicle is decoupled from another, the couplers are left in an unlocked state, even though the vehicles are flush against each other.<br />
*This state will remain until the vehicles move a small distance apart. <br />
*Sometimes you may wish to cause them to couple again and that is the intended use of this method. <br />
*If the two vehicles involved are not adjacent then this method will have no effect.<br />
<br><br />
<br />
===EndLoad===<br />
{{MethodHeader|float EndLoad(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*The time required, in seconds, for the activity to complete.<br />
;Syntax<br />
float EndLoad(LoadingReport report) {<br />
DoStuff(report);<br />
return 10.0;<br />
}<br />
;Notes<br />
*This is a callback method which should be overridden by the script writer to perform customised activities after loading at an industry.<br />
*These include such operations as particle effects and animations.<br />
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship. <br />
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.<br />
<br><br />
<br />
===EndUnload===<br />
{{MethodHeader|float EndUnload(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*The time required, in seconds, for the activity to complete.<br />
;Syntax<br />
float EndUnload(LoadingReport report) {<br />
DoStuff(report);<br />
return 10.0;<br />
}<br />
;Notes<br />
*This is a callback method which should be overridden by the script writer to perform customised activities after unloading at an industry.<br />
*These include such operations as particle effects and animations.<br />
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship. <br />
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.<br />
<br><br />
<br />
===GetAuxReservoirPressure===<br />
{{MethodHeader|public native float GetAuxReservoirPressure(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current auxiliary reservoir pressure of this vehicle.<br />
;Syntax<br />
float ARP = GetAuxReservoirPressure();<br />
;Notes<br />
<br><br />
<br />
===GetBogeyList===<br />
{{MethodHeader|public native Bogey[ ] GetBogeyList(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array containing references to all the Bogey objects attached to this vehicle.<br />
;Syntax<br />
Bogey[] bogies = GetBogeyList();<br />
;Notes<br />
*Bogies are indexed in the same numerical order as they are listed in ''config.txt''.<br />
*Invisible bogies etc. are included.<br />
<br><br />
<br />
===GetBrakeCylinderPressure===<br />
{{MethodHeader|public native float GetBrakeCylinderPressure(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current brake cylinder pressure of this vehicle. <br />
;Syntax<br />
float BCP = GetBrakeCylinderPressure();<br />
;Notes<br />
<br><br />
<br />
===GetBrakePipePressure===<br />
{{MethodHeader|public native float GetBrakePipePressure(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current brake pipe pressure of this vehicle.<br />
;Syntax<br />
float BPP = GetBrakePipePressure();<br />
;Notes<br />
<br><br />
<br />
===GetCabinSwayAmount===<br />
{{MethodHeader|public native float GetCabinSwayAmount(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The cabin sway amount for this vehicle.<br />
;Syntax<br />
float CSA = GetCabinSwayAmount();<br />
;Notes<br />
*Higher positive values indicate higher levels of cabin sway while a 0.0 indicates no cabin sway.<br />
*See also [[#SetCabinSwayAmount|SetCabinSwayAmount()]].<br />
<br><br />
<br />
===GetCouplerBreakageEnabled===<br />
{{MethodHeader|public native bool GetCouplerBreakageEnabled(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if coupler breakages are enabled on this vehicle, false otherwise.<br />
;Syntax<br />
if (GetCouplerBreakageEnabled()) Interface.Print("Drive carefully to avoid breaking the couplers");<br />
;Notes<br />
<br><br />
<br />
===GetCouplingDirection===<br />
{{MethodHeader|public native int GetCouplingDirection(Vehicle other)}}<br />
;Parameters<br />
*''other''' = Adjacent vehicle to couple to.<br />
;Returned Value<br />
*One of the [[#Direction Relationships|Direction Relationship]] constants indicating the direction of a neighbouring vehicle, relative to the direction of the caller.<br />
;Syntax<br />
bool direction = GetCouplingDirection(vehicle2);<br />
;Notes<br />
*If the result is DIRECTION_FORWARD then both vehicles have the same orientation.<br />
*If the result is DIRECTION_BACKWARD then the two vehicles face in opposite directions.<br />
*The fact that this method returns a value does not mean that it is possible for the two vehicles to couple.<br />
<br><br />
<br />
===GetCouplingStress===<br />
{{MethodHeader|public native float GetCouplingStress(Vehicle other)}}<br />
;Parameters<br />
*''other''' = Other vehicle in the same consist to query.<br />
;Returned Value<br />
*The calculated coupling stress between the two vehicles in newtons (N);<br />
;Syntax<br />
float kn = GetCouplingStress(vehicle2);<br />
;Notes<br />
*<float color=red>Must the two vehicles be adjacent?</font><br />
<br><br />
<br />
===GetDefaultCabinSwayAmount===<br />
{{MethodHeader|public native float GetDefaultCabinSwayAmount(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The default cabin sway amount for this vehicle as defined in ''config.txt''.<br />
;Syntax<br />
float CSA = GetCabinSwayAmount();<br />
;Notes<br />
*Higher positive values indicate higher levels of cabin sway while a 0.0 indicates no cabin sway.<br />
*See also [[#SetCabinSwayAmount|SetCabinSwayAmount()]].<br />
<br><br />
<br />
===GetDefaultMaximumCouplerCompressionStress===<br />
{{MethodHeader|publc native float GetDefaultMaximumCouplerCompressionStress(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The default maximum coupler compression stress value for this vehicle in newtons (N), as defined in ''config.txt''. <br />
;Syntax<br />
float DMCS = GetDefaultMaximumCouplerCompressionStress();<br />
;Notes<br />
*See [[#SetMaximumCouplerCompressionStress|SetMaximumCouplerCompressionStress()]].<br />
<br><br />
<br />
===GetDefaultMaximumCouplerExpansionStress===<br />
{{MethodHeader|public native float GetDefaultMaximumCouplerExpansionStress(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The default maximum coupler expansion stress value for this vehicle in newtons (N), as defined in ''config.txt''. <br />
;Syntax<br />
float DMCE = GetDefaultMaximumCouplerExpansionStress();<br />
;Notes<br />
*See [[#SetMaximumCouplerExpansionStress|SetMaximumCouplerExpansionStress()]].<br />
<br><br />
<br />
===GetDefaultMaximumCoupleVelocity===<br />
{{MethodHeader|public native float GetDefaultMaximumCoupleVelocity(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The default maximum speed at which this vehicle can be coupled to without breaking the coupler, as defined in ''config.txt''.<br />
;Syntax<br />
float DMCV = GetDefaultMaximumCoupleVelocity();<br />
;Notes<br />
*See [[#SetMaximumCoupleVelocity|SetMaximumCoupleVelocity()]].<br />
<br><br />
<br />
===GetDefaultMaximumTractiveEffort===<br />
{{MethodHeader|GetDefaultMaximumTractiveEffort()}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The default maximum tractive effort of this vehicle from its configuration in newtons (N), as defined in ''config.txt''. <br />
;Syntax<br />
float DMTE = GetDefaultMaximumTractiveEffort();<br />
;Notes<br />
*See [[#SetMaximumTractiveEffort|SetMaximumTractiveEffort()]].<br />
<br><br />
<br />
===GetDirectionRelativeToTrain===<br />
{{MethodHeader|public native bool GetDirectionRelativeToTrain(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if this vehicle faces in the same direction as the train's current heading, false otherwise.<br />
;Syntax<br />
bool vehicleToTrain = GetDirectionRelativeToTrain();<br />
;Notes<br />
<br><br />
<br />
===GetEngineParam===<br />
{{MethodHeader|public native float GetEngineParam(string param)}}<br />
;Parameters<br />
*'''param''' = One of the engine parameter strings listed below.<br />
;Returned Value<br />
*The current value of the given engine parameter.<br />
;Syntax<br />
float pressure = GetEngineParam("steam-boiler-pressure");<br />
;Notes<br />
*Engine parameter strings you can use with this method are:<br />
**"applied-force"<br />
**"brake-cylinder-pressure"<br />
**"brake-pipe-pressure"<br />
**"current-drawn"<br />
**"equaliser-pressure"<br />
**"flow"<br />
**"horn"<br />
**"main-reservoir-pressure"<br />
**"max-te"<br />
**"no3-pipe-pressure"<br />
**"wheelslip"<br />
*values refer only to steam engines:<br />
**"coal-mass"<br />
**"engine-force"<br />
**"fire-temperature"<br />
**"max-coal-mass"<br />
**"max-fire-temperature"<br />
**"steam-boiler-liquid-percent"<br />
**"steam-boiler-pressure"<br />
**"steam-piston-cycle"<br />
<br><br />
<br />
===GetEngineType===<br />
{{MethodHeader|public native int GetEngineType(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*One of the [[#Engine Types|Engine Type]] constants describing the engine type of this vehicle.<br />
;Syntax<br />
int eType = GetEngineType();<br />
;Notes<br />
<br><br />
<br />
===GetLength===<br />
{{MethodHeader|public native float GetLength(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The length of this vehicle in metres.<br />
;Syntax<br />
float length = GetLength();<br />
;Notes<br />
<br><br />
<br />
===GetLoadTime===<br />
{{MethodHeader|float GetLoadTime(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*The time required, in seconds, for the activity to complete.<br />
;Syntax<br />
float GetLoadTime(LoadingReport report) {<br />
DoStuff(report);<br />
return 10.0;<br />
}<br />
;Notes<br />
*This is a callback method which informs the game engine of the time needed to load this vehicle.<br />
*The method may be use to perform customised activities during the loading operation.<br />
*These include such operations as particle effects and animations.<br />
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship. <br />
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.<br />
<br><br />
<br />
===GetMass===<br />
{{MethodHeader|public native float GetMass(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The mass of the vehicle in kilograms.<br />
;Syntax<br />
float mass = GetMass();<br />
;Notes<br />
<br><br />
<br />
===GetMaximumCouplerCompressionStress===<br />
{{MethodHeader|publc native float GetMaximumCouplerCompressionStress(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The maximum coupler compression stress value for this vehicle in newtons (N).<br />
;Syntax<br />
float MCS = GetMaximumCouplerCompressionStress();<br />
;Notes<br />
*See [[#SetMaximumCouplerCompressionStress|SetMaximumCouplerCompressionStress()]].<br />
<br><br />
<br />
===GetMaximumCouplerExpansionStress===<br />
{{MethodHeader|public native float GetMaximumCouplerExpansionStress(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The maximum coupler expansion stress value for this vehicle in newtons (N).<br />
;Syntax<br />
float DMCE = GetMaximumCouplerExpansionStress();<br />
;Notes<br />
*See [[#SetMaximumCouplerExpansionStress|SetMaximumCouplerExpansionStress()]].<br />
<br><br />
<br />
===GetMaximumCoupleVelocity===<br />
{{MethodHeader|public native float GetMaximumCoupleVelocity(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The maximum speed at which this vehicle can be coupled to without breaking the coupler.<br />
;Syntax<br />
float MCV = GetMaximumCoupleVelocity();<br />
;Notes<br />
*See [[#SetMaximumCoupleVelocity|SetMaximumCoupleVelocity()]].<br />
<br><br />
<br />
===GetMaximumTractiveEffort===<br />
{{MethodHeader|GetMaximumTractiveEffort()}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The maximum tractive effort of this vehicle from its configuration in newtons (N). <br />
;Syntax<br />
float MTE = GetMaximumTractiveEffort();<br />
;Notes<br />
*See [[#SetMaximumTractiveEffort|SetMaximumTractiveEffort()]].<br />
<br><br />
<br />
===GetMyTrain===<br />
{{MethodHeader|public native Train GetMyTrain(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to the train of which this vehicle is part.<br />
;Syntax<br />
Train train = GetMyTrain();<br />
;Notes<br />
*All vehicles belong to a Train consist, even if a vehicle is not coupled to any other vehicle.<br />
<br><br />
<br />
===GetOdometerDistance===<br />
{{MethodHeader|public native Train GetOdometerDistance(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The number of meters that this Vehicle has moved.<br />
;Syntax<br />
float distance = GetOdometerDistance();<br />
;Notes<br />
*Returns the total distance that this Vehicle has moved. No assumptions should be made regarding the starting value of the odometer as this may change between vehicles, sessions, or Trainz versions. This value is continuous under normal operation, however calls to SetOdometerDistance() may arbitrarily adjust the current value.<br />
<br><br />
<br />
===GetProductRestriction===<br />
{{MethodHeader|public ProductFilter GetProductRestriction(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current product restriction filter if any, null otherwise.<br />
;Syntax<br />
ProductFilter filter = GetProductRestriction();<br />
;Notes<br />
<br><br />
<br />
===GetRelationToTrack===<br />
{{MethodHeader|public native int GetRelationToTrack(Buildable obj, string trackName)}}<br />
;Parameters<br />
*'''obj''' = Reference to a Buildable object.<br />
*'''trackName''' = String representing the name of a track as defined in the Buildable's ''config.txt''.<br />
;Returned Value<br />
*One of the [[#Direction Relationships|Direction Relationship]] constants indicating the direction of the vehicle, relative to the Buildable's attached track.<br />
;Syntax<br />
*This method will return either DIRECTION_FORWARD or DIRECTION_BACKWARD if the vehicle is on the track as specified by the arguments or on a directly neighboring track, otherwise DIRECTION_NONE will be returned.<br />
;Notes<br />
<br><br />
<br />
===GetRunningNumber===<br />
{{MethodHeader|public native string GetRunningNumber(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The running (fleet identification) number of the vehicle.<br />
;Syntax<br />
string fleetId = GetRunningNumber();<br />
;Notes<br />
*This value is set using [[#SetRunningNumber|SetRunningNumber()]] and should be restricted to alphanumeric characters and paces.<br />
<br><br />
<br />
===GetSandingTractionMultiplier===<br />
{{MethodHeader|public native float GetSandingTractionMultiplier(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A wheelslip traction multiplier to apply when sand is in use.<br />
;Syntax<br />
float slipFactor = GetSandingTractionMultiplier();<br />
;Notes<br />
*The returned value will be greater than or equal to 1.0.<br />
*See [[#SetSandingTractionMultiplier|SetSandingTractionMultiplier()]];<br />
<br><br />
<br />
===GetTrackGradient===<br />
{{MethodHeader|public native float GetTrackGradient(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current track gradient as a percentage.<br />
;Syntax<br />
float gradient = GetTrackGradient();<br />
;Notes<br />
*The sign of the gradient is determined by the direction of this vehicle relative to the gradient.<br />
*A negative sign indicates that the vehicle is facing down a gradient while a positive sign indicates the vehicle is facing up a gradient. <br />
*The vehicle's direction may not match that of the train so the value returned here may not be what you expect.<br />
*Use [[#GetDirectionRelativeToTrain|GetDirectionRelativeToTrain()]] to check this.<br />
<br><br />
<br />
===GetUnloadTime===<br />
{{MethodHeader|float GetUnloadTime(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*The time required, in seconds, for the activity to complete.<br />
;Syntax<br />
float GetUnloadTime(LoadingReport report) {<br />
DoStuff(report);<br />
return 10.0;<br />
}<br />
;Notes<br />
*This is a callback method which informs the game engine of the time needed to unload this vehicle.<br />
*The method may be use to perform customised activities during the unloading operation.<br />
*These include such operations as particle effects and animations.<br />
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship. <br />
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.<br />
<br><br />
<br />
===GetVehicleTypeFlags===<br />
{{MethodHeader|public native int GetVehicleTypeFlags(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*One of the [[#Vehicle Type Flags|Vehicle Type Flags]] representing what kind of vehicle the current object is. <br />
;Syntax<br />
int flags = GetVehicleTypeFlags();<br />
;Notes<br />
<br><br />
<br />
===GetVelocity===<br />
{{MethodHeader|public native float GetVelocity(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current instantaneous velocity of the train in metres per second.<br />
;Syntax<br />
float speed = GetVelocity();<br />
;Notes<br />
*Use the [[Class Train#Measurement Conversion Multipliers|Measurement Conversion Multiplier]] constants for conversion to other units.<br />
*For human consumption [[Class Train#GetSmoothedVelocity|Train.GetSmoothedVelocity()]] may be preferable.<br />
<br><br />
<br />
===GetWheelslipTractionMultiplier===<br />
{{MethodHeader|public native float GetWheelslipTractionMultiplier(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*The current wheelslip traction multiplier value.<br />
;Syntax<br />
float slip = GetWheelslipTractionMultiplier();<br />
;Notes<br />
*The returned value will be greater than or equal to 1.0.<br />
*See [[#SetWheelslipTractionMultiplier|SetWheelslipTractionMultiplier()]];<br />
<br><br />
<br />
===IsInTunnel===<br />
{{MethodHeader|public native bool IsInTunnel(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if this vehicle is in a tunnel, false otherwise.<br />
;Syntax<br />
bool underground = IsInTunnel();<br />
;Notes<br />
<br><br />
<br />
===IsOnBridge===<br />
{{MethodHeader|public native void IsOnBridge(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if this vehicle is on a bridge, false otherwise.<br />
;Syntax<br />
bool onBridge = IsOnBridge();<br />
;Notes<br />
<br><br />
<br />
===LoadProduct===<br />
{{MethodHeader|public bool LoadProduct(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*True if the loading operation was successful, false otherwise.<br />
;Syntax<br />
LoadProduct(report);<br />
;Notes<br />
*Loads products into this vehicle as defined by the given report. <br />
*This method works by attempting to transfer products to this vehicle's queues if possible from the industry queue specified in report. <br />
*The sequence of events for a loading operation as performed by this method is:<br />
**Verify that an loading operation is possible with this vehicle by calling [[#CanLoadProductFromQueue|CanLoadProductFromQueue()]].<br />
**[[#BeginLoad|BeginLoad()]] on this vehicle and [[Class Industry#BeginLoad|Industry.BeginLoad()]] on the industry specified in the report are called to perform any pre-loading events like animation or particle effects on the vehicle and industry respectively. <br />
**Both of these methods return the amount of time required for a load operation and the LoadProduct() method sleeps for which ever of these times is the longer.<br />
**The actual product transfer from the industry to the vehicle is performed by calling ProductQueue.TransferProductFrom() on this vehicle's queue(s).<br />
**[[#GetLoadTime|GetLoadTime()]] on this vehicle and [[Class Industry#GetLoadTime|Industry.GetLoadTime()]] are called. Again, LoadProduct() sleeps for which ever is the longer of the times returned.<br />
**[[#EndLoad|EndLoad()]] and [[Class Industry#EndLoad|Industry.EndLoad()]] are called to perform any post-loading events. As before LoadProduct() sleeps for the longer time.<br />
<br><br />
<br />
===Reposition===<br />
{{MethodHeader|public native bool Reposition(Train train, int myCoupleDir, int otherCoupleDir)<br>public native bool Reposition(Vehicle vehicle, int myCoupleDir, int otherCoupleDir)<br>public native bool Reposition(TrackMark mark, bool direction)}}<br />
;Parameters<br />
*'''train''' = Train to attach the vehicle to.<br />
*'''vehicle''' = Vehicle to attach the vehicle to.<br />
*'''myCoupleDir''' = The end of the current vehicle that will be coupled, use either COUPLE_FRONT or COUPLE_BACK.<br />
*'''otherCoupleDir''' = The end of the target vehicle that will be coupled to, use either COUPLE_FRONT or COUPLE_BACK. <br />
*'''mark''' = Trackmark to move this vehicle to.<br />
*'''direction''' = Direction for the vehicle, relative to the TrackMark.<br />
*None<br />
;Returned Value<br />
*True if the operation was successfully completed, false otherwise.<br />
;Syntax<br />
Reposition(Train3,COUPLE_FRONT,COUPLE_BACK);<br />
Reposition(Vehicle5,COUPLE_FRONT,COUPLE_BACK);<br />
Reposition(Mark9,true);<br />
;Notes<br />
*Variant 1 moves the current vehicle and couples it to the specified train using the specified vehicle ends.<br />
*Variant 2 moves the current vehicle and couples it to the specified vehicle using the specified vehicle ends.<br />
*Variant 3 moves the current vehicle from its train to the specified trackmark, normally creating a new consist.<br />
<br><br />
<br />
===Reverse===<br />
{{MethodHeader|public native bool Reverse(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the operation was successfully completed, false otherwise.<br />
;Syntax<br />
if (Reverse()) Interface.Print("Direction of " + GetName() + " reversed");<br />
;Notes<br />
*This method reverses the direction of the current vehicle in relation to its consist. <br />
<br><br />
<br />
===SetBrakePipeEfficiency===<br />
{{MethodHeader|public native void SetBrakePipeEfficiency(float efficiency)}}<br />
;Parameters<br />
*'''efficiency''' = A Normalised value in the range 0.0 .. 1.0 representing the efficiency of the brake pipe.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrakePipeEfficiency(0.5);<br />
;Notes<br />
<br><br />
<br />
===SetBrokenBrakes===<br />
{{MethodHeader|public native void SetBrokenBrakes(bool broken)}}<br />
;Parameters<br />
*'''broken''' = True to render the brakes non operational, false to repair them.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetBrokenBrakes(true);<br />
;Notes<br />
<br><br />
<br />
===SetCabinSwayAmount===<br />
{{MethodHeader|public native void SetCabinSwayAmount(float amount)}}<br />
;Parameters<br />
*'''amount''' = Cabin sway value greater than or equal to zero.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabinSwayAmount(2.5);<br />
;Notes<br />
*A value of zero removes all sway.<br />
*Higher positive values increase the effect.<br />
*The method is only of relevance to vehicles with interior views.<br />
<br><br />
<br />
===SetCouplerBreakageEnabled===<br />
{{MethodHeader|public native void SetCouplerBreakageEnabled(bool enabled)}}<br />
;Parameters<br />
*'''enabled''' = True enables simulation of coupler breakage.<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCouplerBreakageEnabled(true);<br />
;Notes<br />
<br><br />
<br />
===SetCouplingMask===<br />
{{MethodHeader|public native void SetCouplingMask(int mask)}}<br />
;Parameters<br />
*'''mask''' = A mask specifying which of the vehilce's couplers are allowed to couple. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCouplingMask(COUPLE_NONE); // prevents this vehicle from coupling to another in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[#Coupler Flags|Coupler Flag]] constants.<br />
*This method will not prevent vehicles from coupling in Surveyor, but takes effect in Driver mode. <br />
<br><br />
<br />
===SetDecouplingMask===<br />
{{MethodHeader|public native void SetDecouplingMask(int mask)}}<br />
;Parameters<br />
*'''mask''' = A mask specifying which of the vehilce's couplers are allowed to couple. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetDecouplingMask(COUPLE_NONE); // prevents this vehicle from uncoupling in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[#Coupler Flags|Coupler Flag]] constants.<br />
*This method will not prevent vehicles from uncoupling in Surveyor, but takes effect in Driver mode. <br />
<br><br />
<br />
===SetHandbrake===<br />
{{MethodHeader|public native void SetHandBrake(bool applied)}}<br />
;Parameters<br />
*'''applied''' = If true the handbrake is applied, if false the handbrake is released.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHandBrake(true);<br />
;Notes<br />
<br><br />
<br />
===SetHeadlightColor===<br />
{{MethodHeader|SetHeadlightColor(float red, float blue, float green)}}<br />
;Parameters<br />
*'''red, blue, green''' = RGB components of selected colour, expressed as normalised values.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetHeadlightColour(0.5,1.0,0.5); // sets colour to RGB:128,255,128<br />
;Notes<br />
*This method controls the color of the illumination produced by the headlights.<br />
*It does not affect the "diffuse" component of illumination (this component remains white). Works correctly with ground and bump-mapped meshes only.<br />
*It does not affect the color of the headlight coronas.<br />
*This should method not be used to "turn off" the headlights, as even a black light will consume CPU time with lighting calculations.<br />
<br><br />
<br />
===SetMaximumCouplerCompressionStress===<br />
{{MethodHeader|public native void SetMaximumCouplerCompressionStress(float stress)}}<br />
;Parameters<br />
*'''stress''' = Maximum compression stress in newtons (N). Use 0.0 for no breakage.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMaximumCouplerCompressionStress(1500000.0);<br />
;Notes<br />
*Sets the maximum coupler compression stress value for this vehicle. <br />
*This value refers to the maximum compression stress which this vehicle's couplers need to experience before they break.<br />
*This is effectively the stress that a coupler can withstand before it breaks.<br />
*As a point of reference, a typical modern knuckle-type coupler can handle approximately 2500 kN of force before breaking.<br />
*This is roughly equivalent to the weight of 2.5 million apples.<br />
<br><br />
<br />
===SetMaximumCouplerExpansionStress===<br />
{{MethodHeader|public native void SetMaximumCouplerExpansionStress(float stress)}}<br />
;Parameters<br />
*'''stress''' = Maximum expansion stress in newtons (N), Use 0.0 for no breakage.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMaximumCouplerExpansionStress(1000000.0);<br />
;Notes<br />
*Sets the maximum coupler expansion stress value for this vehicle. <br />
*This value refers to the maximum expansion stress which this vehicle's couplers need to experience before they break.<br />
*This is effectively the stress that a coupler can withstand before it breaks.<br />
*As a point of reference, a typical modern knuckle-type coupler can handle approximately 2500 kN of force before breaking.<br />
*This is roughly equivalent to the weight of 2.5 million apples.<br />
<br><br />
<br />
===SetMaximumCoupleVelocity===<br />
{{MethodHeader|public native void SetMaximumCoupleVelocity(float velocity)}}<br />
;Parameters<br />
*'''velocity''' = The maximum speed in metres per second at which this vehicle can be coupled to without breaking a coupler. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMaximumCoupleVelocity(10);<br />
;Notes<br />
*"Vehicle","BadCouple" are broadcast if this speed is exceeded.<br />
*If a value of zero is used "Vehicle","BadCouple" messages will not be issued.<br />
<br><br />
<br />
===SetMaximumTractiveEffort===<br />
{{MethodHeader|public native void SetMaximumTractiveEffort(float maxTE)}}<br />
;Parameters<br />
*'''maxTE''' = The maximum tractive effort of this vehicle in newtons (N). <br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMaximumTractiveEffort(185000.0);<br />
;Notes<br />
*The maximum tractive effort of a vehicle refers to its maximum traction or pulling power measured in newtons.<br />
*This value is initially defined in the configuration of a vehicle asset but can be altered with this method. <br />
*Generally, only locomotives will have tractive effort.<br />
<br><br />
<br />
===SetPitchBasedOnSpeed===<br />
{{MethodHeader|public native void SetPitchBasedOnSpeed(float factor)}}<br />
;Parameters<br />
*'''factor''' = An arbitrary value used to vary the pitch of the train with its velocity.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPitchBasedOnSpeed(2.5);<br />
;Notes<br />
*Pitch is rotation about an axis at right angles to the track direction.<br />
<br><br />
<br />
===SetPitchBasedOnTrack===<br />
{{MethodHeader|public native void SetPitchBasedOnTrack(bool pitch)}}<br />
;Parameters<br />
*'''pitch''' = True to enable the effect, false to disable.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetPitchBasedOnTrack(true);<br />
;Notes<br />
*Pitch is rotation about an axis at right angles to the track direction.<br />
<br><br />
<br />
===SetProductDisabled===<br />
{{MethodHeader|public native void SetProductDisabled(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetProductDisabled();<br />
;Notes<br />
*Disables the loading or unloading of any product, overriding any previous calls to SetProductRestriction().<br />
<br><br />
<br />
===SetProductRestriction===<br />
{{MethodHeader|public native bool SetProductRestriction(Asset product)}}<br />
;Parameters<br />
*'''product''' = Asset to which this vehicle's load is to be restricted.<br />
;Returned Value<br />
*True if successful, false otherwise.<br />
;Syntax<br />
SetProductRestriction(coal);<br />
;Notes<br />
*Restricts this vehicle to only allow the given product. <br />
*When a product restriction is in effect, only that product may be either loaded or unloaded. <br />
*This method overrides any previous call to SetProductDisabled().<br />
*If the product parameter is null, any product compatible with this vehicle can be loaded/unloaded. <br />
*If it is a product that is not compatible with this vehicle, no restriction is set and false will be returned. <br />
<br><br />
<br />
===SetQueueInitialCount===<br />
{{MethodHeader|public void SetQueueInitialCount(ProductQueue queue, Asset product, int amount)}}<br />
;Parameters<br />
*'''queue''' = Queue to use, any existing products in this queue will be destroyed.<br />
*'''product''' = Asset of product to use.<br />
*'''amount''' = Amount of product to use.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetQueueInitialCount(passengerQueue,passengers,20);<br />
;Notes<br />
*Fills the given queue with the specified quantity of product.<br />
*This method sets the amount of products in the given queue.<br />
*It is a utility method that works on the given queue which need not be a queue from this vehicle.<br />
*The product filter provided with queue will be used to check if the queue can take products of type asset.<br />
*If it can't, the filter will be modified to suit as this method is forceful in that regard. <br />
<br><br />
<br />
===SetRollBasedOnTrack===<br />
{{MethodHeader|public native void SetRollBasedOnTrack(float factor)}}<br />
;Parameters<br />
*'''factor''' = Arbitrary value used to control the amount of roll.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetRollBasedOnTrack(2.0);<br />
;Notes<br />
*Roll is a rotation about an axis parallel to the track direction.<br />
*Use a positive value to lean 'into' the curve, a negative value to lean out.<br />
<br><br />
<br />
===SetRunningNumber===<br />
{{MethodHeader|public native void SetRunningNumber(string number)}}<br />
;Parameters<br />
*'''number''' = The running (fleet identification) number of the vehicle.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetRunningNumber("21C1");<br />
SetRunningNumber("4472");<br />
;Notes<br />
*This value is retrieved using [[#GetRunningNumber|GetRunningNumber()]] and should be restricted to alphanumeric characters and spaces.<br />
<br><br />
<br />
===SetSandingTractionMultiplier===<br />
{{MethodHeader|public native void SetSandingTractionMultiplier(float factor)}}<br />
;Parameters<br />
*'''factor''' = A multiplier value of 1.0 or more defining the increase in this vehicle's tractive effort when sand is in use.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetSandingTractionMultiplier(1.5); // allow sanding to increase tractive effort by 50%<br />
;Notes<br />
<br><br />
<br />
===SetWheelslipTractionMultiplier===<br />
{{MethodHeader|public native void SetWheelslipTractionMultiplier(float factor)}}<br />
;Parameters<br />
*'''factor''' = A multiplier value of 1.0 or less to apply to decrease this vehicle's traction when wheelslip occurs.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetWheelslipTractionMultiplier(0.25); // wheelslip reduces tractive effort to 25% of normal.<br />
;Notes<br />
* A multiplier value of 1.0 disables the wheelspin sound.<br />
<br><br />
<br />
===Uncouple===<br />
{{MethodHeader|public native void Uncouple(int end)<br>public native void Uncouple(Vehicle other)}}<br />
;Parameters<br />
*'''end''' = One of the [[#Direction Relationships|Direction Relationship]] constants indicating at which end of the current vehicle the uncoupling is to occur.<br />
*'''other''' = A reference to the other vehicle form which the caller is to be uncoupled.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
Uncouple(DIRECTION_FORWARD); // uncouple at the current vehicle's front end<br />
Uncouple(vehicle1); // uncouple from the specified vehicle<br />
;Notes<br />
*This method will always cause another Train object to be created.<br />
*The current Train reference will remain on the section of the previous train with the most drivers declared.<br />
<br><br />
<br />
===UnloadProduct===<br />
{{MethodHeader|public bool UnloadProduct(LoadingReport report)}}<br />
;Parameters<br />
*'''report''' = Report on the current state of the loading operation.<br />
;Returned Value<br />
*True if the unloading operation was successful, false otherwise.<br />
;Syntax<br />
UnloadProduct(report);<br />
;Notes<br />
*Unloads products into this vehicle as defined by the given report. <br />
*This method works by attempting to transfer products from this vehicle's queues to the industry queue specified in report. <br />
*The sequence of events for an unloading operation as performed by this method is:<br />
**Verify that an unloading operation is possible with this vehicle by calling [[#CanUnloadProductToQueue|CanUnloadProductToQueue()]].<br />
**[[#BeginUnload|BeginUnload()]] on this vehicle and [[Class Industry#BeginUnload|Industry.BeginUnload()]] on the industry specified in the report are called to perform any pre-unloading events like animation or particle effects on the vehicle and industry respectively. <br />
**Both of these methods return the amount of time required for an unloading operation and the UnloadProduct() method sleeps for which ever of these times is the longer.<br />
**The actual product transfer to the industry from the vehicle is performed by calling ProductQueue.TransferProductFrom() on the industry queue(s).<br />
**[[#GetUnloadTime|GetUnloadTime()]] on this vehicle and [[Class Industry#GetUnloadTime|Industry.GetUnloadTime()]] are called. Again, UnloadProduct() sleeps for which ever is the longer of the times returned.<br />
**[[#EndUnload|EndUnload()]] and [[Class Industry#EndUnload|Industry.EndUnload()]] are called to perform any post-loading events. As before UnloadProduct() sleeps for the longer time.<br />
<br><br />
<br />
===UpdateViewDetails===<br />
{{MethodHeader|void UpdateViewDetails(Message msg)}}<br />
;Parameters<br />
*'''msg''' = Message object which triggers this handler.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*Update the view details window for this vehicle (from the train). <br />
*This method is setup by Init() as a handler method for a message of type "Vehicle","LoadComplete".<br />
*Such a message indicates that the load or queue of the vehicle have changed and the view details window of the train will need to be updated. <br />
<br><br />
<br />
===ViewDetails===<br />
{{MethodHeader|void ViewDetails(Message msg)}}<br />
;Parameters<br />
*'''msg''' = Message object which triggers this handler.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*View details window for this vehicle using the Train's output.<br />
*This method is setup by Init() as a handler method for a message of type "MapObject","ViewDetails".object. <br />
*Such a message indicates that the user has opened the right-click menu of the vehicle and selected the "View Details" menu item. <br />
*This method will call the ViewDetails() method of this vehicle's train so that a Browser window describing the entire train can be displayed to the user. <br />
<br><br />
<br />
===ViewSchedule===<br />
{{MethodHeader|void ViewSchedule(Message msg)}}<br />
;Parameters<br />
*'''msg''' = Message object which triggers this handler.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*View the schedule window for this vehicle from the train.<br />
*This method is setup by Init() as a handler method for a message of type "MapObject","View-Schedule". <br />
*Such a message indicates that the schedule of the vehicle or train is to be displayed for the user.<br />
*This method calls through to Train.UpdateScheduleWindow(). <br />
<br><br />
<br />
<br />
===NotifyTrainChanged===<br />
{{MethodHeader|public void NotifyTrainChanged(Train prevTrain, Train nextTrain)}}<br />
;Parameters<br />
*'''prevTrain''' = The train to which this Vehicle was previously attached.<br />
*'''nextTrain''' = The train to which this Vehicle is now attached.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*In ts12 only.<br />
*Override this function as required, but don't forget to call the inherited version in case it does something in the future.<br />
*Attempting to manipulate the makeup or positioning of any Train from within this function is illegal behavior. If you need to do that, trigger a delayed action using a message or a thread.<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class Train#GetVehicles|Train.GetVehicles()]]<br><br />
[[Class World#GetVehicleList|World.GetVehicleList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Train&diff=21264Class Train2019-09-09T15:37:24Z<p>Ciceronmt: /* GetSmoothedVelocity */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****Train<br />
<br />
<br><br />
*A train is a collection of vehicles in TRS.<br />
*They act as a single entity and may be controlled using this class.<br />
*A train is placed on a track in script by using [[Class World#CreateTrain|World.CreateTrain()]] or [[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]. <br />
*Trainz will automatically create a Train object for each consist that appears in the game.<br />
*When an existing train is uncoupled and split up into two separate consists a new train object is created.<br />
*Similarly when two trains couple one of the train objects is destroyed.<br />
<br><br />
<br />
==Messages==<br />
*Messages sent to and from Train objects are listed below:<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|Schedule||Abort||Train||Train <br />
|-<br />
|Schedule||Complete||Train||Broadcast <br />
|-<br />
|Schedule||Touch||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Deleted||Train||<br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal notify||Train||Broadcast <br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal||Signal||Train <br />
|-<br />
|[[Object Messages|Train]]||EnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerEnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerLeaveTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||LeaveTrack||Track||Train <br />
|-<br />
|[[Train Messages|Train]]||Over advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||ReachedTarget||Train||Train<br />
|-<br />
|[[Train Messages|Train]]||SlowingForTarget||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StartedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StoppedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Under advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under speed limit||Train||Broadcast <br />
|}<br />
<br><br />
<br />
==Constants==<br />
<br><br />
===Train Control Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CONTROL_MANUAL = 1||User controls train, script can change settings.<br />
|-<br />
|public define int CONTROL_AUTOPILOT = 2||Autopilot controls train.<br />
|-<br />
|public define int CONTROL_AUTOMANUAL = 3||User controls train, autopilot takes over when train is not currently 'focused'.<br />
|-<br />
|public define int CONTROL_SCRIPT = 4||Only the script can control the train.<br />
|}<br />
<br><br />
===Reverser Traction Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TRACTION_FORWARD = 2||Reverse is in forward setting.<br />
|-<br />
|public define int TRACTION_NEUTRAL = 1||Reverser is in neutral.<br />
|-<br />
|public define int TRACTION_REVERSE = 0||Reverser is in reverse.<br />
|}<br />
<br><br />
===Train Brake Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TRAIN_BRAKE_RELEASE = 0.0||Train brakes are released.<br />
|-<br />
|public define float TRAIN_BRAKE_INITIAL = 1.0||Train brakes are in initial mode.<br />
|-<br />
|public define float TRAIN_BRAKE_APPLICATION = 2.0||Train brakes are applied.<br />
|-<br />
|public define float TRAIN_BRAKE_HANDLE_OFF = 3.0||Train brake handle is off.<br />
|-<br />
|public define float TRAIN_BRAKE_EMERGENCY = 4.0||Train brakes are in emergency stop position.<br />
|-<br />
|public define float TRAIN_BRAKE_LAP = 5.0||Train brakes are in the lap position, not available for all trains.<br />
|}<br />
<br><br />
===Dynamic Brake States===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int DYNAMIC_BRAKE_TRACTION = 0||Dynamic brakes in traction mode.<br />
|-<br />
|public define int DYNAMIC_BRAKE_NEUTRAL = 1 ||Dynamic brakes in neutral.<br />
|-<br />
|public define int DYNAMIC_BRAKE_BRAKE = 2 ||Dynamic brakes are on.<br />
|}<br />
<br><br />
<br />
===Found Results===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int RESULT_NONE = 0||Item not found.<br />
|-<br />
|public define int RESULT_FORWARD = 1||Item is in front of train.<br />
|-<br />
|public define int RESULT_INSIDE = 2||Item is within the train, ie between the front and the rear limits.<br />
|-<br />
|public define int RESULT_BACKWARD = 3||Item is behind the train.<br />
|}<br />
<br><br />
===Measurement Conversion Multipliers===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float KPH_TO_MPS = 0.278||Kilometres per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_MPS = 0.447||Miles per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_KPH = 1.609||Miles per hour -> Kilometres per hour.<br />
|}<br />
<br><br />
==Members==<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|<b>public Browser timeTableInfo</b>||A publicly accessible Browser object for timetable information.<br />
|}<br />
<br><br />
==Methods==<br />
<br><br />
<br />
===AddVelocity===<br />
{{MethodHeader|public native void AddVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to add to the current speed of the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.AddVelocity(5.0); <br />
;Notes<br />
*Velocity parameter must be in metres per second and may be negative.<br />
*Use the [[#Measurement Conversion Multipliers|Measurement Conversion Multipliers]] to convert from other units.<br />
<br><br />
<br />
===ClearTrainTimetable===<br />
{{MethodHeader|public void ClearTrainTimetable(ScenarioBehavior rule)}} <br />
;Parameters<br />
*'''rule''' = rule that called [[#SetTrainTimetable|SetTrainTimetable()]] on this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ClearTimeTable(timetableRule); <br />
;Notes<br />
*Clears the train timetable of this train. <br />
*Having cleared the TrainTimetable, it is now safe again to set another TrainTimetable for this train through [[#SetTrainTimetable|SetTrainTimetable()]].<br />
*This method must only be called by the rule which called SetTrainTimetable() in the first place. <br />
*It is the responsibility of the caller to post a (TrainTimetable, Touch) message after calling this function.<br />
<br><br />
<br />
===DecTrainBusy===<br />
{{MethodHeader|public void DecTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.DecTrainBusy(); <br />
;Notes<br />
*Decrements this train's busy count.<br />
*See [[#IsTrainBusy|IsTrainBusy()]] for further details.<br />
<br><br />
<br />
===Derail===<br />
{{MethodHeader|public native void Derail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Derail(); <br />
;Notes<br />
*Deliberately derails the train.<br />
<br><br />
<br />
===EnablePhysics===<br />
{{MethodHeader|public native void EnablePhysics(bool enable)}} <br />
;Parameters<br />
*'''enable''' = True to enable physics calculations for this train, false to disable <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.EnablePhysics(false); <br />
;Notes<br />
*Turning physics off for scenic rolling stock that the player cannot interact with can boost performance.<br />
*There is no point in doing physic calculations for idle rollingstock.<br />
<br><br />
<br />
===GetActiveDriver===<br />
{{MethodHeader|public native DriverCharacter GetActiveDriver(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The active driver of this train, null if there is no driver assigned.<br />
;Syntax<br />
DriverCharacter driver = train.GetActiveDriver(); <br />
;Notes<br />
*There may be more than one driver on a train but there is only one active driver and an individual Locomotive may only have one driver assigned.<br />
<br><br />
<br />
===GetAdvisoryLimit===<br />
{{MethodHeader|public native float GetAdvisoryLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current advisory speed limit set by script. <br />
;Syntax<br />
float speed = train.GetAdvisoryLimit(); <br />
;Notes<br />
<br><br />
<br />
===GetAllowsUserContol===<br />
{{MethodHeader|public native bool GetAllowsUserControl(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train allows the user to control it directly through DCC or Cabin interfaces, false otherwise.<br />
;Syntax<br />
bool canDrive =train.getAllowsUserControl(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotMode===<br />
{{MethodHeader|public native int GetAutopilot Mode(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Control Modes|Train Control Mode]] constants defining the method by which the train is currently controlled.<br />
;Syntax<br />
int controlMode = train.GetAutopilotMode(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopJunctionBase===<br />
{{MethodHeader|public native JunctionBase GetAutopilotStopJunctionBase(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The junction object that is preventing the autopilot from taking this train any further, null if the train is not stopped by a junction. <br />
;Syntax<br />
JunctionBase junction = train GetAutopilotStopJunctionBase(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopTrain===<br />
{{MethodHeader|public native Train GetAutopilotStopTrain(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train that is preventing the autopilot from taking this train any further, null if the train is not being held up by another train. <br />
;Syntax<br />
Train otherTrain = train.GetAutopilotStopTrain(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotTargetSlowing===<br />
{{MethodHeader|public native bool GetAutopilotTargetSlowing(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the autopilot is slowing down for its target destination, false otherwise. <br />
;Syntax<br />
bool isSlowing = train.GetAutopilotTargetSlowing(); <br />
;Notes<br />
<br><br />
<br />
===GetDCCThrottle===<br />
{{MethodHeader|public native float GetDCCThrottle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The DCC throttle setting for this train when using DCC physics. <br />
;Syntax<br />
float throttle = GetDCCThrottle(); <br />
;Notes<br />
*The returned value will be in the range [-1.0 .. 1.0] where -1.0 is full throttle in reverse, 0.0 is stationary and 1.0 is full throttle forward.<br />
<br><br />
<br />
===GetFrontmostLocomotive===<br />
{{MethodHeader|public native Locomotive GetFrontmostLocomotive(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a reference to the frontmost locomotive in the train. <br />
;Syntax<br />
Loco = Train.GetFrontmostLocomotive(); <br />
;Notes<br />
*<font color=red>The ''front'' of the train is defined relative to the train's current heading.??</font> <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetHeadlightState===<br />
{{MethodHeader|public native bool GetHeadlightState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if headlights are turned on, false otherwise. <br />
;Syntax<br />
bool lights = train.GetHeadlightState(); <br />
;Notes<br />
*Only the frontmost locomotive will display headlighs.<br />
<br><br />
<br />
===GetLastVisitedBuildable===<br />
{{MethodHeader|public Buildable GetLastVisitedBuildable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last [[Class Buildable|Buildable]] object visited by this train, null if there have been no such visits.<br />
;Syntax<br />
Buildable buildable = train.GetLastVisitedBuildable(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedIndustry===<br />
{{MethodHeader|public Industry GetLastVisitedIndustry(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last Industry object visited by this train, null if there have been no such visits. <br />
;Syntax<br />
Industry industry = train.GetLastVisitedIndustry(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedTrack===<br />
{{MethodHeader|public Track GetLastVisitedTrack(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last track segment visited by this train. <br />
;Syntax<br />
Track track = train.GetLastVisitedTrack(); <br />
;Notes<br />
*Note that the returned value may be null. <font color=red>How is that possible?</font><br />
<br><br />
<br />
===GetHighBeams===<br />
{{MethodHeader|public bool GetHighBeams(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the frontmost locomotive's high beams are on, false otherwise. <br />
;Syntax<br />
bool High_Lights = train.GetHighBeams(); <br />
;Notes<br />
*See also [[Class Vehicle#GetHighBeams|Vehicle.GetHighBeams()]]<br />
<br><br />
<br />
===GetMaximumCouplingStressVehicle===<br />
{{MethodHeader|public native Vehicle GetMaximumCouplingStressVehicle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The Vehicle in this consist that is experiencing the greatest level of coupling stress. <br />
;Syntax<br />
Vehicle vehicle = GetMaximumCouplingStressVehicle(); <br />
;Notes<br />
<br><br />
<br />
===GetPantographState===<br />
{{MethodHeader|public native int GetPantographState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The state of the pantographs of the electric locomotives in this train. <br />
;Syntax<br />
int pantoState = train.GetPantographState(); <br />
;Notes<br />
*The returned value will be in the range [0..3] where:<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===GetPhysicsModel===<br />
{{MethodHeader|public native int GetPhysicsModel(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The mode of control chosen by the player to drive the locomotive <br />
;Syntax<br />
int Mode = train.GetPhysicsModel(); <br />
;Notes<br />
*The returned value will be :<br />
**2 = CabinControl<br />
**1 = DCCMode<br />
<br><br />
<br />
<br />
===GetSmoothedVelocity===<br />
{{MethodHeader|public native float GetSmoothedVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a smoothed velocity, intended for human consumption. <br />
;Syntax<br />
float speed = train.GetSmoothedVelocity(); <br />
;Notes<br />
*If you require an accurate velocity readout for physics operations, use [[#GetVelocity|GetVelocity()]].<br />
*''In practice, even when the train stops completely, it does not report an absolute zero.''<br />
<br><br />
<br />
===GetSpeedLimit===<br />
{{MethodHeader|public native float GetSpeedLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current sign posted speed limit. <br />
;Syntax<br />
float permittedSpeed = train.GetSpeedLimit(); <br />
;Notes<br />
*The speed limit is dependent on trackside signs placed in Surveyor as well as the direction of the train.<br />
*A default value applies to track that isn't sign posted.<br />
<br><br />
<br />
===GetTrackmarkDirection===<br />
{{MethodHeader|public native int GetTrackmarkDirection(TrackMark mark)}} <br />
;Parameters<br />
*'''mark''' = A reference to the Trackmark to search for.<br />
;Returned Value<br />
* One of the [[#Found Results|Found Result]] values representing the location of the given track mark relative to this train. <br />
;Syntax<br />
int location = train.GetTrackmarkDirection(trackmark); <br />
;Notes<br />
<br><br />
<br />
===GetTrainBrakes===<br />
{{MethodHeader|public native float GetTrainBrakes(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Brake Modes|Train Brake mode]] constants indicating the current state of this train's brakes. <br />
;Syntax<br />
float brakeState = train.GetTrainBrakes(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainDisplayName===<br />
{{MethodHeader|public native string GetTrainDisplayName(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*A localised display name for this train. <br />
;Syntax<br />
string trainName = train.GetTrainDisplayName(); <br />
;Notes<br />
*This will be a name Trainz has created for the consist such as "Consist 0" and will match the description shown in the Minimap view. <br />
<br><br />
<br />
===GetTrainPriorityNumber===<br />
{{MethodHeader|public native int GetTrainPriorityNumber(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Train priority value in the range [1 .. 3] <br />
;Syntax<br />
int priority = train.GetTrainPriorityNumber();<br />
;Notes<br />
*See [[#SetTrainPriority|SetTrainPriority()]] for further details. <br />
<br><br />
<br />
===GetTrainTimetable===<br />
{{MethodHeader|public TrainTimetable GetTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The TrainTimetable that the train is currently using, null if there is none.<br />
;Syntax<br />
TrainTimetable timetable = train.GetTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainVelocity===<br />
{{MethodHeader|public native float GetTrainVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity in metres per second.<br />
;Syntax<br />
float speed = train.GetTrainVelocity(); <br />
;Notes<br />
* This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display. If you want human-readable display, use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] instead.<br />
<br><br />
<br />
<br />
===GetVehicles===<br />
{{MethodHeader|public native Vehicle[ ] GetVehicles(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns an array consisting of all the vehicles making up this train. <br />
;Syntax<br />
Vehicle[] vehicles = train.GetVehicles(); <br />
;Notes<br />
*GetVehicles[0] is always the front vehicle of the train relative to the train's current heading. <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetVelocity===<br />
{{MethodHeader|public native float GetVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity. <br />
;Syntax<br />
float speed = train.GetVelocity(); <br />
;Notes<br />
*Warning! The TS10 and TS12 Train.gs scripts advise this method is buggy and to use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] or [[#GetTrainVelocity|GetTrainVelocity()]] instead.<br />
*This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display.<br />
<br><br />
<br />
===HasReachedInnerJunctionRadius===<br />
{{MethodHeader|public bool HasReachedJunctionInnerJunctionRadius(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if this train is within the inner radius of the given junction, false otherwise. <br />
;Syntax<br />
bool arrived = train.HasReachedInnerJunctionRadius(junction10); <br />
;Notes<br />
<br><br />
<br />
===HasTrainTimetable===<br />
{{MethodHeader|public bool HasTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train has an attached TrainTimetable, false otherwise. <br />
;Syntax<br />
bool timed = train.HasTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleRunning===<br />
{{MethodHeader|public bool IsScheduleRunning(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train is currently running to a Schedule, false otherwise. <br />
;Syntax<br />
bool scheduled = train.IsScheduleRunning(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleWindowVisible===<br />
{{MethodHeader|public bool IsScheduleWindowVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the schedule window for this train is currently open, false otherwise. <br />
;Syntax<br />
bool windowOpen = IsScheduleWindowVisible(); <br />
;Notes<br />
<br><br />
<br />
===IsStillInJunction===<br />
{{MethodHeader|public bool IsStillInJunction(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if the train holds a Permit for the given junction, flse otherwise. <br />
;Syntax<br />
bool inJunction = train.IsStillInJunction(junction10);<br />
;Notes<br />
<br><br />
<br />
===IsStopped===<br />
{{MethodHeader|public native bool IsStopped(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train is currently stationary, false if it is in motion. <br />
;Syntax<br />
bool moving=train.IsStopped(); <br />
;Notes<br />
<br><br />
<br />
===IsTrainBusy===<br />
{{MethodHeader|public bool IsTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train's 'busy' count is greater than zero, false otherwise. <br />
;Syntax<br />
bool busy = train.IsTrainBusy(); <br />
;Notes<br />
*Using the [[#IncTrainBusy|IncTrainBusy()]] method, any piece of script code can tag a train being busy. <br />
*The train can be untagged later by calling DecTrainBusy(). <br />
*This mechanism is mainly used by industries that are doing something with the train. <br />
*A train can be tagged as being busy more than once by calling IncTrainBusy() multiple times so different industries can tag the train. <br />
*Each time IncTrainBusy() is called, an internal busy count is incremented and if that busy count is greater than zero, the train is considered busy.<br />
<br><br />
<br />
===IsViewDetailsVisible===<br />
{{MethodHeader|public bool IsViewDetailsVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*true if the ViewDetails window for this train is visible, false otherwise. <br />
;Syntax<br />
bool visible = train.IsViewDetailsVisible(); <br />
;Notes<br />
<br><br />
<br />
===MapObjectIsInFront===<br />
{{MethodHeader|public bool MapObjectIsInFront(MapObject obj, float range)}} <br />
;Parameters<br />
*'''obj''' = MapObject to search for.<br />
*'''range''' = Maximum search distance. <br />
;Returned Value<br />
*True if the object is found within the specified distance and in front of the train, false otherwise. <br />
;Syntax<br />
bool isClose = train.MapObjectIsInFront(terminus,100.0); <br />
;Notes<br />
<br><br />
<br />
===ReleaseTrackPermits===<br />
{{MethodHeader|public void ReleaseTrackPermits(Permit[ ] permitList)}} <br />
;Parameters<br />
*'''permitList''' = Permit array containing a list of permits to release. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ReleaseTrackPermits(permitList); <br />
;Notes<br />
*This method will release any permits from the ''permitList'' array that are currently held by this train.<br />
*Any other permits in the array that are not held by this train will be ignored.<br />
<br><br />
<br />
===RunSchedule===<br />
{{MethodHeader|public thread void RunSchedule(Schedule schedule, bool loop, float delay)}} <br />
;Parameters<br />
*'''schedule''' = The Schedule that the train is to follow.<br />
*'''loop''' = False to run the schedule once, True to repeat it continuously.<br />
*'''delay''' = Time in seconds to wait before starting the schedule. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.RunSchedule(schedule,false,10.0); <br />
;Notes<br />
*See [[Class Schedule|Schedule]] for information on how to build a schedule.<br />
*Only one schedule may run on a train at a time and the user cannot control the train when it is running a schedule.<br />
*This method is a thread, so the calling code does not need to wait for it to finish and return before executing other code.<br />
<br><br />
<br />
===SetAdvisoryLimit===<br />
{{MethodHeader|public native void SetAdvisoryLimit(float speed)}} <br />
;Parameters<br />
*'''speed''' = Speed limit to set in <del>KPH</del> metres/second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAdvisoryLimit(60.0);<br />
;Notes<br />
*Sets an advisory speed limit for a script controlled train.<br />
*Use zero in the speed parameter to clear any previously imposed limit.<br />
*<font color=red>Does this really use KPH, most similar methods use MPS</font><br />
*<font color=red>Experimental evidence confirms that it's in m/s not kph or mph</font><br />
<br><br />
<br />
===SetAutopilotMode===<br />
{{MethodHeader|public native void SetAutopilotMode(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Control Modes|Train Control Mode]] constants specifying the method by which this train is controlled. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotMode(Train.CONTROL_AUTOMANUAL); <br />
;Notes<br />
<br><br />
<br />
===SetAutopilotTarget===<br />
{{MethodHeader|public native void SetAutopilotTarget(Buildable buildable, string trigger)<br>public native void SetAutopilotTarget(Trackside trackside)<br>public native void SetAutopilotTarget(Track track)<br>public native void SetAutopilotTarget(JunctionBase junction)}} <br />
;Parameters<br />
*'''buildable''' = Buildable object to use as a destination.<br />
*'''trigger''' = Attached trigger within the buildable, specified by name.<br />
*'''trackside''' = Trackside object to use as a destination.<br />
*'''track''' = Track segment to use as a destination.<br />
*'''junction''' = JunctionBase object to use as a destination.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotTarget("Kings Cross Station","trigger1"); <br />
;Notes<br />
*This method sets a destination for the autopilot to take this train to.<br />
*Objects from respective child classes such as industries, signals and trackmarks may be specified.<br />
<br><br />
<br />
===SetAutopilotTargetMinimumDistance===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumDistance(float distance)}} <br />
;Parameters<br />
*'''distance''' = The minimum distance in metres, between the train and the autopilot target, to be reached before the train will start to slow down. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train SetAutopilotTargetMinimumDistance(100.0);<br />
;Notes<br />
<br><br />
<br />
===SetAutoPilotTargetMinimumSpeed===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumSpeed(float speed)}} <br />
;Parameters<br />
*'''speed''' = Minimum speed, in metres per second, that the train should be travelling at when it reaches the Autopilot target. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutoPilotTargetMinimumSpeed(20.0); <br />
;Notes<br />
*<font color=red>The documentation seems to mean that the train should be going at 20.0 OR MORE. Shouldn't it be MaximumSpeed???</font><br />
<br><br />
<br />
===SetBail===<br />
{{MethodHeader|public native void SetBail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetBail(); <br />
;Notes<br />
*Depresses the bail control for a short period.<br />
<br><br />
<br />
===SetCouplingMask===<br />
{{MethodHeader|public void SetCouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the trains exposed couplers are allowed to couple.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetCouplingMask(Vehicle.COUPLE_NONE); // prevents this train from coupling to another in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from coupling in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDCCThrottle===<br />
{{MethodHeader|public native void SetDCCThrottle(float throttle)}} <br />
;Parameters<br />
*'''throttle''' = Float value in the range -1.0 .. 1.0 defining the throttle setting for the train when using DCC physics. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDCCThrottle(0.0); //sets the throttle to neutral. <br />
;Notes<br />
*Full speed ahead is 1.0<br />
*Maximum in reverse is -1.0<br />
*Neutral is 0.0<br />
<br><br />
<br />
===SetDecouplingMask===<br />
{{MethodHeader|public void SetDecouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the couplers are allowed to couple, applies to all of the vehicles in the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDecouplingMask(Vehicle.COUPLE_FRONT|Vehicle.COUPLE_BACK); // prevents vehicles being uncoupled from the train in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from being uncoupled in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDynamicBrakeMode===<br />
{{MethodHeader|public native void SetDynamicBrakeMode(int mode)}} <br />
;Parameters<br />
*One of the [[#Dynamic Brake States|Dynamic Brake State]] constants indicating the current state of this train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDynamicBrakeMode(Train.DYNAMIC_BRAKE_TRACTION); <br />
;Notes<br />
<br><br />
<br />
===SetFloatingLimit===<br />
{{MethodHeader|public native void SetFloatingLimit(float delta, bool enable)}} <br />
;Parameters<br />
*'''delta''' = Tolerance allowed from the posted limit in metres per second.<br />
*'''enable''' = Use true to enable messages related to floating limits, false to disable.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetFloatingLimit(5.0,true); <br />
;Notes<br />
*Sets the floating speed limit level above the sign posted limit.<br />
*The floating limit is an amount of tolerance above the current speed limit. <br />
*Messages for floating speed violations are not to be confused with regular speed limit messages.<br />
*The floating limit is monitored by the Scenario.Monitor() thread, and may be used for point deduction when speeding. It should therefore be reserved for player trains.<br />
<br><br />
<br />
===SetHandBrake===<br />
{{MethodHeader|public void SetHandBrake(bool state)}} <br />
;Parameters<br />
*'''state''' = Use true to apply the handbrake to all vehicles in this train which are not Locomotives, false to release the handbrake.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHandBrake(true); <br />
;Notes ''The use of this function did not reveal any effect on the physics of trains.''<br />
<br><br />
<br />
===SetHeadlightState===<br />
{{MethodHeader|public native void SetHeadlightState(bool lightsOn)}} <br />
;Parameters<br />
*'''lightsOn''' = True to turn the headlights on, false to turn them off. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHeadlightState(true); <br />
;Notes<br />
*This method affects only the headlights on the frontmost locomotive.<br />
<br><br />
<br />
===SetHighBeams===<br />
{{MethodHeader|public void SetHighBeams(bool value)}} <br />
;Parameters<br />
*'''value''' = True to turn on high beams, false to turn them off. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
train.SetHighBeams(true); <br />
;Notes<br />
*See also [[Class Vehicle#SetHighBeams|Vehicle.SetHighColor()]]<br />
<br><br />
<br />
===SetLastVisitedBuildable===<br />
{{MethodHeader|public void SetLastVisitedBuildable(Buildable buildable)}} <br />
;Parameters<br />
*'''buildable''' = Sets the last visited buildable to the given object. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetLastVisitedBuildable(KingsCrossStation); <br />
;Notes<br />
<br><br />
<br />
===SetManualThrottle===<br />
{{MethodHeader|public native void SetManualThrottle(int notch)}} <br />
;Parameters<br />
*'''notch''' = Value in the range 0 .. 8 to set the throttle. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetManualThrottle(5); <br />
;Notes<br />
<br><br />
<br />
===SetPantogaphState===<br />
{{MethodHeader|public native void SetPantographState(int state)}} <br />
;Parameters<br />
*'''state''' = Value in the range 0 .. 3 to set the pantographs if this train has them. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetPantographState(3); <br />
;Notes<br />
*Use one of these values for ''state'':<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===SetReverser===<br />
{{MethodHeader|public native void SetReverser(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Reverser Traction Modes|Reverser Traction Mode]] constants defining the required state of the train's reverser lever. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetReverser(Train.TRACTION_REVERSE); <br />
;Notes<br />
<br><br />
<br />
===SetTrainBrakes===<br />
{{MethodHeader|public native void SetTrainBrakes(float mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Brake States|Train Brake State]] constants defining the required state of the train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainBrakes(Train.TRAIN_BRAKE_EMERGENCY); <br />
;Notes<br />
<br><br />
<br />
===SetTrainPriorityNumber===<br />
{{MethodHeader|public native void SetTrainPriority Number(int priority)}} <br />
;Parameters<br />
*'''priority''' = Priority value in the range 1 .. 3. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainPriorityNumber(2); <br />
;Notes<br />
*All trains and track sections can be assigned a priority value in the range of [1 - 3] with the default value being 2.<br />
*The priority value is not a numerical scale of precedence, but a value for the AI driver to attempt to match.<br />
*This means the driver will ''prefer'' track sections that have a priority equal to that of the train.<br />
*Changing the priority of the train only takes affect when the driver restarts a new schedule.<br />
<br><br />
<br />
===SetTrainTimetable===<br />
{{MethodHeader|public void SetTrainTimetable(TrainTimetable timetable)}} <br />
;Parameters<br />
*'''timetable''' = Assigns the specified timetable to this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainTimetable(timetable);<br />
;Notes<br />
*This train must not already have a TrainTimetable assigned.<br />
*To ensure that this proviso is met, use [[#ClearTrainTimetabel|ClearTrainTimetable()]] prior to calling this method.<br />
*It is the responsibility of the caller to post a "TrainTimetable","Touch" message after calling this function.<br />
<br><br />
<br />
===SetVelocity===<br />
{{MethodHeader|public native void SetVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to apply to the train, in metres per second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetVelocity(0.0); // stops the train, subject to braking performance. <br />
;Notes<br />
<br><br />
<br />
===ShowInConsistMenu===<br />
{{MethodHeader|public native void ShowInConsistMenu(bool show)}} <br />
;Parameters<br />
*'''show''' = True to make this train visible to the in-game consist menu, false to hide it. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ShowInConsistMenu(false); <br />
;Notes<br />
<br><br />
<br />
===SoundHorn===<br />
{{MethodHeader|public native void SoundHorn(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SoundHorn(); <br />
;Notes<br />
*Sounds the horn or whictle for all locomotives in this train.<br />
<br><br />
<br />
===StopSchedule===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any).<br />
<br><br />
<br />
===StopScheduleAndWait===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any) and waits until the train's schedule actually stops before returning. <br />
*If the train is not running a schedule, the method returns after broadcasting a "Schedule","Touch" message, in case someone is listening for schedule messages.<br />
<br><br />
<br />
===StopTrainGently===<br />
{{MethodHeader|public native void StopTrainGently(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopTrainGently(); <br />
;Notes<br />
*Brings the train to a halt over a short time period.<br />
<br><br />
<br />
===TakePermitOnTrack===<br />
{{MethodHeader|public Permit[ ] TakePermitOnTrack(bool direction)}} <br />
;Parameters<br />
*'''direction''' = Direction relative to the train in which to take out permits. <br />
;Returned Value<br />
*An array including any permits taken which have not yet been granted to this train. Some of these permits may not yet have been granted. <br />
;Syntax<br />
Permit[] permits = train.TakePermitOnTrack(true); <br />
;Notes<br />
*Gets permits on the current track in the given direction.<br />
<br><br />
<br />
===TestTrackPermit===<br />
{{MethodHeader|public native bool TestTrackPermit(Permit permit, bool innerOnly)}} <br />
;Parameters<br />
*'''permit''' = An existing Permit object.<br />
*'''innerOnly''' = If true the method will test only the inner radius, if false the default radius of 150 metres will be used.<br />
;Returned Value<br />
*True if this train is within the track controlled by ''permit'', false otherwise. <br />
;Syntax<br />
bool ownPermit = train.TestTrackPermit(permit1,false); <br />
;Notes<br />
*The method generates an exception if the ''permit'' parameter does not refer to a track.<br />
<br><br />
<br />
===ToggleScheduleWindow===<br />
{{MethodHeader|public void ToggleScheduleWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleScheduleWindow(); <br />
;Notes<br />
*If the schedule window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, UpdateScheduleWindow() is called to create it for display.<br />
<br><br />
<br />
===ToggleViewDetailsWindow===<br />
{{MethodHeader|public void ToggleViewDetailsWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleViewDetailsWindow(); <br />
;Notes<br />
*If the ViewDetails window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, ViewDetails() is called to create it for display.<br />
<br><br />
<br />
===TrackSearch===<br />
{{MethodHeader|public native MapObject[ ] TrackSearch(bool direction, float distance)}} <br />
;Parameters<br />
*'''direction''' = Direction to search relative to the train's heading, true for forwards, false for backwards.<br />
*'''distance''' = Maximum search distance in metres. <br />
;Returned Value<br />
*An array of objects found along the track in the defined search direction, the array might be empty. <br />
;Syntax<br />
MapObject[] objects = train.TrackSearch(true,5000.0) // searches 5km forwards along the track. <br />
;Notes<br />
*Gets all of the Trackside and SceneryWithTrack objects on a length of track that is either in front of or behind this train. <br />
*Descendants of these classes are also returned.<br />
<br><br />
<br />
===TracksideIsInFront===<br />
{{MethodHeader|public bool TracksideIsInFront(Trackside obj, float range)}} <br />
;Parameters<br />
*'''obj''' = Trackside object to search for.<br />
*'''range''' = Mximum search distance. <br />
;Returned Value<br />
*True if the object is logically forward of this train, false otherwise. <br />
;Syntax<br />
bool found = train.TracksideIsInFront(signal1,500.0); <br />
;Notes<br />
<br><br />
<br />
===Turnaround===<br />
{{MethodHeader|public native void Turnaround(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Turnaround(); <br />
;Notes<br />
*Reverses the logical direction of the train, ie changes its heading.<br />
*The physical direction of the vehicles is not altered but the throttle direction is reversed.<br />
*If the camera is focused on the train in tracking view when this method is called the camera's direction of view (relative to the map) will alter through 180 degrees.<br />
<br><br />
<br />
===UpdateScheduleWindow===<br />
{{MethodHeader|public void UpdateScheduleWindow(string vehicleName)}} <br />
;Parameters<br />
*'''vehicleName''' = Name of vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateScheduleWindow("brake2"); <br />
;Notes<br />
*Updates the schedule window from the given vehicle.<br />
<br><br />
<br />
===UpdateViewDetails===<br />
{{MethodHeader|public void UpdateViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetails(vehicle);<br />
;Notes<br />
*Called by Vehicle.UpdateViewDetails() when a vehicle's load has changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===UpdateViewDetailsLocomotive===<br />
{{MethodHeader|public void UpdateViewDetailsLocomotive(void)}} <br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetailsLocomotive(vehicle);<br />
;Notes<br />
*Called by Locomotive.UpdateViewDetails() when any of the Locomotive's operating parameters have changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===ViewDetails===<br />
{{MethodHeader|public void ViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ViewDetails(vehicle); <br />
;Notes<br />
*This method is called by Vehicle.ViewDetails() when the user has requested to view the details of the consist.<br />
*It will create a Browser window listing information about the train including who the driver character is and the loads of all vehicles.<br />
<br><br />
<br />
===WasRunScheduleSuccessful===<br />
{{MethodHeader|public bool WasRunScheduleSuccessful(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the most recently run schedule was successfully, false otherwise. <br />
;Syntax<br />
train.WasRunScheduleSuccessful(); <br />
;Notes<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class TrainUtil#AreInTrain|TrainUtil.AreInTrain()]]<br><br />
[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]<br><br />
[[Class TrainUtil#IsInTrain|TrainUtil.IsInTrain()]]<br><br />
[[Class World#CreateTrain|World.CreateTrain()]]<br><br />
[[Class World#DeleteTrain|World.DeleteTrain()]]<br><br />
[[Class World#GetTrainList|World.GetTrainList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Train&diff=21246Class Train2019-09-09T08:30:39Z<p>Ciceronmt: /* SetHandBrake */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****Train<br />
<br />
<br><br />
*A train is a collection of vehicles in TRS.<br />
*They act as a single entity and may be controlled using this class.<br />
*A train is placed on a track in script by using [[Class World#CreateTrain|World.CreateTrain()]] or [[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]. <br />
*Trainz will automatically create a Train object for each consist that appears in the game.<br />
*When an existing train is uncoupled and split up into two separate consists a new train object is created.<br />
*Similarly when two trains couple one of the train objects is destroyed.<br />
<br><br />
<br />
==Messages==<br />
*Messages sent to and from Train objects are listed below:<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|Schedule||Abort||Train||Train <br />
|-<br />
|Schedule||Complete||Train||Broadcast <br />
|-<br />
|Schedule||Touch||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Deleted||Train||<br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal notify||Train||Broadcast <br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal||Signal||Train <br />
|-<br />
|[[Object Messages|Train]]||EnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerEnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerLeaveTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||LeaveTrack||Track||Train <br />
|-<br />
|[[Train Messages|Train]]||Over advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||ReachedTarget||Train||Train<br />
|-<br />
|[[Train Messages|Train]]||SlowingForTarget||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StartedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StoppedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Under advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under speed limit||Train||Broadcast <br />
|}<br />
<br><br />
<br />
==Constants==<br />
<br><br />
===Train Control Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CONTROL_MANUAL = 1||User controls train, script can change settings.<br />
|-<br />
|public define int CONTROL_AUTOPILOT = 2||Autopilot controls train.<br />
|-<br />
|public define int CONTROL_AUTOMANUAL = 3||User controls train, autopilot takes over when train is not currently 'focused'.<br />
|-<br />
|public define int CONTROL_SCRIPT = 4||Only the script can control the train.<br />
|}<br />
<br><br />
===Reverser Traction Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TRACTION_FORWARD = 2||Reverse is in forward setting.<br />
|-<br />
|public define int TRACTION_NEUTRAL = 1||Reverser is in neutral.<br />
|-<br />
|public define int TRACTION_REVERSE = 0||Reverser is in reverse.<br />
|}<br />
<br><br />
===Train Brake Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TRAIN_BRAKE_RELEASE = 0.0||Train brakes are released.<br />
|-<br />
|public define float TRAIN_BRAKE_INITIAL = 1.0||Train brakes are in initial mode.<br />
|-<br />
|public define float TRAIN_BRAKE_APPLICATION = 2.0||Train brakes are applied.<br />
|-<br />
|public define float TRAIN_BRAKE_HANDLE_OFF = 3.0||Train brake handle is off.<br />
|-<br />
|public define float TRAIN_BRAKE_EMERGENCY = 4.0||Train brakes are in emergency stop position.<br />
|-<br />
|public define float TRAIN_BRAKE_LAP = 5.0||Train brakes are in the lap position, not available for all trains.<br />
|}<br />
<br><br />
===Dynamic Brake States===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int DYNAMIC_BRAKE_TRACTION = 0||Dynamic brakes in traction mode.<br />
|-<br />
|public define int DYNAMIC_BRAKE_NEUTRAL = 1 ||Dynamic brakes in neutral.<br />
|-<br />
|public define int DYNAMIC_BRAKE_BRAKE = 2 ||Dynamic brakes are on.<br />
|}<br />
<br><br />
<br />
===Found Results===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int RESULT_NONE = 0||Item not found.<br />
|-<br />
|public define int RESULT_FORWARD = 1||Item is in front of train.<br />
|-<br />
|public define int RESULT_INSIDE = 2||Item is within the train, ie between the front and the rear limits.<br />
|-<br />
|public define int RESULT_BACKWARD = 3||Item is behind the train.<br />
|}<br />
<br><br />
===Measurement Conversion Multipliers===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float KPH_TO_MPS = 0.278||Kilometres per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_MPS = 0.447||Miles per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_KPH = 1.609||Miles per hour -> Kilometres per hour.<br />
|}<br />
<br><br />
==Members==<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|<b>public Browser timeTableInfo</b>||A publicly accessible Browser object for timetable information.<br />
|}<br />
<br><br />
==Methods==<br />
<br><br />
<br />
===AddVelocity===<br />
{{MethodHeader|public native void AddVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to add to the current speed of the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.AddVelocity(5.0); <br />
;Notes<br />
*Velocity parameter must be in metres per second and may be negative.<br />
*Use the [[#Measurement Conversion Multipliers|Measurement Conversion Multipliers]] to convert from other units.<br />
<br><br />
<br />
===ClearTrainTimetable===<br />
{{MethodHeader|public void ClearTrainTimetable(ScenarioBehavior rule)}} <br />
;Parameters<br />
*'''rule''' = rule that called [[#SetTrainTimetable|SetTrainTimetable()]] on this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ClearTimeTable(timetableRule); <br />
;Notes<br />
*Clears the train timetable of this train. <br />
*Having cleared the TrainTimetable, it is now safe again to set another TrainTimetable for this train through [[#SetTrainTimetable|SetTrainTimetable()]].<br />
*This method must only be called by the rule which called SetTrainTimetable() in the first place. <br />
*It is the responsibility of the caller to post a (TrainTimetable, Touch) message after calling this function.<br />
<br><br />
<br />
===DecTrainBusy===<br />
{{MethodHeader|public void DecTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.DecTrainBusy(); <br />
;Notes<br />
*Decrements this train's busy count.<br />
*See [[#IsTrainBusy|IsTrainBusy()]] for further details.<br />
<br><br />
<br />
===Derail===<br />
{{MethodHeader|public native void Derail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Derail(); <br />
;Notes<br />
*Deliberately derails the train.<br />
<br><br />
<br />
===EnablePhysics===<br />
{{MethodHeader|public native void EnablePhysics(bool enable)}} <br />
;Parameters<br />
*'''enable''' = True to enable physics calculations for this train, false to disable <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.EnablePhysics(false); <br />
;Notes<br />
*Turning physics off for scenic rolling stock that the player cannot interact with can boost performance.<br />
*There is no point in doing physic calculations for idle rollingstock.<br />
<br><br />
<br />
===GetActiveDriver===<br />
{{MethodHeader|public native DriverCharacter GetActiveDriver(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The active driver of this train, null if there is no driver assigned.<br />
;Syntax<br />
DriverCharacter driver = train.GetActiveDriver(); <br />
;Notes<br />
*There may be more than one driver on a train but there is only one active driver and an individual Locomotive may only have one driver assigned.<br />
<br><br />
<br />
===GetAdvisoryLimit===<br />
{{MethodHeader|public native float GetAdvisoryLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current advisory speed limit set by script. <br />
;Syntax<br />
float speed = train.GetAdvisoryLimit(); <br />
;Notes<br />
<br><br />
<br />
===GetAllowsUserContol===<br />
{{MethodHeader|public native bool GetAllowsUserControl(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train allows the user to control it directly through DCC or Cabin interfaces, false otherwise.<br />
;Syntax<br />
bool canDrive =train.getAllowsUserControl(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotMode===<br />
{{MethodHeader|public native int GetAutopilot Mode(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Control Modes|Train Control Mode]] constants defining the method by which the train is currently controlled.<br />
;Syntax<br />
int controlMode = train.GetAutopilotMode(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopJunctionBase===<br />
{{MethodHeader|public native JunctionBase GetAutopilotStopJunctionBase(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The junction object that is preventing the autopilot from taking this train any further, null if the train is not stopped by a junction. <br />
;Syntax<br />
JunctionBase junction = train GetAutopilotStopJunctionBase(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopTrain===<br />
{{MethodHeader|public native Train GetAutopilotStopTrain(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train that is preventing the autopilot from taking this train any further, null if the train is not being held up by another train. <br />
;Syntax<br />
Train otherTrain = train.GetAutopilotStopTrain(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotTargetSlowing===<br />
{{MethodHeader|public native bool GetAutopilotTargetSlowing(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the autopilot is slowing down for its target destination, false otherwise. <br />
;Syntax<br />
bool isSlowing = train.GetAutopilotTargetSlowing(); <br />
;Notes<br />
<br><br />
<br />
===GetDCCThrottle===<br />
{{MethodHeader|public native float GetDCCThrottle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The DCC throttle setting for this train when using DCC physics. <br />
;Syntax<br />
float throttle = GetDCCThrottle(); <br />
;Notes<br />
*The returned value will be in the range [-1.0 .. 1.0] where -1.0 is full throttle in reverse, 0.0 is stationary and 1.0 is full throttle forward.<br />
<br><br />
<br />
===GetFrontmostLocomotive===<br />
{{MethodHeader|public native Locomotive GetFrontmostLocomotive(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a reference to the frontmost locomotive in the train. <br />
;Syntax<br />
Loco = Train.GetFrontmostLocomotive(); <br />
;Notes<br />
*<font color=red>The ''front'' of the train is defined relative to the train's current heading.??</font> <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetHeadlightState===<br />
{{MethodHeader|public native bool GetHeadlightState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if headlights are turned on, false otherwise. <br />
;Syntax<br />
bool lights = train.GetHeadlightState(); <br />
;Notes<br />
*Only the frontmost locomotive will display headlighs.<br />
<br><br />
<br />
===GetLastVisitedBuildable===<br />
{{MethodHeader|public Buildable GetLastVisitedBuildable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last [[Class Buildable|Buildable]] object visited by this train, null if there have been no such visits.<br />
;Syntax<br />
Buildable buildable = train.GetLastVisitedBuildable(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedIndustry===<br />
{{MethodHeader|public Industry GetLastVisitedIndustry(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last Industry object visited by this train, null if there have been no such visits. <br />
;Syntax<br />
Industry industry = train.GetLastVisitedIndustry(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedTrack===<br />
{{MethodHeader|public Track GetLastVisitedTrack(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last track segment visited by this train. <br />
;Syntax<br />
Track track = train.GetLastVisitedTrack(); <br />
;Notes<br />
*Note that the returned value may be null. <font color=red>How is that possible?</font><br />
<br><br />
<br />
===GetHighBeams===<br />
{{MethodHeader|public bool GetHighBeams(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the frontmost locomotive's high beams are on, false otherwise. <br />
;Syntax<br />
bool High_Lights = train.GetHighBeams(); <br />
;Notes<br />
*See also [[Class Vehicle#GetHighBeams|Vehicle.GetHighBeams()]]<br />
<br><br />
<br />
===GetMaximumCouplingStressVehicle===<br />
{{MethodHeader|public native Vehicle GetMaximumCouplingStressVehicle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The Vehicle in this consist that is experiencing the greatest level of coupling stress. <br />
;Syntax<br />
Vehicle vehicle = GetMaximumCouplingStressVehicle(); <br />
;Notes<br />
<br><br />
<br />
===GetPantographState===<br />
{{MethodHeader|public native int GetPantographState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The state of the pantographs of the electric locomotives in this train. <br />
;Syntax<br />
int pantoState = train.GetPantographState(); <br />
;Notes<br />
*The returned value will be in the range [0..3] where:<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===GetPhysicsModel===<br />
{{MethodHeader|public native int GetPhysicsModel(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The mode of control chosen by the player to drive the locomotive <br />
;Syntax<br />
int Mode = train.GetPhysicsModel(); <br />
;Notes<br />
*The returned value will be :<br />
**2 = CabinControl<br />
**1 = DCCMode<br />
<br><br />
<br />
<br />
===GetSmoothedVelocity===<br />
{{MethodHeader|public native float GetSmoothedVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a smoothed velocity, intended for human consumption. <br />
;Syntax<br />
float speed = train.GetSmoothedVelocity(); <br />
;Notes<br />
*If you require an accurate velocity readout for physics operations, use [[#GetVelocity|GetVelocity()]]. <br />
<br><br />
<br />
===GetSpeedLimit===<br />
{{MethodHeader|public native float GetSpeedLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current sign posted speed limit. <br />
;Syntax<br />
float permittedSpeed = train.GetSpeedLimit(); <br />
;Notes<br />
*The speed limit is dependent on trackside signs placed in Surveyor as well as the direction of the train.<br />
*A default value applies to track that isn't sign posted.<br />
<br><br />
<br />
===GetTrackmarkDirection===<br />
{{MethodHeader|public native int GetTrackmarkDirection(TrackMark mark)}} <br />
;Parameters<br />
*'''mark''' = A reference to the Trackmark to search for.<br />
;Returned Value<br />
* One of the [[#Found Results|Found Result]] values representing the location of the given track mark relative to this train. <br />
;Syntax<br />
int location = train.GetTrackmarkDirection(trackmark); <br />
;Notes<br />
<br><br />
<br />
===GetTrainBrakes===<br />
{{MethodHeader|public native float GetTrainBrakes(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Brake Modes|Train Brake mode]] constants indicating the current state of this train's brakes. <br />
;Syntax<br />
float brakeState = train.GetTrainBrakes(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainDisplayName===<br />
{{MethodHeader|public native string GetTrainDisplayName(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*A localised display name for this train. <br />
;Syntax<br />
string trainName = train.GetTrainDisplayName(); <br />
;Notes<br />
*This will be a name Trainz has created for the consist such as "Consist 0" and will match the description shown in the Minimap view. <br />
<br><br />
<br />
===GetTrainPriorityNumber===<br />
{{MethodHeader|public native int GetTrainPriorityNumber(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Train priority value in the range [1 .. 3] <br />
;Syntax<br />
int priority = train.GetTrainPriorityNumber();<br />
;Notes<br />
*See [[#SetTrainPriority|SetTrainPriority()]] for further details. <br />
<br><br />
<br />
===GetTrainTimetable===<br />
{{MethodHeader|public TrainTimetable GetTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The TrainTimetable that the train is currently using, null if there is none.<br />
;Syntax<br />
TrainTimetable timetable = train.GetTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainVelocity===<br />
{{MethodHeader|public native float GetTrainVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity in metres per second.<br />
;Syntax<br />
float speed = train.GetTrainVelocity(); <br />
;Notes<br />
* This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display. If you want human-readable display, use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] instead.<br />
<br><br />
<br />
<br />
===GetVehicles===<br />
{{MethodHeader|public native Vehicle[ ] GetVehicles(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns an array consisting of all the vehicles making up this train. <br />
;Syntax<br />
Vehicle[] vehicles = train.GetVehicles(); <br />
;Notes<br />
*GetVehicles[0] is always the front vehicle of the train relative to the train's current heading. <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetVelocity===<br />
{{MethodHeader|public native float GetVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity. <br />
;Syntax<br />
float speed = train.GetVelocity(); <br />
;Notes<br />
*Warning! The TS10 and TS12 Train.gs scripts advise this method is buggy and to use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] or [[#GetTrainVelocity|GetTrainVelocity()]] instead.<br />
*This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display.<br />
<br><br />
<br />
===HasReachedInnerJunctionRadius===<br />
{{MethodHeader|public bool HasReachedJunctionInnerJunctionRadius(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if this train is within the inner radius of the given junction, false otherwise. <br />
;Syntax<br />
bool arrived = train.HasReachedInnerJunctionRadius(junction10); <br />
;Notes<br />
<br><br />
<br />
===HasTrainTimetable===<br />
{{MethodHeader|public bool HasTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train has an attached TrainTimetable, false otherwise. <br />
;Syntax<br />
bool timed = train.HasTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleRunning===<br />
{{MethodHeader|public bool IsScheduleRunning(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train is currently running to a Schedule, false otherwise. <br />
;Syntax<br />
bool scheduled = train.IsScheduleRunning(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleWindowVisible===<br />
{{MethodHeader|public bool IsScheduleWindowVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the schedule window for this train is currently open, false otherwise. <br />
;Syntax<br />
bool windowOpen = IsScheduleWindowVisible(); <br />
;Notes<br />
<br><br />
<br />
===IsStillInJunction===<br />
{{MethodHeader|public bool IsStillInJunction(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if the train holds a Permit for the given junction, flse otherwise. <br />
;Syntax<br />
bool inJunction = train.IsStillInJunction(junction10);<br />
;Notes<br />
<br><br />
<br />
===IsStopped===<br />
{{MethodHeader|public native bool IsStopped(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train is currently stationary, false if it is in motion. <br />
;Syntax<br />
bool moving=train.IsStopped(); <br />
;Notes<br />
<br><br />
<br />
===IsTrainBusy===<br />
{{MethodHeader|public bool IsTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train's 'busy' count is greater than zero, false otherwise. <br />
;Syntax<br />
bool busy = train.IsTrainBusy(); <br />
;Notes<br />
*Using the [[#IncTrainBusy|IncTrainBusy()]] method, any piece of script code can tag a train being busy. <br />
*The train can be untagged later by calling DecTrainBusy(). <br />
*This mechanism is mainly used by industries that are doing something with the train. <br />
*A train can be tagged as being busy more than once by calling IncTrainBusy() multiple times so different industries can tag the train. <br />
*Each time IncTrainBusy() is called, an internal busy count is incremented and if that busy count is greater than zero, the train is considered busy.<br />
<br><br />
<br />
===IsViewDetailsVisible===<br />
{{MethodHeader|public bool IsViewDetailsVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*true if the ViewDetails window for this train is visible, false otherwise. <br />
;Syntax<br />
bool visible = train.IsViewDetailsVisible(); <br />
;Notes<br />
<br><br />
<br />
===MapObjectIsInFront===<br />
{{MethodHeader|public bool MapObjectIsInFront(MapObject obj, float range)}} <br />
;Parameters<br />
*'''obj''' = MapObject to search for.<br />
*'''range''' = Maximum search distance. <br />
;Returned Value<br />
*True if the object is found within the specified distance and in front of the train, false otherwise. <br />
;Syntax<br />
bool isClose = train.MapObjectIsInFront(terminus,100.0); <br />
;Notes<br />
<br><br />
<br />
===ReleaseTrackPermits===<br />
{{MethodHeader|public void ReleaseTrackPermits(Permit[ ] permitList)}} <br />
;Parameters<br />
*'''permitList''' = Permit array containing a list of permits to release. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ReleaseTrackPermits(permitList); <br />
;Notes<br />
*This method will release any permits from the ''permitList'' array that are currently held by this train.<br />
*Any other permits in the array that are not held by this train will be ignored.<br />
<br><br />
<br />
===RunSchedule===<br />
{{MethodHeader|public thread void RunSchedule(Schedule schedule, bool loop, float delay)}} <br />
;Parameters<br />
*'''schedule''' = The Schedule that the train is to follow.<br />
*'''loop''' = False to run the schedule once, True to repeat it continuously.<br />
*'''delay''' = Time in seconds to wait before starting the schedule. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.RunSchedule(schedule,false,10.0); <br />
;Notes<br />
*See [[Class Schedule|Schedule]] for information on how to build a schedule.<br />
*Only one schedule may run on a train at a time and the user cannot control the train when it is running a schedule.<br />
*This method is a thread, so the calling code does not need to wait for it to finish and return before executing other code.<br />
<br><br />
<br />
===SetAdvisoryLimit===<br />
{{MethodHeader|public native void SetAdvisoryLimit(float speed)}} <br />
;Parameters<br />
*'''speed''' = Speed limit to set in <del>KPH</del> metres/second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAdvisoryLimit(60.0);<br />
;Notes<br />
*Sets an advisory speed limit for a script controlled train.<br />
*Use zero in the speed parameter to clear any previously imposed limit.<br />
*<font color=red>Does this really use KPH, most similar methods use MPS</font><br />
*<font color=red>Experimental evidence confirms that it's in m/s not kph or mph</font><br />
<br><br />
<br />
===SetAutopilotMode===<br />
{{MethodHeader|public native void SetAutopilotMode(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Control Modes|Train Control Mode]] constants specifying the method by which this train is controlled. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotMode(Train.CONTROL_AUTOMANUAL); <br />
;Notes<br />
<br><br />
<br />
===SetAutopilotTarget===<br />
{{MethodHeader|public native void SetAutopilotTarget(Buildable buildable, string trigger)<br>public native void SetAutopilotTarget(Trackside trackside)<br>public native void SetAutopilotTarget(Track track)<br>public native void SetAutopilotTarget(JunctionBase junction)}} <br />
;Parameters<br />
*'''buildable''' = Buildable object to use as a destination.<br />
*'''trigger''' = Attached trigger within the buildable, specified by name.<br />
*'''trackside''' = Trackside object to use as a destination.<br />
*'''track''' = Track segment to use as a destination.<br />
*'''junction''' = JunctionBase object to use as a destination.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotTarget("Kings Cross Station","trigger1"); <br />
;Notes<br />
*This method sets a destination for the autopilot to take this train to.<br />
*Objects from respective child classes such as industries, signals and trackmarks may be specified.<br />
<br><br />
<br />
===SetAutopilotTargetMinimumDistance===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumDistance(float distance)}} <br />
;Parameters<br />
*'''distance''' = The minimum distance in metres, between the train and the autopilot target, to be reached before the train will start to slow down. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train SetAutopilotTargetMinimumDistance(100.0);<br />
;Notes<br />
<br><br />
<br />
===SetAutoPilotTargetMinimumSpeed===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumSpeed(float speed)}} <br />
;Parameters<br />
*'''speed''' = Minimum speed, in metres per second, that the train should be travelling at when it reaches the Autopilot target. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutoPilotTargetMinimumSpeed(20.0); <br />
;Notes<br />
*<font color=red>The documentation seems to mean that the train should be going at 20.0 OR MORE. Shouldn't it be MaximumSpeed???</font><br />
<br><br />
<br />
===SetBail===<br />
{{MethodHeader|public native void SetBail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetBail(); <br />
;Notes<br />
*Depresses the bail control for a short period.<br />
<br><br />
<br />
===SetCouplingMask===<br />
{{MethodHeader|public void SetCouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the trains exposed couplers are allowed to couple.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetCouplingMask(Vehicle.COUPLE_NONE); // prevents this train from coupling to another in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from coupling in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDCCThrottle===<br />
{{MethodHeader|public native void SetDCCThrottle(float throttle)}} <br />
;Parameters<br />
*'''throttle''' = Float value in the range -1.0 .. 1.0 defining the throttle setting for the train when using DCC physics. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDCCThrottle(0.0); //sets the throttle to neutral. <br />
;Notes<br />
*Full speed ahead is 1.0<br />
*Maximum in reverse is -1.0<br />
*Neutral is 0.0<br />
<br><br />
<br />
===SetDecouplingMask===<br />
{{MethodHeader|public void SetDecouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the couplers are allowed to couple, applies to all of the vehicles in the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDecouplingMask(Vehicle.COUPLE_FRONT|Vehicle.COUPLE_BACK); // prevents vehicles being uncoupled from the train in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from being uncoupled in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDynamicBrakeMode===<br />
{{MethodHeader|public native void SetDynamicBrakeMode(int mode)}} <br />
;Parameters<br />
*One of the [[#Dynamic Brake States|Dynamic Brake State]] constants indicating the current state of this train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDynamicBrakeMode(Train.DYNAMIC_BRAKE_TRACTION); <br />
;Notes<br />
<br><br />
<br />
===SetFloatingLimit===<br />
{{MethodHeader|public native void SetFloatingLimit(float delta, bool enable)}} <br />
;Parameters<br />
*'''delta''' = Tolerance allowed from the posted limit in metres per second.<br />
*'''enable''' = Use true to enable messages related to floating limits, false to disable.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetFloatingLimit(5.0,true); <br />
;Notes<br />
*Sets the floating speed limit level above the sign posted limit.<br />
*The floating limit is an amount of tolerance above the current speed limit. <br />
*Messages for floating speed violations are not to be confused with regular speed limit messages.<br />
*The floating limit is monitored by the Scenario.Monitor() thread, and may be used for point deduction when speeding. It should therefore be reserved for player trains.<br />
<br><br />
<br />
===SetHandBrake===<br />
{{MethodHeader|public void SetHandBrake(bool state)}} <br />
;Parameters<br />
*'''state''' = Use true to apply the handbrake to all vehicles in this train which are not Locomotives, false to release the handbrake.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHandBrake(true); <br />
;Notes ''The use of this function did not reveal any effect on the physics of trains.''<br />
<br><br />
<br />
===SetHeadlightState===<br />
{{MethodHeader|public native void SetHeadlightState(bool lightsOn)}} <br />
;Parameters<br />
*'''lightsOn''' = True to turn the headlights on, false to turn them off. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHeadlightState(true); <br />
;Notes<br />
*This method affects only the headlights on the frontmost locomotive.<br />
<br><br />
<br />
===SetHighBeams===<br />
{{MethodHeader|public void SetHighBeams(bool value)}} <br />
;Parameters<br />
*'''value''' = True to turn on high beams, false to turn them off. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
train.SetHighBeams(true); <br />
;Notes<br />
*See also [[Class Vehicle#SetHighBeams|Vehicle.SetHighColor()]]<br />
<br><br />
<br />
===SetLastVisitedBuildable===<br />
{{MethodHeader|public void SetLastVisitedBuildable(Buildable buildable)}} <br />
;Parameters<br />
*'''buildable''' = Sets the last visited buildable to the given object. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetLastVisitedBuildable(KingsCrossStation); <br />
;Notes<br />
<br><br />
<br />
===SetManualThrottle===<br />
{{MethodHeader|public native void SetManualThrottle(int notch)}} <br />
;Parameters<br />
*'''notch''' = Value in the range 0 .. 8 to set the throttle. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetManualThrottle(5); <br />
;Notes<br />
<br><br />
<br />
===SetPantogaphState===<br />
{{MethodHeader|public native void SetPantographState(int state)}} <br />
;Parameters<br />
*'''state''' = Value in the range 0 .. 3 to set the pantographs if this train has them. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetPantographState(3); <br />
;Notes<br />
*Use one of these values for ''state'':<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===SetReverser===<br />
{{MethodHeader|public native void SetReverser(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Reverser Traction Modes|Reverser Traction Mode]] constants defining the required state of the train's reverser lever. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetReverser(Train.TRACTION_REVERSE); <br />
;Notes<br />
<br><br />
<br />
===SetTrainBrakes===<br />
{{MethodHeader|public native void SetTrainBrakes(float mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Brake States|Train Brake State]] constants defining the required state of the train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainBrakes(Train.TRAIN_BRAKE_EMERGENCY); <br />
;Notes<br />
<br><br />
<br />
===SetTrainPriorityNumber===<br />
{{MethodHeader|public native void SetTrainPriority Number(int priority)}} <br />
;Parameters<br />
*'''priority''' = Priority value in the range 1 .. 3. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainPriorityNumber(2); <br />
;Notes<br />
*All trains and track sections can be assigned a priority value in the range of [1 - 3] with the default value being 2.<br />
*The priority value is not a numerical scale of precedence, but a value for the AI driver to attempt to match.<br />
*This means the driver will ''prefer'' track sections that have a priority equal to that of the train.<br />
*Changing the priority of the train only takes affect when the driver restarts a new schedule.<br />
<br><br />
<br />
===SetTrainTimetable===<br />
{{MethodHeader|public void SetTrainTimetable(TrainTimetable timetable)}} <br />
;Parameters<br />
*'''timetable''' = Assigns the specified timetable to this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainTimetable(timetable);<br />
;Notes<br />
*This train must not already have a TrainTimetable assigned.<br />
*To ensure that this proviso is met, use [[#ClearTrainTimetabel|ClearTrainTimetable()]] prior to calling this method.<br />
*It is the responsibility of the caller to post a "TrainTimetable","Touch" message after calling this function.<br />
<br><br />
<br />
===SetVelocity===<br />
{{MethodHeader|public native void SetVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to apply to the train, in metres per second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetVelocity(0.0); // stops the train, subject to braking performance. <br />
;Notes<br />
<br><br />
<br />
===ShowInConsistMenu===<br />
{{MethodHeader|public native void ShowInConsistMenu(bool show)}} <br />
;Parameters<br />
*'''show''' = True to make this train visible to the in-game consist menu, false to hide it. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ShowInConsistMenu(false); <br />
;Notes<br />
<br><br />
<br />
===SoundHorn===<br />
{{MethodHeader|public native void SoundHorn(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SoundHorn(); <br />
;Notes<br />
*Sounds the horn or whictle for all locomotives in this train.<br />
<br><br />
<br />
===StopSchedule===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any).<br />
<br><br />
<br />
===StopScheduleAndWait===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any) and waits until the train's schedule actually stops before returning. <br />
*If the train is not running a schedule, the method returns after broadcasting a "Schedule","Touch" message, in case someone is listening for schedule messages.<br />
<br><br />
<br />
===StopTrainGently===<br />
{{MethodHeader|public native void StopTrainGently(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopTrainGently(); <br />
;Notes<br />
*Brings the train to a halt over a short time period.<br />
<br><br />
<br />
===TakePermitOnTrack===<br />
{{MethodHeader|public Permit[ ] TakePermitOnTrack(bool direction)}} <br />
;Parameters<br />
*'''direction''' = Direction relative to the train in which to take out permits. <br />
;Returned Value<br />
*An array including any permits taken which have not yet been granted to this train. Some of these permits may not yet have been granted. <br />
;Syntax<br />
Permit[] permits = train.TakePermitOnTrack(true); <br />
;Notes<br />
*Gets permits on the current track in the given direction.<br />
<br><br />
<br />
===TestTrackPermit===<br />
{{MethodHeader|public native bool TestTrackPermit(Permit permit, bool innerOnly)}} <br />
;Parameters<br />
*'''permit''' = An existing Permit object.<br />
*'''innerOnly''' = If true the method will test only the inner radius, if false the default radius of 150 metres will be used.<br />
;Returned Value<br />
*True if this train is within the track controlled by ''permit'', false otherwise. <br />
;Syntax<br />
bool ownPermit = train.TestTrackPermit(permit1,false); <br />
;Notes<br />
*The method generates an exception if the ''permit'' parameter does not refer to a track.<br />
<br><br />
<br />
===ToggleScheduleWindow===<br />
{{MethodHeader|public void ToggleScheduleWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleScheduleWindow(); <br />
;Notes<br />
*If the schedule window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, UpdateScheduleWindow() is called to create it for display.<br />
<br><br />
<br />
===ToggleViewDetailsWindow===<br />
{{MethodHeader|public void ToggleViewDetailsWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleViewDetailsWindow(); <br />
;Notes<br />
*If the ViewDetails window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, ViewDetails() is called to create it for display.<br />
<br><br />
<br />
===TrackSearch===<br />
{{MethodHeader|public native MapObject[ ] TrackSearch(bool direction, float distance)}} <br />
;Parameters<br />
*'''direction''' = Direction to search relative to the train's heading, true for forwards, false for backwards.<br />
*'''distance''' = Maximum search distance in metres. <br />
;Returned Value<br />
*An array of objects found along the track in the defined search direction, the array might be empty. <br />
;Syntax<br />
MapObject[] objects = train.TrackSearch(true,5000.0) // searches 5km forwards along the track. <br />
;Notes<br />
*Gets all of the Trackside and SceneryWithTrack objects on a length of track that is either in front of or behind this train. <br />
*Descendants of these classes are also returned.<br />
<br><br />
<br />
===TracksideIsInFront===<br />
{{MethodHeader|public bool TracksideIsInFront(Trackside obj, float range)}} <br />
;Parameters<br />
*'''obj''' = Trackside object to search for.<br />
*'''range''' = Mximum search distance. <br />
;Returned Value<br />
*True if the object is logically forward of this train, false otherwise. <br />
;Syntax<br />
bool found = train.TracksideIsInFront(signal1,500.0); <br />
;Notes<br />
<br><br />
<br />
===Turnaround===<br />
{{MethodHeader|public native void Turnaround(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Turnaround(); <br />
;Notes<br />
*Reverses the logical direction of the train, ie changes its heading.<br />
*The physical direction of the vehicles is not altered but the throttle direction is reversed.<br />
*If the camera is focused on the train in tracking view when this method is called the camera's direction of view (relative to the map) will alter through 180 degrees.<br />
<br><br />
<br />
===UpdateScheduleWindow===<br />
{{MethodHeader|public void UpdateScheduleWindow(string vehicleName)}} <br />
;Parameters<br />
*'''vehicleName''' = Name of vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateScheduleWindow("brake2"); <br />
;Notes<br />
*Updates the schedule window from the given vehicle.<br />
<br><br />
<br />
===UpdateViewDetails===<br />
{{MethodHeader|public void UpdateViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetails(vehicle);<br />
;Notes<br />
*Called by Vehicle.UpdateViewDetails() when a vehicle's load has changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===UpdateViewDetailsLocomotive===<br />
{{MethodHeader|public void UpdateViewDetailsLocomotive(void)}} <br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetailsLocomotive(vehicle);<br />
;Notes<br />
*Called by Locomotive.UpdateViewDetails() when any of the Locomotive's operating parameters have changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===ViewDetails===<br />
{{MethodHeader|public void ViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ViewDetails(vehicle); <br />
;Notes<br />
*This method is called by Vehicle.ViewDetails() when the user has requested to view the details of the consist.<br />
*It will create a Browser window listing information about the train including who the driver character is and the loads of all vehicles.<br />
<br><br />
<br />
===WasRunScheduleSuccessful===<br />
{{MethodHeader|public bool WasRunScheduleSuccessful(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the most recently run schedule was successfully, false otherwise. <br />
;Syntax<br />
train.WasRunScheduleSuccessful(); <br />
;Notes<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class TrainUtil#AreInTrain|TrainUtil.AreInTrain()]]<br><br />
[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]<br><br />
[[Class TrainUtil#IsInTrain|TrainUtil.IsInTrain()]]<br><br />
[[Class World#CreateTrain|World.CreateTrain()]]<br><br />
[[Class World#DeleteTrain|World.DeleteTrain()]]<br><br />
[[Class World#GetTrainList|World.GetTrainList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=%22Soundscript%22_container&diff=21187"Soundscript" container2019-09-07T06:21:38Z<p>Ciceronmt: /* sound-asset */</p>
<hr />
<div>{{ORP-top}}<br />
A container type tag for defining asset sounds.<br />
<br />
==Supported Tags==<br />
Each soundscript subcontainer supports the following tags. Each tag is shown here with its default value.<br />
<br />
repeat-delay 0,0<br />
distance 50,150<br />
ambient 0<br />
attachment ""<br />
nostartdelay 0<br />
priority 1<br />
trigger ""<br />
volume 1<br />
value-range 0,0<br />
sound-asset<br />
sound<br />
{<br />
}<br />
<br />
====ambient====<br />
:Type: Boolean<br />
:Default: 0<br />
:Compulsory: No<br />
:Desc: If true this is an 'ambient' sound, ambient sounds are played in 2D and do not make use of 3D positioning in the world other than to affect volume. Unlike positional sounds, ambient sounds may be stereo.<br />
<br />
====attachment====<br />
:Type: Attachment point<br />
:Default: ""<br />
:Compulsory: No<br />
:Desc: Point to attach the sound source to. Attachment points are specified in the mesh file during creation.<br />
<br />
====distance====<br />
:Type: Decimal Pair<br />
:Default: 50,150<br />
:Compulsory: No<br />
:Desc: The minimum distance (first value, in meters) defines the radius within which the sound remains at 100% volume. Beyond that distance, the sound volume will begin to decay naturally. The maximum distance (second value, in meters) defines a radius beyond which the game need no longer play the sound. This does not mean that the sound will fade to zero by the maximum distance, but rather that the sound may cut off abruptly beyond that point. It is up to the content creator to choose an appropriate maximum distance - smaller is better for performance, but overly small values may result in the sound audibly cutting off. Many Trainz editions ignore the configured maximum distance value and instead perform their own optimized calculation of the appropriate value.<br />
<br />
====nostartdelay====<br />
:Type: Boolean<br />
:Default: 0<br />
:Compulsory: No<br />
:Desc: If added and true this tag specifies that the sound will play immediately once triggered. By default sounds have a random start delay between 0 & 4 seconds. Start delay should be left active in most cases, as turning it off may cause significant audio artifacts when several identical sounds are in proximity.<br />
<br />
====priority====<br />
:Type: Integer<br />
:Default: 1<br />
:Compulsory: No<br />
:Desc: Sets the priority of the sound, if their are not enough sound channels available higher priority sounds will be played first. Defaults to 1, can be negative.<br />
<br />
====repeat-delay====<br />
:Type: Decimal Pair<br />
:Default: 0,0<br />
:Compulsory: No<br />
:Desc: Time range (in seconds) to delay, after the sound finishes playing, before playing the sound again. To set a constant delay either set both these values the same or only provide one of them, otherwise a random value between them will be chosen. When used with a trigger event (see the 'trigger' tag), a positive value indicates that the sound should not repeat, but should wait until triggered again.<br />
<br />
====sound====<br />
:Type: Container<br />
:Default: {}<br />
:Compulsory: Yes<br />
:Desc: Contains list of the sound files to play. If the list has more than one entry then one file will be picked at random from the list. The value of each tag in this container is the filename of a WAV sound file. Filenames are relative to the base directory of the asset, i.e. relative to the location of the config file.<br />
<br />
:Valid WAV files are:<br />
:* Uncompressed.<br />
:* 8 or 16 bit<br />
:* Mono, Stereo or Surround<br />
<br />
:Sampling rate can be 22kHz (22,050Hz) or 44kHz (44,100Hz). The higher sampling rate doubles the size of the file for no significant improvement in quality, and is not recommended. For some purposes there are additional requirements - for instance directional sounds must be mono.<br />
<br />
====sound-asset====<br />
:Type: KUID<br />
:Compulsory: No<br />
:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset. ''Unfortunately, it does not exist and is not supported.''<br />
<br />
====trigger====<br />
:Type: String<br />
:Default: ""<br />
:Compulsory: No<br />
:Desc: The 'trigger' tag gives your sound a name that can allow it to be played from [[Scripting|TrainzScript]] (see: Class MapObject), animations and certain predefined events. (At least one of these "predefined events" is to use the word "toggle" when including a soundscript container in the config.txt of a "MOjunction". This will make the sound fire each time the turnout is switched)<br />
<br />
====value-range====<br />
:Type: Float pair<br />
:Default: 0,0 (off)<br />
:Compulsory: No<br />
:Desc: 2 numbers, where the numbers are not the same, which set the start and end times for the sound to play. Midnight is 0.5, midday = 0.0 or 1.0. (TBD. This is a bit vague.)<br />
<br />
====volume====<br />
:Type: Decimal<br />
:Default: 1<br />
:Compulsory: No<br />
:Desc: Specifies the volume gain of the sound. Defaults to 1 (100%).<br />
<br />
<br />
==Example Config.txt==<br />
Sample [[config.txt file]] for a map asset that has a different day and night background sounds:<br />
<br />
kind map<br />
kuid <KUID:0:0><br />
soundscript<br />
{<br />
morning<br />
{<br />
ambient 1<br />
value-range 1, 0.1<br />
volume 0.3<br />
sound<br />
{<br />
0 "ctry_day_1.wav"<br />
1 "ctry_day_2.wav"<br />
}<br />
}<br />
night<br />
{<br />
ambient 1<br />
value-range 0, 0.9<br />
volume 0.3<br />
sound<br />
{<br />
0 "night_loop.wav"<br />
}<br />
}<br />
}<br />
<br />
==Categories==<br />
[[Category:Config Container|Soundscript container]]<br />
{{ORP-bot|Soundscript container}}</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=%22Soundscript%22_container&diff=21186"Soundscript" container2019-09-07T06:20:51Z<p>Ciceronmt: /* sound-asset */</p>
<hr />
<div>{{ORP-top}}<br />
A container type tag for defining asset sounds.<br />
<br />
==Supported Tags==<br />
Each soundscript subcontainer supports the following tags. Each tag is shown here with its default value.<br />
<br />
repeat-delay 0,0<br />
distance 50,150<br />
ambient 0<br />
attachment ""<br />
nostartdelay 0<br />
priority 1<br />
trigger ""<br />
volume 1<br />
value-range 0,0<br />
sound-asset<br />
sound<br />
{<br />
}<br />
<br />
====ambient====<br />
:Type: Boolean<br />
:Default: 0<br />
:Compulsory: No<br />
:Desc: If true this is an 'ambient' sound, ambient sounds are played in 2D and do not make use of 3D positioning in the world other than to affect volume. Unlike positional sounds, ambient sounds may be stereo.<br />
<br />
====attachment====<br />
:Type: Attachment point<br />
:Default: ""<br />
:Compulsory: No<br />
:Desc: Point to attach the sound source to. Attachment points are specified in the mesh file during creation.<br />
<br />
====distance====<br />
:Type: Decimal Pair<br />
:Default: 50,150<br />
:Compulsory: No<br />
:Desc: The minimum distance (first value, in meters) defines the radius within which the sound remains at 100% volume. Beyond that distance, the sound volume will begin to decay naturally. The maximum distance (second value, in meters) defines a radius beyond which the game need no longer play the sound. This does not mean that the sound will fade to zero by the maximum distance, but rather that the sound may cut off abruptly beyond that point. It is up to the content creator to choose an appropriate maximum distance - smaller is better for performance, but overly small values may result in the sound audibly cutting off. Many Trainz editions ignore the configured maximum distance value and instead perform their own optimized calculation of the appropriate value.<br />
<br />
====nostartdelay====<br />
:Type: Boolean<br />
:Default: 0<br />
:Compulsory: No<br />
:Desc: If added and true this tag specifies that the sound will play immediately once triggered. By default sounds have a random start delay between 0 & 4 seconds. Start delay should be left active in most cases, as turning it off may cause significant audio artifacts when several identical sounds are in proximity.<br />
<br />
====priority====<br />
:Type: Integer<br />
:Default: 1<br />
:Compulsory: No<br />
:Desc: Sets the priority of the sound, if their are not enough sound channels available higher priority sounds will be played first. Defaults to 1, can be negative.<br />
<br />
====repeat-delay====<br />
:Type: Decimal Pair<br />
:Default: 0,0<br />
:Compulsory: No<br />
:Desc: Time range (in seconds) to delay, after the sound finishes playing, before playing the sound again. To set a constant delay either set both these values the same or only provide one of them, otherwise a random value between them will be chosen. When used with a trigger event (see the 'trigger' tag), a positive value indicates that the sound should not repeat, but should wait until triggered again.<br />
<br />
====sound====<br />
:Type: Container<br />
:Default: {}<br />
:Compulsory: Yes<br />
:Desc: Contains list of the sound files to play. If the list has more than one entry then one file will be picked at random from the list. The value of each tag in this container is the filename of a WAV sound file. Filenames are relative to the base directory of the asset, i.e. relative to the location of the config file.<br />
<br />
:Valid WAV files are:<br />
:* Uncompressed.<br />
:* 8 or 16 bit<br />
:* Mono, Stereo or Surround<br />
<br />
:Sampling rate can be 22kHz (22,050Hz) or 44kHz (44,100Hz). The higher sampling rate doubles the size of the file for no significant improvement in quality, and is not recommended. For some purposes there are additional requirements - for instance directional sounds must be mono.<br />
<br />
====sound-asset====<br />
:Type: KUID<br />
:Compulsory: No<br />
:Desc: The asset to source the sound files from. Allows the creation of "sound library" assets, so that sound files can be shared between multiple other assets. Defaults to the current asset.<br />
'''Unfortunately, it does not exist and is not supported.'''<br />
<br />
====trigger====<br />
:Type: String<br />
:Default: ""<br />
:Compulsory: No<br />
:Desc: The 'trigger' tag gives your sound a name that can allow it to be played from [[Scripting|TrainzScript]] (see: Class MapObject), animations and certain predefined events. (At least one of these "predefined events" is to use the word "toggle" when including a soundscript container in the config.txt of a "MOjunction". This will make the sound fire each time the turnout is switched)<br />
<br />
====value-range====<br />
:Type: Float pair<br />
:Default: 0,0 (off)<br />
:Compulsory: No<br />
:Desc: 2 numbers, where the numbers are not the same, which set the start and end times for the sound to play. Midnight is 0.5, midday = 0.0 or 1.0. (TBD. This is a bit vague.)<br />
<br />
====volume====<br />
:Type: Decimal<br />
:Default: 1<br />
:Compulsory: No<br />
:Desc: Specifies the volume gain of the sound. Defaults to 1 (100%).<br />
<br />
<br />
==Example Config.txt==<br />
Sample [[config.txt file]] for a map asset that has a different day and night background sounds:<br />
<br />
kind map<br />
kuid <KUID:0:0><br />
soundscript<br />
{<br />
morning<br />
{<br />
ambient 1<br />
value-range 1, 0.1<br />
volume 0.3<br />
sound<br />
{<br />
0 "ctry_day_1.wav"<br />
1 "ctry_day_2.wav"<br />
}<br />
}<br />
night<br />
{<br />
ambient 1<br />
value-range 0, 0.9<br />
volume 0.3<br />
sound<br />
{<br />
0 "night_loop.wav"<br />
}<br />
}<br />
}<br />
<br />
==Categories==<br />
[[Category:Config Container|Soundscript container]]<br />
{{ORP-bot|Soundscript container}}</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Texture-Replacement_Effect&diff=21159Texture-Replacement Effect2019-09-05T18:51:59Z<p>Ciceronmt: /* Supported Tags */</p>
<hr />
<div>The Texture-Replacement effect kind is a named effect container within a [["mesh-table" Container]]. It can be used within the load subcontainer to provide alternative textures for bulk loads in wagons. The following tags are supported: <br />
<br />
==Supported Tags==<br />
Each texture-replacement subcontainer supports the following tags. <br />
kind "texture-replacement"<br />
texture "<texture name>"<br />
<br />
The name of the texture-replacement effects subcontainer is selected by the content developer. It may be used as a reference in a script file to identify a specific effect.<br />
<br />
===kind===<br />
String. Required. No default.<br />
"texture-replacement"<br />
<br />
===texture===<br />
String. Required. No default.<br />
The name of the texture that is to be replaced. This is the name of the texture file as used in the asset's config.txt, without the .txt extension. For instance, if the texture to be replaced is identified in the 'load-map.texture.txt' file, then the texture tag in the effect container is "load-map.texture".<br />
<br />
A texture-replacement effect is often used when the texture of an asset should be changed during game play. For instance, when the load texture is to be replaced then this texture will be replaced by the texture contained in the product referenced in the current active product queue, as defined by the allowed-categories subcontainer in the queue. For instance, if a coal hopper loads at an industry asset that produces a bulk-load other than its default load (eg woodchips at a lumbermill), then the woodchip product texture will replace the default coal product texture.<br />
<br />
A texture-replacement effect is also used when an asset is reskinned using an alias. In this case the texture replacement occurs when the asset is created - the texture of the aliased asset is replaced with a texture from the reskin asset.<br />
<br />
==Example texture-replace subcontainer==<br />
effects {<br />
product-texture {<br />
kind "texture-replacement"<br />
texture "load_map.texture"<br />
}<br />
}<br />
<br />
==Performance Considerations==<br />
<br />
Texture-replacement can be used by content developers to achieve a range of interesting and novel scripted effects, though there are some considerations that should be noted. Whether performance will be adversely affected is dependant upon numerous variables. When it comes to predicting the performance impact of a particular texture-replacement implementation, the only reliable answer is: test it and see.<br />
<br />
===potential issues===<br />
<br />
* it's likely to load both the original and the replacement textures, so you may pay twice the loading cost and twice the RAM cost.<br />
<br />
* in older versions of the game, you might end up with the game freezing while it loads in the replacement texture.<br />
<br />
* in newer versions of the game, it shouldn't freeze but it's feasible that you might end up with the old textures visible on screen until the new textures load.<br />
<br />
* it likely negates any texture preloading, so you're more likely to end up with low-res textures visible to the user.<br />
<br />
* it likely disables a bunch of shared-material optimisations, so if you have multiple copies of the same object around then you'll now be paying one cost per instance rather than one cost per the whole set.<br />
<br />
In newer versions some of that can be mitigated:<br />
<br />
* as long as all of the textures look fairly similar, swapping from one to another once already visible isn't a major concern as long as it happens at lower LODs, which it generally will during actual game play.<br />
<br />
* texture streaming makes it more likely that the double-texture costs will be minimal. You can probably further assist this by using smaller placeholder textures to start with i.e. the textures loaded as part of the mesh are kept to 32x32 or something small like that.<br />
<br />
<br />
[[Category:Config Container]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Texture-Replacement_Effect&diff=21158Texture-Replacement Effect2019-09-05T18:51:26Z<p>Ciceronmt: /* name */</p>
<hr />
<div>The Texture-Replacement effect kind is a named effect container within a [["mesh-table" Container]]. It can be used within the load subcontainer to provide alternative textures for bulk loads in wagons. The following tags are supported: <br />
<br />
==Supported Tags==<br />
Each texture-replacement subcontainer supports the following tags. <br />
kind "texture-replacement"<br />
name ""<br />
texture "<texture name>"<br />
<br />
The name of the texture-replacement effects subcontainer is selected by the content developer. It may be used as a reference in a script file to identify a specific effect.<br />
<br />
===kind===<br />
String. Required. No default.<br />
"texture-replacement"<br />
<br />
===texture===<br />
String. Required. No default.<br />
The name of the texture that is to be replaced. This is the name of the texture file as used in the asset's config.txt, without the .txt extension. For instance, if the texture to be replaced is identified in the 'load-map.texture.txt' file, then the texture tag in the effect container is "load-map.texture".<br />
<br />
A texture-replacement effect is often used when the texture of an asset should be changed during game play. For instance, when the load texture is to be replaced then this texture will be replaced by the texture contained in the product referenced in the current active product queue, as defined by the allowed-categories subcontainer in the queue. For instance, if a coal hopper loads at an industry asset that produces a bulk-load other than its default load (eg woodchips at a lumbermill), then the woodchip product texture will replace the default coal product texture.<br />
<br />
A texture-replacement effect is also used when an asset is reskinned using an alias. In this case the texture replacement occurs when the asset is created - the texture of the aliased asset is replaced with a texture from the reskin asset. <br />
<br />
==Example texture-replace subcontainer==<br />
effects {<br />
product-texture {<br />
kind "texture-replacement"<br />
texture "load_map.texture"<br />
}<br />
}<br />
<br />
==Performance Considerations==<br />
<br />
Texture-replacement can be used by content developers to achieve a range of interesting and novel scripted effects, though there are some considerations that should be noted. Whether performance will be adversely affected is dependant upon numerous variables. When it comes to predicting the performance impact of a particular texture-replacement implementation, the only reliable answer is: test it and see.<br />
<br />
===potential issues===<br />
<br />
* it's likely to load both the original and the replacement textures, so you may pay twice the loading cost and twice the RAM cost.<br />
<br />
* in older versions of the game, you might end up with the game freezing while it loads in the replacement texture.<br />
<br />
* in newer versions of the game, it shouldn't freeze but it's feasible that you might end up with the old textures visible on screen until the new textures load.<br />
<br />
* it likely negates any texture preloading, so you're more likely to end up with low-res textures visible to the user.<br />
<br />
* it likely disables a bunch of shared-material optimisations, so if you have multiple copies of the same object around then you'll now be paying one cost per instance rather than one cost per the whole set.<br />
<br />
In newer versions some of that can be mitigated:<br />
<br />
* as long as all of the textures look fairly similar, swapping from one to another once already visible isn't a major concern as long as it happens at lower LODs, which it generally will during actual game play.<br />
<br />
* texture streaming makes it more likely that the double-texture costs will be minimal. You can probably further assist this by using smaller placeholder textures to start with i.e. the textures loaded as part of the mesh are kept to 32x32 or something small like that.<br />
<br />
<br />
[[Category:Config Container]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_MeshObject&diff=21157Class MeshObject2019-09-05T18:50:34Z<p>Ciceronmt: /* SetFXTextureReplacement */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]]<br />
***[[Class GameObject|GameObject]]<br />
****[[Class PropertyObject|PropertyObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
*****MeshObject<br />
<br><br />
<br />
This is a base class for [[class Asset|Asset]] based game objects that have meshes, effects, animations and particles. Interface methods to deal with these are provided so things like showing or hiding a mesh, attaching a mesh to an attachment point or controlling an animation can be done from a script.<br />
<br />
For animation Trainz interpolates between key frames. This means an intermediate animation frame is calculated dynamically to be-in-synch with the game's framerate.<br />
<br />
Trainzscript is an interpreted scripting language intended to be used to monitor and react to events in the Trainz world, not to perform sophisticated real-time animation tasks. Using a script to start an animation in response to an event in a thread is reasonable. However trying to control animation tightly down to short intervals is likely to provide unsatisfactory results and to adversely affect overall performance of the game.<br />
<br />
<br />
<br />
<br />
<br />
==MeshObject Messages==<br />
Messages related to MeshObject assets:<br />
*[[Animation-Event Message]]<br />
*[[pfx Message]]<br />
<br><br />
<br />
==GetFXAttachment==<br />
{{MethodHeader|public native MeshObject GetFXAttachment(string effect)}}<br />
;Parameters<br />
*'''effect''' = name of the mesh effect to query. <br />
;Returned Value<br />
*Returns a reference to the MeshObject currently attached to the named effect.<br />
;Syntax<br />
MeshObject attachment = GetFXAttachment("coupler");<br />
;Notes<br />
*The method returns null if the effect is unoccupied.<br />
<br><br />
<br />
==GetMeshAnimationFrame==<br />
{{MethodHeader|public native float GetMeshAnimationFrame(string mesh)'''}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be queried.<br />
;Returned Value<br />
*Current fame of the animation file within the specified mesh container.<br />
;Syntax<br />
float height = GetMeshAnimationFrame("zPosition")<br />
;Notes<br />
*Note that the returned value is likely to be an interpreted floating point value.<br />
<br><br />
<br />
==GetMeshAnimationFrameCount==<br />
{{MethodHeader|public native float GetMeshAnimationFrameCount(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be queried.<br />
;Returned Value<br />
*The number of frames in the specified animation.<br />
;Syntax<br />
float positions = GetMeshAnimationFrameCount("lever");<br />
;Notes<br />
*Note that the returned value is a float rather than an integer.<br />
<br><br />
<br />
==GetTextureSelfIlluminationState==<br />
{{MethodHeader|public native bool GetTextureSelfIlluminationState(string texture)'''}}<br />
;Parameters<br />
*'''texture''' = root name of ''*.texture.text'' file to query.<br />
;Returned Value<br />
*Returns true if the specified texture has self illumination set.<br />
;Syntax<br />
bool isEmissive = GetTextureSelfIlluminationState("texture");<br />
;Notes<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==HasMesh==<br />
{{MethodHeader|public native bool HasMesh(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be queried.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (HasMesh("ventilation")) StartMeshAnimationLoop("fans");<br />
;Notes<br />
*<br />
<br><br />
<br />
==SetFXAnimationState==<br />
{{MethodHeader|public native void SetFXAnimationState(string effect, bool state)}}<br />
;Parameters<br />
*'''effect''' = name of attached-animation effect containing the animation to play.<br />
*'''state''' = true to start the animation loop, false to stop.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
if (gateClosed) SetFXAnimationState("gate",false);<br />
;Notes<br />
<br><br />
<br />
==SetFXAttachment==<br />
{{MethodHeader|public native MeshObject SetFXAttachment(string effect, Asset asset)'''}}<br />
;Parameters<br />
*'''effect''' = effect containing the attachment to be manipulated.<br />
*'''asset''' = mesh asset to attach to the effect. If asset is null any existing asset will be removed and nothing will be added.<br />
;Returned Value<br />
*Returns a reference to the MeshObject which has been attached to the named effect. If the mesh asset isn't "kind mesh", returns null.<br />
;Syntax<br />
MeshObject lamp = SetFXAttachment("lamp0",redlamp);<br />
;Notes<br />
*Returns null if the effect is unoccupied when the method returns.<br />
<br><br />
<br />
==SetFXCoronaTexture==<br />
{{MethodHeader|public native void SetFXCoronaTexture(string effect, Asset texture)}}<br />
;Parameters<br />
*'''effect''' = effect containg the corona to be manipulated.<br />
*'''asset''' = corona texture asset to attach to the effect. If asset is null the corona will be turned off.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXCoronaTexture("stopLight",redCorona);<br />
;Notes<br />
*Other corona parameters such as frequency and size are defined in ''config.txt'' and cannot be altered by script code.<br />
<br><br />
<br />
==SetFXNameText==<br />
{{MethodHeader|public native void SetFXNameText(string effect, string text)}}<br />
;Parameters<br />
*'''effect''' = effect containg the name effect to be changed.<br />
*'''text''' = new string value.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXNameText("home","Shangri-La");<br />
;Notes<br />
*Method will not accept an empty string in the ''text'' parameter.<br />
<br><br />
<br />
==SetFXTextureReplacement==<br />
{{MethodHeader|public native void SetFXTextureReplacement(string effect, Asset textureGroup, int index)}}<br />
;Parameters<br />
*'''effect''' = texture-replacement effect to be changed.<br />
*'''textureGroup''' = reference to texture group asset which is the source of the texture to be applied.<br />
*'''index''' = index into ''textures'' table of texture-group indicating which texture to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetFXTextureReplacement("load",loadTextures,5); // applies texture 5 from texture-group<br />
SetFXTextureReplacement("load",null,0); // clears the effect, reinstating the texture defined in the asset.<br />
;Notes<br />
*Use null in the textureGroup parameter to turn texture replacement off.<br />
<br><br />
<br />
==SetMesh==<br />
{{MethodHeader|public native void SetMesh(string mesh, float fadeDuration)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be displayed.<br />
*'''fadeDuration''' = period in seconds during which mesh visibility will be faded in or out.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMesh("default",0.5);<br />
;Notes<br />
*Shows the specified mesh and hides all other meshes.<br />
*If fadeDuration is 0.0 the mesh transition will be instantaneous.<br />
<br><br />
<br />
==SetMeshAnimationFrame==<br />
{{MethodHeader|public native void SetMeshAnimationFrame(string mesh, float frame)<br><br />
public native void SetMeshAnimationFrame(string mesh, float frame, float period)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be manipulated.<br />
*'''frame''' = the frame position to which the animation is to be moved, this may be an interpolated value.<br />
*'''period''' = the period over which the animation will be moved from its current position to the newly specified point.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationFrame("default",5.0); // move the animation to frame 5 instantaneously<br />
SetMeshAnimationFrame("default",5.0,2.0); // move the animation to frame 5 over 2 seconds<br />
;Notes<br />
*Moves the specified animation to the specified frame.<br />
*For the first variant the transition is instant.<br />
*For the second variant the transition will complete during the specified period.<br />
<br><br />
<br />
==SetMeshAnimationSpeed==<br />
{{MethodHeader|public native void SetMeshAnimationSpeed(string mesh, float speed)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be manipulated.<br />
*'''speed''' = multiplication factor to apply to the original animation speed.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationSpeed("fans",2.0); // run fans at double speed<br />
SetMeshAnimationSpeed("fans",-1.0); // run fans backwards at original speed<br />
;Notes<br />
*Modifies the speed at which the animation is played.<br />
*The original speed is multiplied by the new speed factor.<br />
*Use negative values to make the animation run in reverse.<br />
*It is ''not'' compatible with SetMeshAnimationState function for the same mesh. <br />
<br><br />
<br />
==SetMeshAnimationState==<br />
{{MethodHeader|public native void SetMeshAnimationState(string mesh, bool state)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be played.<br />
*'''state''' = the direction in which the file is to be played, true for forwards, false for backwards.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshAnimationState("door",true); // opens the door<br />
SetMeshAnimationState("door",false); // closes the door<br />
;Notes<br />
*This method plays animations and is best suited to those which have defined start and end points such as the opening and closing of a gate or door.<br />
*If ''state'' is true the animation plays forwards from its current position to the last frame. If the current position is already at the last frame the call has no effect.<br />
*If ''state'' is false the animation plays backwards from its current position to the first frame. If the current position is already at the first frame the call has no effect.<br />
<br><br />
<br />
==SetMeshVisible==<br />
{{MethodHeader|public native void SetMeshVisible(string mesh, bool visible, float fadeDuration)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh to be displayed.<br />
*'''visible''' = true to show the mesh, false to hide it.<br />
*'''fadeDuration''' = period in seconds during which mesh visibility will be faded in or out.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetMeshVisible("driver", false, 1.0);<br />
;Notes<br />
*If fadeDuration is 0.0 the mesh transition will be instantaneous.<br />
<br><br />
<br />
==SetTextureSelfIllumination==<br />
{{MethodHeader|public native void SetTextureSelfIllumination(string texture, float r, float g, float b)}}<br />
;Parameters<br />
*'''texture''' = root name of ''*.texture.text'' file to query.<br />
*'''r,g,b''' = red green and blue components of self illumination value to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetTextureSelfIllumination("interior",0.5,0.5,0.5);<br />
;Notes<br />
*Applies a [[material emissive color]] to materials that use the texture, using the red, green and blue components specified.<br />
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.<br />
<br><br />
<br />
==StartMeshAnimationLoop==<br />
{{MethodHeader|public native void StartMeshAnimationLoop(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be played.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StartMeshAnimationLoop("windmill");<br />
;Notes<br />
*This method plays animations and is best suited to those which are designed to run in a continuous loop.<br />
*The speed of the animation can be altered using [[#SetMeshAnimationSpeed|SetMeshAnimationSpeed()]]<br />
*Using [[#SetMeshAnimationSpeed|SetMeshAnimationSpeed()]] with a negative value will cause the animation to play in reverse.<br />
*[[#StopMeshAnimation|StopMeshAnimation()]] will halt the animation.<br />
<br><br />
<br />
==StopMeshAnimation==<br />
{{MethodHeader|public native void StopMeshAnimation(string mesh)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the animation file to be stopped.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
StopMeshAnimation("default");<br />
;Notes<br />
*Turns animation off for the specified mesh.<br />
<br><br />
<br />
==SwapTextureOnMesh==<br />
{{MethodHeader|public native void SwapTextureOnMesh(string mesh, string oldTexture, string newTexture)}}<br />
;Parameters<br />
*'''mesh''' = the name of the mesh or submesh container which includes the texture to be changed.<br />
*'''oldTexture''' = the original ''*.texture.txt'' file to use as the source of the transition.<br />
*'''newTexture''' = the new ''*.texture.txt'' file to apply.<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SwapTextureOnMesh("left-passenger-door","gwr","lms");<br />
;Notes<br />
*'''Obsolete: Use SetFXTextureReplacementTexture instead.'''<br />
*Swap one texture against another texture on specified mesh.<br />
*Similar to texture-replacement effects, but without the need for an extra texture asset. <br />
*'''possible bug''' Texture names in the .im file must be lower case for this function to work properly.<br />
<br><br />
<br />
==Code Examples==<br />
<br />
<br />
<br />
==Related Methods==<br />
<br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Texture-Replacement_Effect&diff=21156Texture-Replacement Effect2019-09-05T18:16:02Z<p>Ciceronmt: /* name */</p>
<hr />
<div>The Texture-Replacement effect kind is a named effect container within a [["mesh-table" Container]]. It can be used within the load subcontainer to provide alternative textures for bulk loads in wagons. The following tags are supported: <br />
<br />
==Supported Tags==<br />
Each texture-replacement subcontainer supports the following tags. <br />
kind "texture-replacement"<br />
name ""<br />
texture "<texture name>"<br />
<br />
The name of the texture-replacement effects subcontainer is selected by the content developer. It may be used as a reference in a script file to identify a specific effect.<br />
<br />
===kind===<br />
String. Required. No default.<br />
"texture-replacement"<br />
<br />
===name===<br />
String. Not required. <br />
This tag provides an accessible name for the container that can be used by scripts. It may be left blank so that a script can use the tag for temporary storage. <br />
''Obsolete! Don't use.''<br />
<br />
===texture===<br />
String. Required. No default.<br />
The name of the texture that is to be replaced. This is the name of the texture file as used in the asset's config.txt, without the .txt extension. For instance, if the texture to be replaced is identified in the 'load-map.texture.txt' file, then the texture tag in the effect container is "load-map.texture".<br />
<br />
A texture-replacement effect is often used when the texture of an asset should be changed during game play. For instance, when the load texture is to be replaced then this texture will be replaced by the texture contained in the product referenced in the current active product queue, as defined by the allowed-categories subcontainer in the queue. For instance, if a coal hopper loads at an industry asset that produces a bulk-load other than its default load (eg woodchips at a lumbermill), then the woodchip product texture will replace the default coal product texture.<br />
<br />
A texture-replacement effect is also used when an asset is reskinned using an alias. In this case the texture replacement occurs when the asset is created - the texture of the aliased asset is replaced with a texture from the reskin asset. <br />
<br />
==Example texture-replace subcontainer==<br />
effects {<br />
product-texture {<br />
kind "texture-replacement"<br />
texture "load_map.texture"<br />
}<br />
}<br />
<br />
==Performance Considerations==<br />
<br />
Texture-replacement can be used by content developers to achieve a range of interesting and novel scripted effects, though there are some considerations that should be noted. Whether performance will be adversely affected is dependant upon numerous variables. When it comes to predicting the performance impact of a particular texture-replacement implementation, the only reliable answer is: test it and see.<br />
<br />
===potential issues===<br />
<br />
* it's likely to load both the original and the replacement textures, so you may pay twice the loading cost and twice the RAM cost.<br />
<br />
* in older versions of the game, you might end up with the game freezing while it loads in the replacement texture.<br />
<br />
* in newer versions of the game, it shouldn't freeze but it's feasible that you might end up with the old textures visible on screen until the new textures load.<br />
<br />
* it likely negates any texture preloading, so you're more likely to end up with low-res textures visible to the user.<br />
<br />
* it likely disables a bunch of shared-material optimisations, so if you have multiple copies of the same object around then you'll now be paying one cost per instance rather than one cost per the whole set.<br />
<br />
In newer versions some of that can be mitigated:<br />
<br />
* as long as all of the textures look fairly similar, swapping from one to another once already visible isn't a major concern as long as it happens at lower LODs, which it generally will during actual game play.<br />
<br />
* texture streaming makes it more likely that the double-texture costs will be minimal. You can probably further assist this by using smaller placeholder textures to start with i.e. the textures loaded as part of the mesh are kept to 32x32 or something small like that.<br />
<br />
<br />
[[Category:Config Container]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Texture-Replacement_Effect&diff=21155Texture-Replacement Effect2019-09-05T18:15:28Z<p>Ciceronmt: /* name */</p>
<hr />
<div>The Texture-Replacement effect kind is a named effect container within a [["mesh-table" Container]]. It can be used within the load subcontainer to provide alternative textures for bulk loads in wagons. The following tags are supported: <br />
<br />
==Supported Tags==<br />
Each texture-replacement subcontainer supports the following tags. <br />
kind "texture-replacement"<br />
name ""<br />
texture "<texture name>"<br />
<br />
The name of the texture-replacement effects subcontainer is selected by the content developer. It may be used as a reference in a script file to identify a specific effect.<br />
<br />
===kind===<br />
String. Required. No default.<br />
"texture-replacement"<br />
<br />
===name===<br />
String. Not required. <br />
This tag provides an accessible name for the container that can be used by scripts. It may be left blank so that a script can use the tag for temporary storage. Obsolete! Don't use.<br />
<br />
===texture===<br />
String. Required. No default.<br />
The name of the texture that is to be replaced. This is the name of the texture file as used in the asset's config.txt, without the .txt extension. For instance, if the texture to be replaced is identified in the 'load-map.texture.txt' file, then the texture tag in the effect container is "load-map.texture".<br />
<br />
A texture-replacement effect is often used when the texture of an asset should be changed during game play. For instance, when the load texture is to be replaced then this texture will be replaced by the texture contained in the product referenced in the current active product queue, as defined by the allowed-categories subcontainer in the queue. For instance, if a coal hopper loads at an industry asset that produces a bulk-load other than its default load (eg woodchips at a lumbermill), then the woodchip product texture will replace the default coal product texture.<br />
<br />
A texture-replacement effect is also used when an asset is reskinned using an alias. In this case the texture replacement occurs when the asset is created - the texture of the aliased asset is replaced with a texture from the reskin asset. <br />
<br />
==Example texture-replace subcontainer==<br />
effects {<br />
product-texture {<br />
kind "texture-replacement"<br />
texture "load_map.texture"<br />
}<br />
}<br />
<br />
==Performance Considerations==<br />
<br />
Texture-replacement can be used by content developers to achieve a range of interesting and novel scripted effects, though there are some considerations that should be noted. Whether performance will be adversely affected is dependant upon numerous variables. When it comes to predicting the performance impact of a particular texture-replacement implementation, the only reliable answer is: test it and see.<br />
<br />
===potential issues===<br />
<br />
* it's likely to load both the original and the replacement textures, so you may pay twice the loading cost and twice the RAM cost.<br />
<br />
* in older versions of the game, you might end up with the game freezing while it loads in the replacement texture.<br />
<br />
* in newer versions of the game, it shouldn't freeze but it's feasible that you might end up with the old textures visible on screen until the new textures load.<br />
<br />
* it likely negates any texture preloading, so you're more likely to end up with low-res textures visible to the user.<br />
<br />
* it likely disables a bunch of shared-material optimisations, so if you have multiple copies of the same object around then you'll now be paying one cost per instance rather than one cost per the whole set.<br />
<br />
In newer versions some of that can be mitigated:<br />
<br />
* as long as all of the textures look fairly similar, swapping from one to another once already visible isn't a major concern as long as it happens at lower LODs, which it generally will during actual game play.<br />
<br />
* texture streaming makes it more likely that the double-texture costs will be minimal. You can probably further assist this by using smaller placeholder textures to start with i.e. the textures loaded as part of the mesh are kept to 32x32 or something small like that.<br />
<br />
<br />
[[Category:Config Container]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Cabin&diff=21154Class Cabin2019-09-05T16:59:21Z<p>Ciceronmt: /* SetCabLightIntensity */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******Bogey<br />
<br />
<br><br />
*This class is the interface class used for cabins and interior assets in Trainz.<br />
*From the scripting perspective, a Cabin is mainly a collection of controls. <br />
*What controls the cabin has depends on the configuration of the asset. <br />
*If a cabin asset is to have custom scripted features, it's script class will need to be derived from this one. <br />
*The types of controls a cabin has is locomotive specific hence this class is the interface and not a cabin implementation.<br />
*The DefaultLocomotiveCabin and DefaultSteamCabin classes provide basic default Cabin implementations.<br />
<br><br />
<br />
===Attach===<br />
{{MethodHeader|public void Attach(GameObject owner)}}<br />
;Parameters<br />
*'''owner''' = GameObjet to which the cabin will be attached, normally a Locomotive.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*A callback method used by the game engine when it is about to attach this cabin to an object.<br />
*A cabin is destroyed when it is no longer needed and re-created by Trainz later on if needed again.<br />
*This method is where you should restore any saved cabin control settings.<br />
*A Locomotive object has a cache of cabin control settings that can be saved to when the cabin is updated (see [[Class Locomotive#GetCabinData|Locomotive.GetCabinData()]])<br />
*The programmer will need to update and make use of cabin settings in their implementation of this method.<br />
<br><br />
<br />
===FireAddCoal===<br />
{{MethodHeader|public native bool FireAddCoal(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if coal is added successfully, false otherwise.<br />
;Syntax<br />
FireAddCoal();<br />
;Notes<br />
<br><br />
<br />
===GetControls===<br />
{{MethodHeader|public native CabinControl[ ] GetControls(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of the CabinControl objects applicable to the cabin.<br />
;Syntax<br />
CabinControl[] controls = GetControls();<br />
;Notes<br />
<br><br />
<br />
===GetNamedControl===<br />
{{MethodHeader|public native CabinControl GetNamedControl(string name)}}<br />
;Parameters<br />
*'''name''' = Name of control to return.<br />
;Returned Value<br />
*A reference to the named control if it exists, null otherwise.<br />
;Syntax<br />
CabinControl control = GetNamedControl("brake");<br />
;Notes<br />
<br><br />
<br />
===GetParentObject===<br />
{{MethodHeader|public native GameObject GetParentObject(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to the parent GameObject to which the cabin is attached, usually a Locomotive.<br />
;Syntax<br />
Locomotive loco = cast<Locomotive>cabin.GetParentObject();<br />
;Notes<br />
<br><br />
<br />
===IsActive===<br />
{{MethodHeader|public native bool IsActive(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the cabin is currently active, false otherwise.<br />
;Syntax<br />
bool cabinExists = cabin.IsActive();<br />
;Notes<br />
<br><br />
<br />
===SetCabLightIntensity===<br />
{{MethodHeader|public native void SetCabLightIntensity(float intensity)}}<br />
;Parameters<br />
*''intensity''' = A normalised lighting level in the range 0.0..1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabLightIntensity(0.5);<br />
;Notes <br />
''It works? In build 4.3 no changes are visible. Should the texture glow turn on?''<br />
<br><br />
<br />
===Update===<br />
{{MethodHeader|public void Update(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Notes<br />
*This is a callback method used by Trainz to update the cabin object.<br />
*This implementation is empty so the script programmer must implement it if they want their cabin's controls to be updated.<br />
*If you want to keep the controls in the cabin up to date and to accurately reflect the current state of the locomotive, you will need to perform those updates from an overridden implementation of this method.<br />
*This is mostly a case of querying the current status of the host locomotive and applying it to the matching control.<br />
*The speedometer in the cab for instance should be updated based on the loco's current velocity.<br />
<br><br />
<br />
===UserPressKey===<br />
{{MethodHeader|public void UserPressKey(string keyName)}}<br />
;Parameters<br />
*'''keyName''' = The name of the key pressed.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*This is a callback method used by Trainz when the user presses a key.<br />
*The default Cabin implementation does not handle any keystrokes. You must do so in your own overridden implementation.<br />
<br><br />
<br />
===UserSetControl===<br />
{{MethodHeader|public void UserSetControl(CabinControl control, float value)}}<br />
;Parameters<br />
*'''control''' = The control that the user has operated.<br />
*'''value''' = The value to assign as a result of the user's action.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*This is a callback method used by Trainz when the user presses a key.<br />
*You should override this method to apply the settings selected by the user.<br />
<br><br />
<br />
==Related Methods==<br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Cabin&diff=21153Class Cabin2019-09-05T16:58:30Z<p>Ciceronmt: /* SetCabLightIntensity */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****[[Class TrainzGameObject|TrainzGameObject]]<br />
****[[Class PropertyObject|PropertyObject]] *<br />
*****[[Class MeshObject|MeshObject]]<br />
******Bogey<br />
<br />
<br><br />
*This class is the interface class used for cabins and interior assets in Trainz.<br />
*From the scripting perspective, a Cabin is mainly a collection of controls. <br />
*What controls the cabin has depends on the configuration of the asset. <br />
*If a cabin asset is to have custom scripted features, it's script class will need to be derived from this one. <br />
*The types of controls a cabin has is locomotive specific hence this class is the interface and not a cabin implementation.<br />
*The DefaultLocomotiveCabin and DefaultSteamCabin classes provide basic default Cabin implementations.<br />
<br><br />
<br />
===Attach===<br />
{{MethodHeader|public void Attach(GameObject owner)}}<br />
;Parameters<br />
*'''owner''' = GameObjet to which the cabin will be attached, normally a Locomotive.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*A callback method used by the game engine when it is about to attach this cabin to an object.<br />
*A cabin is destroyed when it is no longer needed and re-created by Trainz later on if needed again.<br />
*This method is where you should restore any saved cabin control settings.<br />
*A Locomotive object has a cache of cabin control settings that can be saved to when the cabin is updated (see [[Class Locomotive#GetCabinData|Locomotive.GetCabinData()]])<br />
*The programmer will need to update and make use of cabin settings in their implementation of this method.<br />
<br><br />
<br />
===FireAddCoal===<br />
{{MethodHeader|public native bool FireAddCoal(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if coal is added successfully, false otherwise.<br />
;Syntax<br />
FireAddCoal();<br />
;Notes<br />
<br><br />
<br />
===GetControls===<br />
{{MethodHeader|public native CabinControl[ ] GetControls(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*An array of the CabinControl objects applicable to the cabin.<br />
;Syntax<br />
CabinControl[] controls = GetControls();<br />
;Notes<br />
<br><br />
<br />
===GetNamedControl===<br />
{{MethodHeader|public native CabinControl GetNamedControl(string name)}}<br />
;Parameters<br />
*'''name''' = Name of control to return.<br />
;Returned Value<br />
*A reference to the named control if it exists, null otherwise.<br />
;Syntax<br />
CabinControl control = GetNamedControl("brake");<br />
;Notes<br />
<br><br />
<br />
===GetParentObject===<br />
{{MethodHeader|public native GameObject GetParentObject(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*A reference to the parent GameObject to which the cabin is attached, usually a Locomotive.<br />
;Syntax<br />
Locomotive loco = cast<Locomotive>cabin.GetParentObject();<br />
;Notes<br />
<br><br />
<br />
===IsActive===<br />
{{MethodHeader|public native bool IsActive(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*True if the cabin is currently active, false otherwise.<br />
;Syntax<br />
bool cabinExists = cabin.IsActive();<br />
;Notes<br />
<br><br />
<br />
===SetCabLightIntensity===<br />
{{MethodHeader|public native void SetCabLightIntensity(float intensity)}}<br />
;Parameters<br />
*''intensity''' = A normalised lighting level in the range 0.0..1.0<br />
;Returned Value<br />
*None<br />
;Syntax<br />
SetCabLightIntensity(0.5);<br />
;Notes<br />
<br><br />
''It works? In build 4.3 no changes are visible. Should the texture glow turn on?''<br />
<br />
===Update===<br />
{{MethodHeader|public void Update(void)}}<br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None<br />
;Notes<br />
*This is a callback method used by Trainz to update the cabin object.<br />
*This implementation is empty so the script programmer must implement it if they want their cabin's controls to be updated.<br />
*If you want to keep the controls in the cabin up to date and to accurately reflect the current state of the locomotive, you will need to perform those updates from an overridden implementation of this method.<br />
*This is mostly a case of querying the current status of the host locomotive and applying it to the matching control.<br />
*The speedometer in the cab for instance should be updated based on the loco's current velocity.<br />
<br><br />
<br />
===UserPressKey===<br />
{{MethodHeader|public void UserPressKey(string keyName)}}<br />
;Parameters<br />
*'''keyName''' = The name of the key pressed.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*This is a callback method used by Trainz when the user presses a key.<br />
*The default Cabin implementation does not handle any keystrokes. You must do so in your own overridden implementation.<br />
<br><br />
<br />
===UserSetControl===<br />
{{MethodHeader|public void UserSetControl(CabinControl control, float value)}}<br />
;Parameters<br />
*'''control''' = The control that the user has operated.<br />
*'''value''' = The value to assign as a result of the user's action.<br />
;Returned Value<br />
*None<br />
;Notes<br />
*This is a callback method used by Trainz when the user presses a key.<br />
*You should override this method to apply the settings selected by the user.<br />
<br><br />
<br />
==Related Methods==<br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Track_Part_Container&diff=20885Track Part Container2019-08-25T15:30:40Z<p>Ciceronmt: /* coordinate-transformation */</p>
<hr />
<div>A [[Track Part Container]] is a [[config.txt file]] entry used by the [[KIND Track]] content type. It does not correspond to a single specific tag, but rather is a format which is reused by several different tags.<br />
<br />
This page describes [[trainz-build]] 4.5.<br />
<br />
<br />
==Supported Tags==<br />
The [[Track Part Container]] supports the following tags. Each tag is shown here with its default value. In some cases, the [[Track Part Container]] may inherit the values set on a parent container (excepting the track-lod-tree) rather than using these defaults; see the individual content type descriptions for additional details.<br />
<br />
mesh-length 0.0<br />
adjust-height-to-ground-threshold -3.402823466e+38<br />
adjust-height-to-ground-offset 0.0<br />
adjust-cross-section-to-ground 1<br />
track-lod-tree<br />
{<br />
}<br />
coordinate-transformation "spline"<br />
follows-spline-gradient 0<br />
follows-ground-height-at-ends-of-mesh 0<br />
dont-scale-mesh-to-fit-length 0<br />
padding-length 0<br />
spacing-length-before 0<br />
spacing-length-after 0<br />
use-superelevation 0<br />
endcap-outside-spline 1<br />
<br />
====mesh-length====<br />
The mesh-length value is a track distance in meters which defines the basic unit length of track that the track-lod-tree describes. The track-lod-tree may supply a single mesh of this length, or may subdivide the unit mesh-length into a number of smaller mesh pieces.<br />
<br />
====adjust-height-to-ground-threshold====<br />
Any vertex with a model-space Z value less than this threshold number will be adjusted based on the height of the ground under that vertex.<br />
<br />
The math behind the adjustment is roughly as follows:<br />
<br />
outputVertexPosition.z = modelVertexPosition.z + adjustHeightToGroundOffset + groundHeight<br />
<br />
Typically, this height adjustment is used when building a bridge or similar structure - the bulk of the model is maintained at the actual spline height, but the bottom vertices of the legs or supporting pillars are dropped to ground height.<br />
<br />
The offset and threshold values can be used where a spline consists of a base, which should always display at ground level at a fixed size, and a pylon or tower structure above the base with a height that varies with spline height above ground. Set the adjust-height-to-ground-threshold to a value that falls in the section of mesh that is above the base portion (the pylon) and set the adjust-height-to-ground-offset to the negative of the z-value of the lowest vertex of the base. The base will be positioned at ground level, the vertices between the bottom vertex of the base and the threshold value will be positioned relative to the ground, and the vertices above the threshold will be positioned relative to the spline height.<br />
<br />
====adjust-height-to-ground-offset====<br />
Provides an offset along the model-space Z axis that is used when a vertex is being adjusted to ground height. If set to the negative of the adjust-height-to-ground-threshold value, this will effectively cause any vertex at that height to be dropped to exactly ground level. Any vertex below that height will drop below ground level. Any vertex above that height will not be modified.<br />
<br />
By varying the offset, this allows vertices to float slightly above the actual ground height.<br />
<br />
====adjust-cross-section-to-ground====<br />
If this boolean value is set (1), the track mesh is distorted across its X axis to follow the ground plane upon which it rests.<br />
If clear (0) the mesh will assume the ground height from the center point.<br />
This setting has no effect on vertices which are within the adjust-height-to-ground-threshold range.<br />
<br />
====track-lod-tree====<br />
The [["track-lod-tree" container]] is used to select appropriate meshes for runtime mesh stitching.<br />
<br />
====coordinate-transformation====<br />
The coordinate-transformation setting determines how vertices from the model are mapped into the world. The following techniques are available:<br />
<br />
* "spline" (default) - this option gives the default, fit-to-spline behavior.<br />
* "linear" - this option gives simple linear scaling. This will not attempt to shear the ends of the mesh to fit the neighbors.<br />
* "shear" - this option gives simple linear scaling. This will 'shear' (linear stretch) the ends of the mesh to fit the neighbors.<br />
* "horizontal" - this option gives an effect similar to 'linear' except that height is fixed throughout a given component mesh. This is useful if lack of vertical distortion is more important that meeting end-to-end with the next mesh.<br />
* "horizontal-shear" - this option gives an effect similar to 'shear' except that height is fixed throughout a given component mesh. This is useful if lack of vertical distortion is more important that meeting end-to-end with the next mesh.<br />
<br />
Example:<br />
[[File:SplineOptions.tga|alt=Examples of a spline configured with different coordinate-transformation options.]]<br />
<br />
====follows-spline-gradient====<br />
If this boolean value is set (1), the mesh is deformed to smoothly follow the height-gradient of the spline.<br />
If clear (0), the mesh is instead deformed to follow the ground height along the centre-line of the spline ("adjust-cross-section-to-ground 1") or under each vertex ("adjust-cross-section-to-ground 0").<br />
Certain in-game state, such as having set a height gradient onto the spline (yellow track vertices in Surveyor) or residing on a parent bridge spline, may override this option.<br />
<br />
====follows-ground-height-at-ends-of-mesh====<br />
If this boolean value is set(1), the spline height is effectively deformed such that the end-points of each repeat of the mesh follow the ground height. Spline height throughout the mesh varies in a linear fashion.<br />
If clear (0), the spline height is not affected.<br />
Certain other options, such as ("follows-spline-gradient 0") or ("coordinate-transformation spline") may cause this option to be largely meaningless.<br />
<br />
====dont-scale-mesh-to-fit-length====<br />
If this boolean value is clear (0), the length of each component mesh is scaled to fit the available area in the spline. Since the number of repeats and subdivisions is integer, spline meshes are typically stretched or contracted slightly to ensure that the mesh repeats end-to-end.<br />
If set (1), the mesh is rendered at its natural length, even if this means that meshes will overlap or stretch apart and not touch each other. This might typically used where a spline represents a set of repeating poles or pylons, rather than a continuous beam. It is also commonly used for the spline endcaps, which are often modelled to a fixed size and should not be stretched or contracted.<br />
<br />
====padding-length====<br />
A distance (meters, float, default 0) to use for spline repeat padding. Padding meshes are intended to fill in for full-sized repeats at the start of a procedural track where the mesh-length does not divide evenly. This technique is complicated and may not work as intended; it is not recommended at the current time.<br />
<br />
''This tag was introduced at trainz-build 4.2.''<br />
<br />
====spacing-length-before====<br />
A distance (meters, float, default 0) which is left empty within each mesh repeat before the geometry. This spacing exists within the 'mesh-length' leaving less available space for the actual mesh.<br />
<br />
This value cannot be negative.<br />
<br />
''This tag was introduced at trainz-build 4.2.''<br />
<br />
====spacing-length-after====<br />
A distance (meters, float, default 0) which is left empty within each mesh repeat after the geometry. This spacing exists within the 'mesh-length' leaving less available space for the actual mesh.<br />
<br />
This value cannot be negative.<br />
<br />
''This tag was introduced at trainz-build 4.2.''<br />
<br />
====endcap-outside-spline====<br />
If this boolean value is set (default, 1) on an endcap, then the endcap geometry exists beyond the spline. If this boolean value is clear (0) then the spline geometry is inset by the length of the endcap and the endcap resides within the spline.<br />
<br />
''This tag was introduced at trainz-build 4.5.''<br />
<br />
<br />
<br />
<br />
<br />
[[Category: Config Container]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Train&diff=20712Class Train2019-08-21T20:14:12Z<p>Ciceronmt: /* IsStopped */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****Train<br />
<br />
<br><br />
*A train is a collection of vehicles in TRS.<br />
*They act as a single entity and may be controlled using this class.<br />
*A train is placed on a track in script by using [[Class World#CreateTrain|World.CreateTrain()]] or [[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]. <br />
*Trainz will automatically create a Train object for each consist that appears in the game.<br />
*When an existing train is uncoupled and split up into two separate consists a new train object is created.<br />
*Similarly when two trains couple one of the train objects is destroyed.<br />
<br><br />
<br />
==Messages==<br />
*Messages sent to and from Train objects are listed below:<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|Schedule||Abort||Train||Train <br />
|-<br />
|Schedule||Complete||Train||Broadcast <br />
|-<br />
|Schedule||Touch||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Deleted||Train||<br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal notify||Train||Broadcast <br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal||Signal||Train <br />
|-<br />
|[[Object Messages|Train]]||EnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerEnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerLeaveTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||LeaveTrack||Track||Train <br />
|-<br />
|[[Train Messages|Train]]||Over advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||ReachedTarget||Train||Train<br />
|-<br />
|[[Train Messages|Train]]||SlowingForTarget||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StartedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StoppedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Under advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under speed limit||Train||Broadcast <br />
|}<br />
<br><br />
<br />
==Constants==<br />
<br><br />
===Train Control Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CONTROL_MANUAL = 1||User controls train, script can change settings.<br />
|-<br />
|public define int CONTROL_AUTOPILOT = 2||Autopilot controls train.<br />
|-<br />
|public define int CONTROL_AUTOMANUAL = 3||User controls train, autopilot takes over when train is not currently 'focused'.<br />
|-<br />
|public define int CONTROL_SCRIPT = 4||Only the script can control the train.<br />
|}<br />
<br><br />
===Reverser Traction Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TRACTION_FORWARD = 2||Reverse is in forward setting.<br />
|-<br />
|public define int TRACTION_NEUTRAL = 1||Reverser is in neutral.<br />
|-<br />
|public define int TRACTION_REVERSE = 0||Reverser is in reverse.<br />
|}<br />
<br><br />
===Train Brake Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TRAIN_BRAKE_RELEASE = 0.0||Train brakes are released.<br />
|-<br />
|public define float TRAIN_BRAKE_INITIAL = 1.0||Train brakes are in initial mode.<br />
|-<br />
|public define float TRAIN_BRAKE_APPLICATION = 2.0||Train brakes are applied.<br />
|-<br />
|public define float TRAIN_BRAKE_HANDLE_OFF = 3.0||Train brake handle is off.<br />
|-<br />
|public define float TRAIN_BRAKE_EMERGENCY = 4.0||Train brakes are in emergency stop position.<br />
|-<br />
|public define float TRAIN_BRAKE_LAP = 5.0||Train brakes are in the lap position, not available for all trains.<br />
|}<br />
<br><br />
===Dynamic Brake States===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int DYNAMIC_BRAKE_TRACTION = 0||Dynamic brakes in traction mode.<br />
|-<br />
|public define int DYNAMIC_BRAKE_NEUTRAL = 1 ||Dynamic brakes in neutral.<br />
|-<br />
|public define int DYNAMIC_BRAKE_BRAKE = 2 ||Dynamic brakes are on.<br />
|}<br />
<br><br />
<br />
===Found Results===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int RESULT_NONE = 0||Item not found.<br />
|-<br />
|public define int RESULT_FORWARD = 1||Item is in front of train.<br />
|-<br />
|public define int RESULT_INSIDE = 2||Item is within the train, ie between the front and the rear limits.<br />
|-<br />
|public define int RESULT_BACKWARD = 3||Item is behind the train.<br />
|}<br />
<br><br />
===Measurement Conversion Multipliers===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float KPH_TO_MPS = 0.278||Kilometres per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_MPS = 0.447||Miles per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_KPH = 1.609||Miles per hour -> Kilometres per hour.<br />
|}<br />
<br><br />
==Members==<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|<b>public Browser timeTableInfo</b>||A publicly accessible Browser object for timetable information.<br />
|}<br />
<br><br />
==Methods==<br />
<br><br />
<br />
===AddVelocity===<br />
{{MethodHeader|public native void AddVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to add to the current speed of the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.AddVelocity(5.0); <br />
;Notes<br />
*Velocity parameter must be in metres per second and may be negative.<br />
*Use the [[#Measurement Conversion Multipliers|Measurement Conversion Multipliers]] to convert from other units.<br />
<br><br />
<br />
===ClearTrainTimetable===<br />
{{MethodHeader|public void ClearTrainTimetable(ScenarioBehavior rule)}} <br />
;Parameters<br />
*'''rule''' = rule that called [[#SetTrainTimetable|SetTrainTimetable()]] on this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ClearTimeTable(timetableRule); <br />
;Notes<br />
*Clears the train timetable of this train. <br />
*Having cleared the TrainTimetable, it is now safe again to set another TrainTimetable for this train through [[#SetTrainTimetable|SetTrainTimetable()]].<br />
*This method must only be called by the rule which called SetTrainTimetable() in the first place. <br />
*It is the responsibility of the caller to post a (TrainTimetable, Touch) message after calling this function.<br />
<br><br />
<br />
===DecTrainBusy===<br />
{{MethodHeader|public void DecTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.DecTrainBusy(); <br />
;Notes<br />
*Decrements this train's busy count.<br />
*See [[#IsTrainBusy|IsTrainBusy()]] for further details.<br />
<br><br />
<br />
===Derail===<br />
{{MethodHeader|public native void Derail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Derail(); <br />
;Notes<br />
*Deliberately derails the train.<br />
<br><br />
<br />
===EnablePhysics===<br />
{{MethodHeader|public native void EnablePhysics(bool enable)}} <br />
;Parameters<br />
*'''enable''' = True to enable physics calculations for this train, false to disable <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.EnablePhysics(false); <br />
;Notes<br />
*Turning physics off for scenic rolling stock that the player cannot interact with can boost performance.<br />
*There is no point in doing physic calculations for idle rollingstock.<br />
<br><br />
<br />
===GetActiveDriver===<br />
{{MethodHeader|public native DriverCharacter GetActiveDriver(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The active driver of this train, null if there is no driver assigned.<br />
;Syntax<br />
DriverCharacter driver = train.GetActiveDriver(); <br />
;Notes<br />
*There may be more than one driver on a train but there is only one active driver and an individual Locomotive may only have one driver assigned.<br />
<br><br />
<br />
===GetAdvisoryLimit===<br />
{{MethodHeader|public native float GetAdvisoryLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current advisory speed limit set by script. <br />
;Syntax<br />
float speed = train.GetAdvisoryLimit(); <br />
;Notes<br />
<br><br />
<br />
===GetAllowsUserContol===<br />
{{MethodHeader|public native bool GetAllowsUserControl(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train allows the user to control it directly through DCC or Cabin interfaces, false otherwise.<br />
;Syntax<br />
bool canDrive =train.getAllowsUserControl(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotMode===<br />
{{MethodHeader|public native int GetAutopilot Mode(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Control Modes|Train Control Mode]] constants defining the method by which the train is currently controlled.<br />
;Syntax<br />
int controlMode = train.GetAutopilotMode(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopJunctionBase===<br />
{{MethodHeader|public native JunctionBase GetAutopilotStopJunctionBase(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The junction object that is preventing the autopilot from taking this train any further, null if the train is not stopped by a junction. <br />
;Syntax<br />
JunctionBase junction = train GetAutopilotStopJunctionBase(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopTrain===<br />
{{MethodHeader|public native Train GetAutopilotStopTrain(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train that is preventing the autopilot from taking this train any further, null if the train is not being held up by another train. <br />
;Syntax<br />
Train otherTrain = train.GetAutopilotStopTrain(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotTargetSlowing===<br />
{{MethodHeader|public native bool GetAutopilotTargetSlowing(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the autopilot is slowing down for its target destination, false otherwise. <br />
;Syntax<br />
bool isSlowing = train.GetAutopilotTargetSlowing(); <br />
;Notes<br />
<br><br />
<br />
===GetDCCThrottle===<br />
{{MethodHeader|public native float GetDCCThrottle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The DCC throttle setting for this train when using DCC physics. <br />
;Syntax<br />
float throttle = GetDCCThrottle(); <br />
;Notes<br />
*The returned value will be in the range [-1.0 .. 1.0] where -1.0 is full throttle in reverse, 0.0 is stationary and 1.0 is full throttle forward.<br />
<br><br />
<br />
===GetFrontmostLocomotive===<br />
{{MethodHeader|public native Locomotive GetFrontmostLocomotive(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a reference to the frontmost locomotive in the train. <br />
;Syntax<br />
Loco = Train.GetFrontmostLocomotive(); <br />
;Notes<br />
*<font color=red>The ''front'' of the train is defined relative to the train's current heading.??</font> <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetHeadlightState===<br />
{{MethodHeader|public native bool GetHeadlightState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if headlights are turned on, false otherwise. <br />
;Syntax<br />
bool lights = train.GetHeadlightState(); <br />
;Notes<br />
*Only the frontmost locomotive will display headlighs.<br />
<br><br />
<br />
===GetLastVisitedBuildable===<br />
{{MethodHeader|public Buildable GetLastVisitedBuildable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last [[Class Buildable|Buildable]] object visited by this train, null if there have been no such visits.<br />
;Syntax<br />
Buildable buildable = train.GetLastVisitedBuildable(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedIndustry===<br />
{{MethodHeader|public Industry GetLastVisitedIndustry(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last Industry object visited by this train, null if there have been no such visits. <br />
;Syntax<br />
Industry industry = train.GetLastVisitedIndustry(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedTrack===<br />
{{MethodHeader|public Track GetLastVisitedTrack(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last track segment visited by this train. <br />
;Syntax<br />
Track track = train.GetLastVisitedTrack(); <br />
;Notes<br />
*Note that the returned value may be null. <font color=red>How is that possible?</font><br />
<br><br />
<br />
===GetHighBeams===<br />
{{MethodHeader|public bool GetHighBeams(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the frontmost locomotive's high beams are on, false otherwise. <br />
;Syntax<br />
bool High_Lights = train.GetHighBeams(); <br />
;Notes<br />
*See also [[Class Vehicle#GetHighBeams|Vehicle.GetHighBeams()]]<br />
<br><br />
<br />
===GetMaximumCouplingStressVehicle===<br />
{{MethodHeader|public native Vehicle GetMaximumCouplingStressVehicle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The Vehicle in this consist that is experiencing the greatest level of coupling stress. <br />
;Syntax<br />
Vehicle vehicle = GetMaximumCouplingStressVehicle(); <br />
;Notes<br />
<br><br />
<br />
===GetPantographState===<br />
{{MethodHeader|public native int GetPantographState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The state of the pantographs of the electric locomotives in this train. <br />
;Syntax<br />
int pantoState = train.GetPantographState(); <br />
;Notes<br />
*The returned value will be in the range [0..3] where:<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===GetPhysicsModel===<br />
{{MethodHeader|public native int GetPhysicsModel(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The mode of control chosen by the player to drive the locomotive <br />
;Syntax<br />
int Mode = train.GetPhysicsModel(); <br />
;Notes<br />
*The returned value will be :<br />
**2 = CabinControl<br />
**1 = DCCMode<br />
<br><br />
<br />
<br />
===GetSmoothedVelocity===<br />
{{MethodHeader|public native float GetSmoothedVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a smoothed velocity, intended for human consumption. <br />
;Syntax<br />
float speed = train.GetSmoothedVelocity(); <br />
;Notes<br />
*If you require an accurate velocity readout for physics operations, use [[#GetVelocity|GetVelocity()]]. <br />
<br><br />
<br />
===GetSpeedLimit===<br />
{{MethodHeader|public native float GetSpeedLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current sign posted speed limit. <br />
;Syntax<br />
float permittedSpeed = train.GetSpeedLimit(); <br />
;Notes<br />
*The speed limit is dependent on trackside signs placed in Surveyor as well as the direction of the train.<br />
*A default value applies to track that isn't sign posted.<br />
<br><br />
<br />
===GetTrackmarkDirection===<br />
{{MethodHeader|public native int GetTrackmarkDirection(TrackMark mark)}} <br />
;Parameters<br />
*'''mark''' = A reference to the Trackmark to search for.<br />
;Returned Value<br />
* One of the [[#Found Results|Found Result]] values representing the location of the given track mark relative to this train. <br />
;Syntax<br />
int location = train.GetTrackmarkDirection(trackmark); <br />
;Notes<br />
<br><br />
<br />
===GetTrainBrakes===<br />
{{MethodHeader|public native float GetTrainBrakes(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Brake Modes|Train Brake mode]] constants indicating the current state of this train's brakes. <br />
;Syntax<br />
float brakeState = train.GetTrainBrakes(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainDisplayName===<br />
{{MethodHeader|public native string GetTrainDisplayName(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*A localised display name for this train. <br />
;Syntax<br />
string trainName = train.GetTrainDisplayName(); <br />
;Notes<br />
*This will be a name Trainz has created for the consist such as "Consist 0" and will match the description shown in the Minimap view. <br />
<br><br />
<br />
===GetTrainPriorityNumber===<br />
{{MethodHeader|public native int GetTrainPriorityNumber(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Train priority value in the range [1 .. 3] <br />
;Syntax<br />
int priority = train.GetTrainPriorityNumber();<br />
;Notes<br />
*See [[#SetTrainPriority|SetTrainPriority()]] for further details. <br />
<br><br />
<br />
===GetTrainTimetable===<br />
{{MethodHeader|public TrainTimetable GetTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The TrainTimetable that the train is currently using, null if there is none.<br />
;Syntax<br />
TrainTimetable timetable = train.GetTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainVelocity===<br />
{{MethodHeader|public native float GetTrainVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity in metres per second.<br />
;Syntax<br />
float speed = train.GetTrainVelocity(); <br />
;Notes<br />
* This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display. If you want human-readable display, use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] instead.<br />
<br><br />
<br />
<br />
===GetVehicles===<br />
{{MethodHeader|public native Vehicle[ ] GetVehicles(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns an array consisting of all the vehicles making up this train. <br />
;Syntax<br />
Vehicle[] vehicles = train.GetVehicles(); <br />
;Notes<br />
*GetVehicles[0] is always the front vehicle of the train relative to the train's current heading. <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetVelocity===<br />
{{MethodHeader|public native float GetVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity. <br />
;Syntax<br />
float speed = train.GetVelocity(); <br />
;Notes<br />
*Warning! The TS10 and TS12 Train.gs scripts advise this method is buggy and to use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] or [[#GetTrainVelocity|GetTrainVelocity()]] instead.<br />
*This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display.<br />
<br><br />
<br />
===HasReachedInnerJunctionRadius===<br />
{{MethodHeader|public bool HasReachedJunctionInnerJunctionRadius(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if this train is within the inner radius of the given junction, false otherwise. <br />
;Syntax<br />
bool arrived = train.HasReachedInnerJunctionRadius(junction10); <br />
;Notes<br />
<br><br />
<br />
===HasTrainTimetable===<br />
{{MethodHeader|public bool HasTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train has an attached TrainTimetable, false otherwise. <br />
;Syntax<br />
bool timed = train.HasTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleRunning===<br />
{{MethodHeader|public bool IsScheduleRunning(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train is currently running to a Schedule, false otherwise. <br />
;Syntax<br />
bool scheduled = train.IsScheduleRunning(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleWindowVisible===<br />
{{MethodHeader|public bool IsScheduleWindowVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the schedule window for this train is currently open, false otherwise. <br />
;Syntax<br />
bool windowOpen = IsScheduleWindowVisible(); <br />
;Notes<br />
<br><br />
<br />
===IsStillInJunction===<br />
{{MethodHeader|public bool IsStillInJunction(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if the train holds a Permit for the given junction, flse otherwise. <br />
;Syntax<br />
bool inJunction = train.IsStillInJunction(junction10);<br />
;Notes<br />
<br><br />
<br />
===IsStopped===<br />
{{MethodHeader|public native bool IsStopped(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train is currently stationary, false if it is in motion. <br />
;Syntax<br />
bool moving=train.IsStopped(); <br />
;Notes<br />
<br><br />
<br />
===IsTrainBusy===<br />
{{MethodHeader|public bool IsTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train's 'busy' count is greater than zero, false otherwise. <br />
;Syntax<br />
bool busy = train.IsTrainBusy(); <br />
;Notes<br />
*Using the [[#IncTrainBusy|IncTrainBusy()]] method, any piece of script code can tag a train being busy. <br />
*The train can be untagged later by calling DecTrainBusy(). <br />
*This mechanism is mainly used by industries that are doing something with the train. <br />
*A train can be tagged as being busy more than once by calling IncTrainBusy() multiple times so different industries can tag the train. <br />
*Each time IncTrainBusy() is called, an internal busy count is incremented and if that busy count is greater than zero, the train is considered busy.<br />
<br><br />
<br />
===IsViewDetailsVisible===<br />
{{MethodHeader|public bool IsViewDetailsVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*true if the ViewDetails window for this train is visible, false otherwise. <br />
;Syntax<br />
bool visible = train.IsViewDetailsVisible(); <br />
;Notes<br />
<br><br />
<br />
===MapObjectIsInFront===<br />
{{MethodHeader|public bool MapObjectIsInFront(MapObject obj, float range)}} <br />
;Parameters<br />
*'''obj''' = MapObject to search for.<br />
*'''range''' = Maximum search distance. <br />
;Returned Value<br />
*True if the object is found within the specified distance and in front of the train, false otherwise. <br />
;Syntax<br />
bool isClose = train.MapObjectIsInFront(terminus,100.0); <br />
;Notes<br />
<br><br />
<br />
===ReleaseTrackPermits===<br />
{{MethodHeader|public void ReleaseTrackPermits(Permit[ ] permitList)}} <br />
;Parameters<br />
*'''permitList''' = Permit array containing a list of permits to release. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ReleaseTrackPermits(permitList); <br />
;Notes<br />
*This method will release any permits from the ''permitList'' array that are currently held by this train.<br />
*Any other permits in the array that are not held by this train will be ignored.<br />
<br><br />
<br />
===RunSchedule===<br />
{{MethodHeader|public thread void RunSchedule(Schedule schedule, bool loop, float delay)}} <br />
;Parameters<br />
*'''schedule''' = The Schedule that the train is to follow.<br />
*'''loop''' = False to run the schedule once, True to repeat it continuously.<br />
*'''delay''' = Time in seconds to wait before starting the schedule. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.RunSchedule(schedule,false,10.0); <br />
;Notes<br />
*See [[Class Schedule|Schedule]] for information on how to build a schedule.<br />
*Only one schedule may run on a train at a time and the user cannot control the train when it is running a schedule.<br />
*This method is a thread, so the calling code does not need to wait for it to finish and return before executing other code.<br />
<br><br />
<br />
===SetAdvisoryLimit===<br />
{{MethodHeader|public native void SetAdvisoryLimit(float speed)}} <br />
;Parameters<br />
*'''speed''' = Speed limit to set in <del>KPH</del> metres/second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAdvisoryLimit(60.0);<br />
;Notes<br />
*Sets an advisory speed limit for a script controlled train.<br />
*Use zero in the speed parameter to clear any previously imposed limit.<br />
*<font color=red>Does this really use KPH, most similar methods use MPS</font><br />
*<font color=red>Experimental evidence confirms that it's in m/s not kph or mph</font><br />
<br><br />
<br />
===SetAutopilotMode===<br />
{{MethodHeader|public native void SetAutopilotMode(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Control Modes|Train Control Mode]] constants specifying the method by which this train is controlled. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotMode(Train.CONTROL_AUTOMANUAL); <br />
;Notes<br />
<br><br />
<br />
===SetAutopilotTarget===<br />
{{MethodHeader|public native void SetAutopilotTarget(Buildable buildable, string trigger)<br>public native void SetAutopilotTarget(Trackside trackside)<br>public native void SetAutopilotTarget(Track track)<br>public native void SetAutopilotTarget(JunctionBase junction)}} <br />
;Parameters<br />
*'''buildable''' = Buildable object to use as a destination.<br />
*'''trigger''' = Attached trigger within the buildable, specified by name.<br />
*'''trackside''' = Trackside object to use as a destination.<br />
*'''track''' = Track segment to use as a destination.<br />
*'''junction''' = JunctionBase object to use as a destination.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotTarget("Kings Cross Station","trigger1"); <br />
;Notes<br />
*This method sets a destination for the autopilot to take this train to.<br />
*Objects from respective child classes such as industries, signals and trackmarks may be specified.<br />
<br><br />
<br />
===SetAutopilotTargetMinimumDistance===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumDistance(float distance)}} <br />
;Parameters<br />
*'''distance''' = The minimum distance in metres, between the train and the autopilot target, to be reached before the train will start to slow down. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train SetAutopilotTargetMinimumDistance(100.0);<br />
;Notes<br />
<br><br />
<br />
===SetAutoPilotTargetMinimumSpeed===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumSpeed(float speed)}} <br />
;Parameters<br />
*'''speed''' = Minimum speed, in metres per second, that the train should be travelling at when it reaches the Autopilot target. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutoPilotTargetMinimumSpeed(20.0); <br />
;Notes<br />
*<font color=red>The documentation seems to mean that the train should be going at 20.0 OR MORE. Shouldn't it be MaximumSpeed???</font><br />
<br><br />
<br />
===SetBail===<br />
{{MethodHeader|public native void SetBail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetBail(); <br />
;Notes<br />
*Depresses the bail control for a short period.<br />
<br><br />
<br />
===SetCouplingMask===<br />
{{MethodHeader|public void SetCouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the trains exposed couplers are allowed to couple.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetCouplingMask(Vehicle.COUPLE_NONE); // prevents this train from coupling to another in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from coupling in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDCCThrottle===<br />
{{MethodHeader|public native void SetDCCThrottle(float throttle)}} <br />
;Parameters<br />
*'''throttle''' = Float value in the range -1.0 .. 1.0 defining the throttle setting for the train when using DCC physics. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDCCThrottle(0.0); //sets the throttle to neutral. <br />
;Notes<br />
*Full speed ahead is 1.0<br />
*Maximum in reverse is -1.0<br />
*Neutral is 0.0<br />
<br><br />
<br />
===SetDecouplingMask===<br />
{{MethodHeader|public void SetDecouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the couplers are allowed to couple, applies to all of the vehicles in the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDecouplingMask(Vehicle.COUPLE_FRONT|Vehicle.COUPLE_BACK); // prevents vehicles being uncoupled from the train in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from being uncoupled in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDynamicBrakeMode===<br />
{{MethodHeader|public native void SetDynamicBrakeMode(int mode)}} <br />
;Parameters<br />
*One of the [[#Dynamic Brake States|Dynamic Brake State]] constants indicating the current state of this train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDynamicBrakeMode(Train.DYNAMIC_BRAKE_TRACTION); <br />
;Notes<br />
<br><br />
<br />
===SetFloatingLimit===<br />
{{MethodHeader|public native void SetFloatingLimit(float delta, bool enable)}} <br />
;Parameters<br />
*'''delta''' = Tolerance allowed from the posted limit in metres per second.<br />
*'''enable''' = Use true to enable messages related to floating limits, false to disable.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetFloatingLimit(5.0,true); <br />
;Notes<br />
*Sets the floating speed limit level above the sign posted limit.<br />
*The floating limit is an amount of tolerance above the current speed limit. <br />
*Messages for floating speed violations are not to be confused with regular speed limit messages.<br />
*The floating limit is monitored by the Scenario.Monitor() thread, and may be used for point deduction when speeding. It should therefore be reserved for player trains.<br />
<br><br />
<br />
===SetHandBrake===<br />
{{MethodHeader|public void SetHandBrake(bool state)}} <br />
;Parameters<br />
*'''state''' = Use true to apply the handbrake to all vehicles in this train which are not Locomotives, false to release the handbrake.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHandBrake(true); <br />
;Notes<br />
<br><br />
<br />
===SetHeadlightState===<br />
{{MethodHeader|public native void SetHeadlightState(bool lightsOn)}} <br />
;Parameters<br />
*'''lightsOn''' = True to turn the headlights on, false to turn them off. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHeadlightState(true); <br />
;Notes<br />
*This method affects only the headlights on the frontmost locomotive.<br />
<br><br />
<br />
===SetHighBeams===<br />
{{MethodHeader|public void SetHighBeams(bool value)}} <br />
;Parameters<br />
*'''value''' = True to turn on high beams, false to turn them off. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
train.SetHighBeams(true); <br />
;Notes<br />
*See also [[Class Vehicle#SetHighBeams|Vehicle.SetHighColor()]]<br />
<br><br />
<br />
===SetLastVisitedBuildable===<br />
{{MethodHeader|public void SetLastVisitedBuildable(Buildable buildable)}} <br />
;Parameters<br />
*'''buildable''' = Sets the last visited buildable to the given object. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetLastVisitedBuildable(KingsCrossStation); <br />
;Notes<br />
<br><br />
<br />
===SetManualThrottle===<br />
{{MethodHeader|public native void SetManualThrottle(int notch)}} <br />
;Parameters<br />
*'''notch''' = Value in the range 0 .. 8 to set the throttle. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetManualThrottle(5); <br />
;Notes<br />
<br><br />
<br />
===SetPantogaphState===<br />
{{MethodHeader|public native void SetPantographState(int state)}} <br />
;Parameters<br />
*'''state''' = Value in the range 0 .. 3 to set the pantographs if this train has them. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetPantographState(3); <br />
;Notes<br />
*Use one of these values for ''state'':<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===SetReverser===<br />
{{MethodHeader|public native void SetReverser(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Reverser Traction Modes|Reverser Traction Mode]] constants defining the required state of the train's reverser lever. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetReverser(Train.TRACTION_REVERSE); <br />
;Notes<br />
<br><br />
<br />
===SetTrainBrakes===<br />
{{MethodHeader|public native void SetTrainBrakes(float mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Brake States|Train Brake State]] constants defining the required state of the train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainBrakes(Train.TRAIN_BRAKE_EMERGENCY); <br />
;Notes<br />
<br><br />
<br />
===SetTrainPriorityNumber===<br />
{{MethodHeader|public native void SetTrainPriority Number(int priority)}} <br />
;Parameters<br />
*'''priority''' = Priority value in the range 1 .. 3. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainPriorityNumber(2); <br />
;Notes<br />
*All trains and track sections can be assigned a priority value in the range of [1 - 3] with the default value being 2.<br />
*The priority value is not a numerical scale of precedence, but a value for the AI driver to attempt to match.<br />
*This means the driver will ''prefer'' track sections that have a priority equal to that of the train.<br />
*Changing the priority of the train only takes affect when the driver restarts a new schedule.<br />
<br><br />
<br />
===SetTrainTimetable===<br />
{{MethodHeader|public void SetTrainTimetable(TrainTimetable timetable)}} <br />
;Parameters<br />
*'''timetable''' = Assigns the specified timetable to this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainTimetable(timetable);<br />
;Notes<br />
*This train must not already have a TrainTimetable assigned.<br />
*To ensure that this proviso is met, use [[#ClearTrainTimetabel|ClearTrainTimetable()]] prior to calling this method.<br />
*It is the responsibility of the caller to post a "TrainTimetable","Touch" message after calling this function.<br />
<br><br />
<br />
===SetVelocity===<br />
{{MethodHeader|public native void SetVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to apply to the train, in metres per second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetVelocity(0.0); // stops the train, subject to braking performance. <br />
;Notes<br />
<br><br />
<br />
===ShowInConsistMenu===<br />
{{MethodHeader|public native void ShowInConsistMenu(bool show)}} <br />
;Parameters<br />
*'''show''' = True to make this train visible to the in-game consist menu, false to hide it. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ShowInConsistMenu(false); <br />
;Notes<br />
<br><br />
<br />
===SoundHorn===<br />
{{MethodHeader|public native void SoundHorn(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SoundHorn(); <br />
;Notes<br />
*Sounds the horn or whictle for all locomotives in this train.<br />
<br><br />
<br />
===StopSchedule===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any).<br />
<br><br />
<br />
===StopScheduleAndWait===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any) and waits until the train's schedule actually stops before returning. <br />
*If the train is not running a schedule, the method returns after broadcasting a "Schedule","Touch" message, in case someone is listening for schedule messages.<br />
<br><br />
<br />
===StopTrainGently===<br />
{{MethodHeader|public native void StopTrainGently(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopTrainGently(); <br />
;Notes<br />
*Brings the train to a halt over a short time period.<br />
<br><br />
<br />
===TakePermitOnTrack===<br />
{{MethodHeader|public Permit[ ] TakePermitOnTrack(bool direction)}} <br />
;Parameters<br />
*'''direction''' = Direction relative to the train in which to take out permits. <br />
;Returned Value<br />
*An array including any permits taken which have not yet been granted to this train. Some of these permits may not yet have been granted. <br />
;Syntax<br />
Permit[] permits = train.TakePermitOnTrack(true); <br />
;Notes<br />
*Gets permits on the current track in the given direction.<br />
<br><br />
<br />
===TestTrackPermit===<br />
{{MethodHeader|public native bool TestTrackPermit(Permit permit, bool innerOnly)}} <br />
;Parameters<br />
*'''permit''' = An existing Permit object.<br />
*'''innerOnly''' = If true the method will test only the inner radius, if false the default radius of 150 metres will be used.<br />
;Returned Value<br />
*True if this train is within the track controlled by ''permit'', false otherwise. <br />
;Syntax<br />
bool ownPermit = train.TestTrackPermit(permit1,false); <br />
;Notes<br />
*The method generates an exception if the ''permit'' parameter does not refer to a track.<br />
<br><br />
<br />
===ToggleScheduleWindow===<br />
{{MethodHeader|public void ToggleScheduleWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleScheduleWindow(); <br />
;Notes<br />
*If the schedule window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, UpdateScheduleWindow() is called to create it for display.<br />
<br><br />
<br />
===ToggleViewDetailsWindow===<br />
{{MethodHeader|public void ToggleViewDetailsWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleViewDetailsWindow(); <br />
;Notes<br />
*If the ViewDetails window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, ViewDetails() is called to create it for display.<br />
<br><br />
<br />
===TrackSearch===<br />
{{MethodHeader|public native MapObject[ ] TrackSearch(bool direction, float distance)}} <br />
;Parameters<br />
*'''direction''' = Direction to search relative to the train's heading, true for forwards, false for backwards.<br />
*'''distance''' = Maximum search distance in metres. <br />
;Returned Value<br />
*An array of objects found along the track in the defined search direction, the array might be empty. <br />
;Syntax<br />
MapObject[] objects = train.TrackSearch(true,5000.0) // searches 5km forwards along the track. <br />
;Notes<br />
*Gets all of the Trackside and SceneryWithTrack objects on a length of track that is either in front of or behind this train. <br />
*Descendants of these classes are also returned.<br />
<br><br />
<br />
===TracksideIsInFront===<br />
{{MethodHeader|public bool TracksideIsInFront(Trackside obj, float range)}} <br />
;Parameters<br />
*'''obj''' = Trackside object to search for.<br />
*'''range''' = Mximum search distance. <br />
;Returned Value<br />
*True if the object is logically forward of this train, false otherwise. <br />
;Syntax<br />
bool found = train.TracksideIsInFront(signal1,500.0); <br />
;Notes<br />
<br><br />
<br />
===Turnaround===<br />
{{MethodHeader|public native void Turnaround(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Turnaround(); <br />
;Notes<br />
*Reverses the logical direction of the train, ie changes its heading.<br />
*The physical direction of the vehicles is not altered but the throttle direction is reversed.<br />
*If the camera is focused on the train in tracking view when this method is called the camera's direction of view (relative to the map) will alter through 180 degrees.<br />
<br><br />
<br />
===UpdateScheduleWindow===<br />
{{MethodHeader|public void UpdateScheduleWindow(string vehicleName)}} <br />
;Parameters<br />
*'''vehicleName''' = Name of vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateScheduleWindow("brake2"); <br />
;Notes<br />
*Updates the schedule window from the given vehicle.<br />
<br><br />
<br />
===UpdateViewDetails===<br />
{{MethodHeader|public void UpdateViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetails(vehicle);<br />
;Notes<br />
*Called by Vehicle.UpdateViewDetails() when a vehicle's load has changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===UpdateViewDetailsLocomotive===<br />
{{MethodHeader|public void UpdateViewDetailsLocomotive(void)}} <br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetailsLocomotive(vehicle);<br />
;Notes<br />
*Called by Locomotive.UpdateViewDetails() when any of the Locomotive's operating parameters have changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===ViewDetails===<br />
{{MethodHeader|public void ViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ViewDetails(vehicle); <br />
;Notes<br />
*This method is called by Vehicle.ViewDetails() when the user has requested to view the details of the consist.<br />
*It will create a Browser window listing information about the train including who the driver character is and the loads of all vehicles.<br />
<br><br />
<br />
===WasRunScheduleSuccessful===<br />
{{MethodHeader|public bool WasRunScheduleSuccessful(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the most recently run schedule was successfully, false otherwise. <br />
;Syntax<br />
train.WasRunScheduleSuccessful(); <br />
;Notes<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class TrainUtil#AreInTrain|TrainUtil.AreInTrain()]]<br><br />
[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]<br><br />
[[Class TrainUtil#IsInTrain|TrainUtil.IsInTrain()]]<br><br />
[[Class World#CreateTrain|World.CreateTrain()]]<br><br />
[[Class World#DeleteTrain|World.DeleteTrain()]]<br><br />
[[Class World#GetTrainList|World.GetTrainList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Train&diff=20711Class Train2019-08-21T20:12:57Z<p>Ciceronmt: /* SetHandBrake */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****Train<br />
<br />
<br><br />
*A train is a collection of vehicles in TRS.<br />
*They act as a single entity and may be controlled using this class.<br />
*A train is placed on a track in script by using [[Class World#CreateTrain|World.CreateTrain()]] or [[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]. <br />
*Trainz will automatically create a Train object for each consist that appears in the game.<br />
*When an existing train is uncoupled and split up into two separate consists a new train object is created.<br />
*Similarly when two trains couple one of the train objects is destroyed.<br />
<br><br />
<br />
==Messages==<br />
*Messages sent to and from Train objects are listed below:<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|Schedule||Abort||Train||Train <br />
|-<br />
|Schedule||Complete||Train||Broadcast <br />
|-<br />
|Schedule||Touch||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Deleted||Train||<br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal notify||Train||Broadcast <br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal||Signal||Train <br />
|-<br />
|[[Object Messages|Train]]||EnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerEnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerLeaveTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||LeaveTrack||Track||Train <br />
|-<br />
|[[Train Messages|Train]]||Over advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||ReachedTarget||Train||Train<br />
|-<br />
|[[Train Messages|Train]]||SlowingForTarget||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StartedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StoppedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Under advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under speed limit||Train||Broadcast <br />
|}<br />
<br><br />
<br />
==Constants==<br />
<br><br />
===Train Control Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CONTROL_MANUAL = 1||User controls train, script can change settings.<br />
|-<br />
|public define int CONTROL_AUTOPILOT = 2||Autopilot controls train.<br />
|-<br />
|public define int CONTROL_AUTOMANUAL = 3||User controls train, autopilot takes over when train is not currently 'focused'.<br />
|-<br />
|public define int CONTROL_SCRIPT = 4||Only the script can control the train.<br />
|}<br />
<br><br />
===Reverser Traction Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TRACTION_FORWARD = 2||Reverse is in forward setting.<br />
|-<br />
|public define int TRACTION_NEUTRAL = 1||Reverser is in neutral.<br />
|-<br />
|public define int TRACTION_REVERSE = 0||Reverser is in reverse.<br />
|}<br />
<br><br />
===Train Brake Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TRAIN_BRAKE_RELEASE = 0.0||Train brakes are released.<br />
|-<br />
|public define float TRAIN_BRAKE_INITIAL = 1.0||Train brakes are in initial mode.<br />
|-<br />
|public define float TRAIN_BRAKE_APPLICATION = 2.0||Train brakes are applied.<br />
|-<br />
|public define float TRAIN_BRAKE_HANDLE_OFF = 3.0||Train brake handle is off.<br />
|-<br />
|public define float TRAIN_BRAKE_EMERGENCY = 4.0||Train brakes are in emergency stop position.<br />
|-<br />
|public define float TRAIN_BRAKE_LAP = 5.0||Train brakes are in the lap position, not available for all trains.<br />
|}<br />
<br><br />
===Dynamic Brake States===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int DYNAMIC_BRAKE_TRACTION = 0||Dynamic brakes in traction mode.<br />
|-<br />
|public define int DYNAMIC_BRAKE_NEUTRAL = 1 ||Dynamic brakes in neutral.<br />
|-<br />
|public define int DYNAMIC_BRAKE_BRAKE = 2 ||Dynamic brakes are on.<br />
|}<br />
<br><br />
<br />
===Found Results===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int RESULT_NONE = 0||Item not found.<br />
|-<br />
|public define int RESULT_FORWARD = 1||Item is in front of train.<br />
|-<br />
|public define int RESULT_INSIDE = 2||Item is within the train, ie between the front and the rear limits.<br />
|-<br />
|public define int RESULT_BACKWARD = 3||Item is behind the train.<br />
|}<br />
<br><br />
===Measurement Conversion Multipliers===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float KPH_TO_MPS = 0.278||Kilometres per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_MPS = 0.447||Miles per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_KPH = 1.609||Miles per hour -> Kilometres per hour.<br />
|}<br />
<br><br />
==Members==<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|<b>public Browser timeTableInfo</b>||A publicly accessible Browser object for timetable information.<br />
|}<br />
<br><br />
==Methods==<br />
<br><br />
<br />
===AddVelocity===<br />
{{MethodHeader|public native void AddVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to add to the current speed of the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.AddVelocity(5.0); <br />
;Notes<br />
*Velocity parameter must be in metres per second and may be negative.<br />
*Use the [[#Measurement Conversion Multipliers|Measurement Conversion Multipliers]] to convert from other units.<br />
<br><br />
<br />
===ClearTrainTimetable===<br />
{{MethodHeader|public void ClearTrainTimetable(ScenarioBehavior rule)}} <br />
;Parameters<br />
*'''rule''' = rule that called [[#SetTrainTimetable|SetTrainTimetable()]] on this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ClearTimeTable(timetableRule); <br />
;Notes<br />
*Clears the train timetable of this train. <br />
*Having cleared the TrainTimetable, it is now safe again to set another TrainTimetable for this train through [[#SetTrainTimetable|SetTrainTimetable()]].<br />
*This method must only be called by the rule which called SetTrainTimetable() in the first place. <br />
*It is the responsibility of the caller to post a (TrainTimetable, Touch) message after calling this function.<br />
<br><br />
<br />
===DecTrainBusy===<br />
{{MethodHeader|public void DecTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.DecTrainBusy(); <br />
;Notes<br />
*Decrements this train's busy count.<br />
*See [[#IsTrainBusy|IsTrainBusy()]] for further details.<br />
<br><br />
<br />
===Derail===<br />
{{MethodHeader|public native void Derail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Derail(); <br />
;Notes<br />
*Deliberately derails the train.<br />
<br><br />
<br />
===EnablePhysics===<br />
{{MethodHeader|public native void EnablePhysics(bool enable)}} <br />
;Parameters<br />
*'''enable''' = True to enable physics calculations for this train, false to disable <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.EnablePhysics(false); <br />
;Notes<br />
*Turning physics off for scenic rolling stock that the player cannot interact with can boost performance.<br />
*There is no point in doing physic calculations for idle rollingstock.<br />
<br><br />
<br />
===GetActiveDriver===<br />
{{MethodHeader|public native DriverCharacter GetActiveDriver(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The active driver of this train, null if there is no driver assigned.<br />
;Syntax<br />
DriverCharacter driver = train.GetActiveDriver(); <br />
;Notes<br />
*There may be more than one driver on a train but there is only one active driver and an individual Locomotive may only have one driver assigned.<br />
<br><br />
<br />
===GetAdvisoryLimit===<br />
{{MethodHeader|public native float GetAdvisoryLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current advisory speed limit set by script. <br />
;Syntax<br />
float speed = train.GetAdvisoryLimit(); <br />
;Notes<br />
<br><br />
<br />
===GetAllowsUserContol===<br />
{{MethodHeader|public native bool GetAllowsUserControl(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train allows the user to control it directly through DCC or Cabin interfaces, false otherwise.<br />
;Syntax<br />
bool canDrive =train.getAllowsUserControl(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotMode===<br />
{{MethodHeader|public native int GetAutopilot Mode(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Control Modes|Train Control Mode]] constants defining the method by which the train is currently controlled.<br />
;Syntax<br />
int controlMode = train.GetAutopilotMode(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopJunctionBase===<br />
{{MethodHeader|public native JunctionBase GetAutopilotStopJunctionBase(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The junction object that is preventing the autopilot from taking this train any further, null if the train is not stopped by a junction. <br />
;Syntax<br />
JunctionBase junction = train GetAutopilotStopJunctionBase(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopTrain===<br />
{{MethodHeader|public native Train GetAutopilotStopTrain(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train that is preventing the autopilot from taking this train any further, null if the train is not being held up by another train. <br />
;Syntax<br />
Train otherTrain = train.GetAutopilotStopTrain(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotTargetSlowing===<br />
{{MethodHeader|public native bool GetAutopilotTargetSlowing(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the autopilot is slowing down for its target destination, false otherwise. <br />
;Syntax<br />
bool isSlowing = train.GetAutopilotTargetSlowing(); <br />
;Notes<br />
<br><br />
<br />
===GetDCCThrottle===<br />
{{MethodHeader|public native float GetDCCThrottle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The DCC throttle setting for this train when using DCC physics. <br />
;Syntax<br />
float throttle = GetDCCThrottle(); <br />
;Notes<br />
*The returned value will be in the range [-1.0 .. 1.0] where -1.0 is full throttle in reverse, 0.0 is stationary and 1.0 is full throttle forward.<br />
<br><br />
<br />
===GetFrontmostLocomotive===<br />
{{MethodHeader|public native Locomotive GetFrontmostLocomotive(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a reference to the frontmost locomotive in the train. <br />
;Syntax<br />
Loco = Train.GetFrontmostLocomotive(); <br />
;Notes<br />
*<font color=red>The ''front'' of the train is defined relative to the train's current heading.??</font> <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetHeadlightState===<br />
{{MethodHeader|public native bool GetHeadlightState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if headlights are turned on, false otherwise. <br />
;Syntax<br />
bool lights = train.GetHeadlightState(); <br />
;Notes<br />
*Only the frontmost locomotive will display headlighs.<br />
<br><br />
<br />
===GetLastVisitedBuildable===<br />
{{MethodHeader|public Buildable GetLastVisitedBuildable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last [[Class Buildable|Buildable]] object visited by this train, null if there have been no such visits.<br />
;Syntax<br />
Buildable buildable = train.GetLastVisitedBuildable(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedIndustry===<br />
{{MethodHeader|public Industry GetLastVisitedIndustry(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last Industry object visited by this train, null if there have been no such visits. <br />
;Syntax<br />
Industry industry = train.GetLastVisitedIndustry(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedTrack===<br />
{{MethodHeader|public Track GetLastVisitedTrack(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last track segment visited by this train. <br />
;Syntax<br />
Track track = train.GetLastVisitedTrack(); <br />
;Notes<br />
*Note that the returned value may be null. <font color=red>How is that possible?</font><br />
<br><br />
<br />
===GetHighBeams===<br />
{{MethodHeader|public bool GetHighBeams(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the frontmost locomotive's high beams are on, false otherwise. <br />
;Syntax<br />
bool High_Lights = train.GetHighBeams(); <br />
;Notes<br />
*See also [[Class Vehicle#GetHighBeams|Vehicle.GetHighBeams()]]<br />
<br><br />
<br />
===GetMaximumCouplingStressVehicle===<br />
{{MethodHeader|public native Vehicle GetMaximumCouplingStressVehicle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The Vehicle in this consist that is experiencing the greatest level of coupling stress. <br />
;Syntax<br />
Vehicle vehicle = GetMaximumCouplingStressVehicle(); <br />
;Notes<br />
<br><br />
<br />
===GetPantographState===<br />
{{MethodHeader|public native int GetPantographState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The state of the pantographs of the electric locomotives in this train. <br />
;Syntax<br />
int pantoState = train.GetPantographState(); <br />
;Notes<br />
*The returned value will be in the range [0..3] where:<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===GetPhysicsModel===<br />
{{MethodHeader|public native int GetPhysicsModel(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The mode of control chosen by the player to drive the locomotive <br />
;Syntax<br />
int Mode = train.GetPhysicsModel(); <br />
;Notes<br />
*The returned value will be :<br />
**2 = CabinControl<br />
**1 = DCCMode<br />
<br><br />
<br />
<br />
===GetSmoothedVelocity===<br />
{{MethodHeader|public native float GetSmoothedVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a smoothed velocity, intended for human consumption. <br />
;Syntax<br />
float speed = train.GetSmoothedVelocity(); <br />
;Notes<br />
*If you require an accurate velocity readout for physics operations, use [[#GetVelocity|GetVelocity()]]. <br />
<br><br />
<br />
===GetSpeedLimit===<br />
{{MethodHeader|public native float GetSpeedLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current sign posted speed limit. <br />
;Syntax<br />
float permittedSpeed = train.GetSpeedLimit(); <br />
;Notes<br />
*The speed limit is dependent on trackside signs placed in Surveyor as well as the direction of the train.<br />
*A default value applies to track that isn't sign posted.<br />
<br><br />
<br />
===GetTrackmarkDirection===<br />
{{MethodHeader|public native int GetTrackmarkDirection(TrackMark mark)}} <br />
;Parameters<br />
*'''mark''' = A reference to the Trackmark to search for.<br />
;Returned Value<br />
* One of the [[#Found Results|Found Result]] values representing the location of the given track mark relative to this train. <br />
;Syntax<br />
int location = train.GetTrackmarkDirection(trackmark); <br />
;Notes<br />
<br><br />
<br />
===GetTrainBrakes===<br />
{{MethodHeader|public native float GetTrainBrakes(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Brake Modes|Train Brake mode]] constants indicating the current state of this train's brakes. <br />
;Syntax<br />
float brakeState = train.GetTrainBrakes(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainDisplayName===<br />
{{MethodHeader|public native string GetTrainDisplayName(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*A localised display name for this train. <br />
;Syntax<br />
string trainName = train.GetTrainDisplayName(); <br />
;Notes<br />
*This will be a name Trainz has created for the consist such as "Consist 0" and will match the description shown in the Minimap view. <br />
<br><br />
<br />
===GetTrainPriorityNumber===<br />
{{MethodHeader|public native int GetTrainPriorityNumber(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Train priority value in the range [1 .. 3] <br />
;Syntax<br />
int priority = train.GetTrainPriorityNumber();<br />
;Notes<br />
*See [[#SetTrainPriority|SetTrainPriority()]] for further details. <br />
<br><br />
<br />
===GetTrainTimetable===<br />
{{MethodHeader|public TrainTimetable GetTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The TrainTimetable that the train is currently using, null if there is none.<br />
;Syntax<br />
TrainTimetable timetable = train.GetTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainVelocity===<br />
{{MethodHeader|public native float GetTrainVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity in metres per second.<br />
;Syntax<br />
float speed = train.GetTrainVelocity(); <br />
;Notes<br />
* This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display. If you want human-readable display, use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] instead.<br />
<br><br />
<br />
<br />
===GetVehicles===<br />
{{MethodHeader|public native Vehicle[ ] GetVehicles(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns an array consisting of all the vehicles making up this train. <br />
;Syntax<br />
Vehicle[] vehicles = train.GetVehicles(); <br />
;Notes<br />
*GetVehicles[0] is always the front vehicle of the train relative to the train's current heading. <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetVelocity===<br />
{{MethodHeader|public native float GetVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity. <br />
;Syntax<br />
float speed = train.GetVelocity(); <br />
;Notes<br />
*Warning! The TS10 and TS12 Train.gs scripts advise this method is buggy and to use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] or [[#GetTrainVelocity|GetTrainVelocity()]] instead.<br />
*This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display.<br />
<br><br />
<br />
===HasReachedInnerJunctionRadius===<br />
{{MethodHeader|public bool HasReachedJunctionInnerJunctionRadius(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if this train is within the inner radius of the given junction, false otherwise. <br />
;Syntax<br />
bool arrived = train.HasReachedInnerJunctionRadius(junction10); <br />
;Notes<br />
<br><br />
<br />
===HasTrainTimetable===<br />
{{MethodHeader|public bool HasTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train has an attached TrainTimetable, false otherwise. <br />
;Syntax<br />
bool timed = train.HasTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleRunning===<br />
{{MethodHeader|public bool IsScheduleRunning(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train is currently running to a Schedule, false otherwise. <br />
;Syntax<br />
bool scheduled = train.IsScheduleRunning(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleWindowVisible===<br />
{{MethodHeader|public bool IsScheduleWindowVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the schedule window for this train is currently open, false otherwise. <br />
;Syntax<br />
bool windowOpen = IsScheduleWindowVisible(); <br />
;Notes<br />
<br><br />
<br />
===IsStillInJunction===<br />
{{MethodHeader|public bool IsStillInJunction(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if the train holds a Permit for the given junction, flse otherwise. <br />
;Syntax<br />
bool inJunction = train.IsStillInJunction(junction10);<br />
;Notes<br />
<br><br />
<br />
===IsStopped===<br />
{{MethodHeader|public native bool IsStopped(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train is currently stationary, false if it is in motion. <br />
;Syntax<br />
bool moving=train.IsMoving(); <br />
;Notes<br />
<br><br />
<br />
===IsTrainBusy===<br />
{{MethodHeader|public bool IsTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train's 'busy' count is greater than zero, false otherwise. <br />
;Syntax<br />
bool busy = train.IsTrainBusy(); <br />
;Notes<br />
*Using the [[#IncTrainBusy|IncTrainBusy()]] method, any piece of script code can tag a train being busy. <br />
*The train can be untagged later by calling DecTrainBusy(). <br />
*This mechanism is mainly used by industries that are doing something with the train. <br />
*A train can be tagged as being busy more than once by calling IncTrainBusy() multiple times so different industries can tag the train. <br />
*Each time IncTrainBusy() is called, an internal busy count is incremented and if that busy count is greater than zero, the train is considered busy.<br />
<br><br />
<br />
===IsViewDetailsVisible===<br />
{{MethodHeader|public bool IsViewDetailsVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*true if the ViewDetails window for this train is visible, false otherwise. <br />
;Syntax<br />
bool visible = train.IsViewDetailsVisible(); <br />
;Notes<br />
<br><br />
<br />
===MapObjectIsInFront===<br />
{{MethodHeader|public bool MapObjectIsInFront(MapObject obj, float range)}} <br />
;Parameters<br />
*'''obj''' = MapObject to search for.<br />
*'''range''' = Maximum search distance. <br />
;Returned Value<br />
*True if the object is found within the specified distance and in front of the train, false otherwise. <br />
;Syntax<br />
bool isClose = train.MapObjectIsInFront(terminus,100.0); <br />
;Notes<br />
<br><br />
<br />
===ReleaseTrackPermits===<br />
{{MethodHeader|public void ReleaseTrackPermits(Permit[ ] permitList)}} <br />
;Parameters<br />
*'''permitList''' = Permit array containing a list of permits to release. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ReleaseTrackPermits(permitList); <br />
;Notes<br />
*This method will release any permits from the ''permitList'' array that are currently held by this train.<br />
*Any other permits in the array that are not held by this train will be ignored.<br />
<br><br />
<br />
===RunSchedule===<br />
{{MethodHeader|public thread void RunSchedule(Schedule schedule, bool loop, float delay)}} <br />
;Parameters<br />
*'''schedule''' = The Schedule that the train is to follow.<br />
*'''loop''' = False to run the schedule once, True to repeat it continuously.<br />
*'''delay''' = Time in seconds to wait before starting the schedule. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.RunSchedule(schedule,false,10.0); <br />
;Notes<br />
*See [[Class Schedule|Schedule]] for information on how to build a schedule.<br />
*Only one schedule may run on a train at a time and the user cannot control the train when it is running a schedule.<br />
*This method is a thread, so the calling code does not need to wait for it to finish and return before executing other code.<br />
<br><br />
<br />
===SetAdvisoryLimit===<br />
{{MethodHeader|public native void SetAdvisoryLimit(float speed)}} <br />
;Parameters<br />
*'''speed''' = Speed limit to set in <del>KPH</del> metres/second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAdvisoryLimit(60.0);<br />
;Notes<br />
*Sets an advisory speed limit for a script controlled train.<br />
*Use zero in the speed parameter to clear any previously imposed limit.<br />
*<font color=red>Does this really use KPH, most similar methods use MPS</font><br />
*<font color=red>Experimental evidence confirms that it's in m/s not kph or mph</font><br />
<br><br />
<br />
===SetAutopilotMode===<br />
{{MethodHeader|public native void SetAutopilotMode(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Control Modes|Train Control Mode]] constants specifying the method by which this train is controlled. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotMode(Train.CONTROL_AUTOMANUAL); <br />
;Notes<br />
<br><br />
<br />
===SetAutopilotTarget===<br />
{{MethodHeader|public native void SetAutopilotTarget(Buildable buildable, string trigger)<br>public native void SetAutopilotTarget(Trackside trackside)<br>public native void SetAutopilotTarget(Track track)<br>public native void SetAutopilotTarget(JunctionBase junction)}} <br />
;Parameters<br />
*'''buildable''' = Buildable object to use as a destination.<br />
*'''trigger''' = Attached trigger within the buildable, specified by name.<br />
*'''trackside''' = Trackside object to use as a destination.<br />
*'''track''' = Track segment to use as a destination.<br />
*'''junction''' = JunctionBase object to use as a destination.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotTarget("Kings Cross Station","trigger1"); <br />
;Notes<br />
*This method sets a destination for the autopilot to take this train to.<br />
*Objects from respective child classes such as industries, signals and trackmarks may be specified.<br />
<br><br />
<br />
===SetAutopilotTargetMinimumDistance===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumDistance(float distance)}} <br />
;Parameters<br />
*'''distance''' = The minimum distance in metres, between the train and the autopilot target, to be reached before the train will start to slow down. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train SetAutopilotTargetMinimumDistance(100.0);<br />
;Notes<br />
<br><br />
<br />
===SetAutoPilotTargetMinimumSpeed===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumSpeed(float speed)}} <br />
;Parameters<br />
*'''speed''' = Minimum speed, in metres per second, that the train should be travelling at when it reaches the Autopilot target. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutoPilotTargetMinimumSpeed(20.0); <br />
;Notes<br />
*<font color=red>The documentation seems to mean that the train should be going at 20.0 OR MORE. Shouldn't it be MaximumSpeed???</font><br />
<br><br />
<br />
===SetBail===<br />
{{MethodHeader|public native void SetBail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetBail(); <br />
;Notes<br />
*Depresses the bail control for a short period.<br />
<br><br />
<br />
===SetCouplingMask===<br />
{{MethodHeader|public void SetCouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the trains exposed couplers are allowed to couple.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetCouplingMask(Vehicle.COUPLE_NONE); // prevents this train from coupling to another in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from coupling in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDCCThrottle===<br />
{{MethodHeader|public native void SetDCCThrottle(float throttle)}} <br />
;Parameters<br />
*'''throttle''' = Float value in the range -1.0 .. 1.0 defining the throttle setting for the train when using DCC physics. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDCCThrottle(0.0); //sets the throttle to neutral. <br />
;Notes<br />
*Full speed ahead is 1.0<br />
*Maximum in reverse is -1.0<br />
*Neutral is 0.0<br />
<br><br />
<br />
===SetDecouplingMask===<br />
{{MethodHeader|public void SetDecouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the couplers are allowed to couple, applies to all of the vehicles in the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDecouplingMask(Vehicle.COUPLE_FRONT|Vehicle.COUPLE_BACK); // prevents vehicles being uncoupled from the train in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from being uncoupled in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDynamicBrakeMode===<br />
{{MethodHeader|public native void SetDynamicBrakeMode(int mode)}} <br />
;Parameters<br />
*One of the [[#Dynamic Brake States|Dynamic Brake State]] constants indicating the current state of this train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDynamicBrakeMode(Train.DYNAMIC_BRAKE_TRACTION); <br />
;Notes<br />
<br><br />
<br />
===SetFloatingLimit===<br />
{{MethodHeader|public native void SetFloatingLimit(float delta, bool enable)}} <br />
;Parameters<br />
*'''delta''' = Tolerance allowed from the posted limit in metres per second.<br />
*'''enable''' = Use true to enable messages related to floating limits, false to disable.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetFloatingLimit(5.0,true); <br />
;Notes<br />
*Sets the floating speed limit level above the sign posted limit.<br />
*The floating limit is an amount of tolerance above the current speed limit. <br />
*Messages for floating speed violations are not to be confused with regular speed limit messages.<br />
*The floating limit is monitored by the Scenario.Monitor() thread, and may be used for point deduction when speeding. It should therefore be reserved for player trains.<br />
<br><br />
<br />
===SetHandBrake===<br />
{{MethodHeader|public void SetHandBrake(bool state)}} <br />
;Parameters<br />
*'''state''' = Use true to apply the handbrake to all vehicles in this train which are not Locomotives, false to release the handbrake.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHandBrake(true); <br />
;Notes<br />
<br><br />
<br />
===SetHeadlightState===<br />
{{MethodHeader|public native void SetHeadlightState(bool lightsOn)}} <br />
;Parameters<br />
*'''lightsOn''' = True to turn the headlights on, false to turn them off. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHeadlightState(true); <br />
;Notes<br />
*This method affects only the headlights on the frontmost locomotive.<br />
<br><br />
<br />
===SetHighBeams===<br />
{{MethodHeader|public void SetHighBeams(bool value)}} <br />
;Parameters<br />
*'''value''' = True to turn on high beams, false to turn them off. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
train.SetHighBeams(true); <br />
;Notes<br />
*See also [[Class Vehicle#SetHighBeams|Vehicle.SetHighColor()]]<br />
<br><br />
<br />
===SetLastVisitedBuildable===<br />
{{MethodHeader|public void SetLastVisitedBuildable(Buildable buildable)}} <br />
;Parameters<br />
*'''buildable''' = Sets the last visited buildable to the given object. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetLastVisitedBuildable(KingsCrossStation); <br />
;Notes<br />
<br><br />
<br />
===SetManualThrottle===<br />
{{MethodHeader|public native void SetManualThrottle(int notch)}} <br />
;Parameters<br />
*'''notch''' = Value in the range 0 .. 8 to set the throttle. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetManualThrottle(5); <br />
;Notes<br />
<br><br />
<br />
===SetPantogaphState===<br />
{{MethodHeader|public native void SetPantographState(int state)}} <br />
;Parameters<br />
*'''state''' = Value in the range 0 .. 3 to set the pantographs if this train has them. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetPantographState(3); <br />
;Notes<br />
*Use one of these values for ''state'':<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===SetReverser===<br />
{{MethodHeader|public native void SetReverser(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Reverser Traction Modes|Reverser Traction Mode]] constants defining the required state of the train's reverser lever. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetReverser(Train.TRACTION_REVERSE); <br />
;Notes<br />
<br><br />
<br />
===SetTrainBrakes===<br />
{{MethodHeader|public native void SetTrainBrakes(float mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Brake States|Train Brake State]] constants defining the required state of the train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainBrakes(Train.TRAIN_BRAKE_EMERGENCY); <br />
;Notes<br />
<br><br />
<br />
===SetTrainPriorityNumber===<br />
{{MethodHeader|public native void SetTrainPriority Number(int priority)}} <br />
;Parameters<br />
*'''priority''' = Priority value in the range 1 .. 3. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainPriorityNumber(2); <br />
;Notes<br />
*All trains and track sections can be assigned a priority value in the range of [1 - 3] with the default value being 2.<br />
*The priority value is not a numerical scale of precedence, but a value for the AI driver to attempt to match.<br />
*This means the driver will ''prefer'' track sections that have a priority equal to that of the train.<br />
*Changing the priority of the train only takes affect when the driver restarts a new schedule.<br />
<br><br />
<br />
===SetTrainTimetable===<br />
{{MethodHeader|public void SetTrainTimetable(TrainTimetable timetable)}} <br />
;Parameters<br />
*'''timetable''' = Assigns the specified timetable to this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainTimetable(timetable);<br />
;Notes<br />
*This train must not already have a TrainTimetable assigned.<br />
*To ensure that this proviso is met, use [[#ClearTrainTimetabel|ClearTrainTimetable()]] prior to calling this method.<br />
*It is the responsibility of the caller to post a "TrainTimetable","Touch" message after calling this function.<br />
<br><br />
<br />
===SetVelocity===<br />
{{MethodHeader|public native void SetVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to apply to the train, in metres per second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetVelocity(0.0); // stops the train, subject to braking performance. <br />
;Notes<br />
<br><br />
<br />
===ShowInConsistMenu===<br />
{{MethodHeader|public native void ShowInConsistMenu(bool show)}} <br />
;Parameters<br />
*'''show''' = True to make this train visible to the in-game consist menu, false to hide it. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ShowInConsistMenu(false); <br />
;Notes<br />
<br><br />
<br />
===SoundHorn===<br />
{{MethodHeader|public native void SoundHorn(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SoundHorn(); <br />
;Notes<br />
*Sounds the horn or whictle for all locomotives in this train.<br />
<br><br />
<br />
===StopSchedule===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any).<br />
<br><br />
<br />
===StopScheduleAndWait===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any) and waits until the train's schedule actually stops before returning. <br />
*If the train is not running a schedule, the method returns after broadcasting a "Schedule","Touch" message, in case someone is listening for schedule messages.<br />
<br><br />
<br />
===StopTrainGently===<br />
{{MethodHeader|public native void StopTrainGently(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopTrainGently(); <br />
;Notes<br />
*Brings the train to a halt over a short time period.<br />
<br><br />
<br />
===TakePermitOnTrack===<br />
{{MethodHeader|public Permit[ ] TakePermitOnTrack(bool direction)}} <br />
;Parameters<br />
*'''direction''' = Direction relative to the train in which to take out permits. <br />
;Returned Value<br />
*An array including any permits taken which have not yet been granted to this train. Some of these permits may not yet have been granted. <br />
;Syntax<br />
Permit[] permits = train.TakePermitOnTrack(true); <br />
;Notes<br />
*Gets permits on the current track in the given direction.<br />
<br><br />
<br />
===TestTrackPermit===<br />
{{MethodHeader|public native bool TestTrackPermit(Permit permit, bool innerOnly)}} <br />
;Parameters<br />
*'''permit''' = An existing Permit object.<br />
*'''innerOnly''' = If true the method will test only the inner radius, if false the default radius of 150 metres will be used.<br />
;Returned Value<br />
*True if this train is within the track controlled by ''permit'', false otherwise. <br />
;Syntax<br />
bool ownPermit = train.TestTrackPermit(permit1,false); <br />
;Notes<br />
*The method generates an exception if the ''permit'' parameter does not refer to a track.<br />
<br><br />
<br />
===ToggleScheduleWindow===<br />
{{MethodHeader|public void ToggleScheduleWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleScheduleWindow(); <br />
;Notes<br />
*If the schedule window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, UpdateScheduleWindow() is called to create it for display.<br />
<br><br />
<br />
===ToggleViewDetailsWindow===<br />
{{MethodHeader|public void ToggleViewDetailsWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleViewDetailsWindow(); <br />
;Notes<br />
*If the ViewDetails window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, ViewDetails() is called to create it for display.<br />
<br><br />
<br />
===TrackSearch===<br />
{{MethodHeader|public native MapObject[ ] TrackSearch(bool direction, float distance)}} <br />
;Parameters<br />
*'''direction''' = Direction to search relative to the train's heading, true for forwards, false for backwards.<br />
*'''distance''' = Maximum search distance in metres. <br />
;Returned Value<br />
*An array of objects found along the track in the defined search direction, the array might be empty. <br />
;Syntax<br />
MapObject[] objects = train.TrackSearch(true,5000.0) // searches 5km forwards along the track. <br />
;Notes<br />
*Gets all of the Trackside and SceneryWithTrack objects on a length of track that is either in front of or behind this train. <br />
*Descendants of these classes are also returned.<br />
<br><br />
<br />
===TracksideIsInFront===<br />
{{MethodHeader|public bool TracksideIsInFront(Trackside obj, float range)}} <br />
;Parameters<br />
*'''obj''' = Trackside object to search for.<br />
*'''range''' = Mximum search distance. <br />
;Returned Value<br />
*True if the object is logically forward of this train, false otherwise. <br />
;Syntax<br />
bool found = train.TracksideIsInFront(signal1,500.0); <br />
;Notes<br />
<br><br />
<br />
===Turnaround===<br />
{{MethodHeader|public native void Turnaround(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Turnaround(); <br />
;Notes<br />
*Reverses the logical direction of the train, ie changes its heading.<br />
*The physical direction of the vehicles is not altered but the throttle direction is reversed.<br />
*If the camera is focused on the train in tracking view when this method is called the camera's direction of view (relative to the map) will alter through 180 degrees.<br />
<br><br />
<br />
===UpdateScheduleWindow===<br />
{{MethodHeader|public void UpdateScheduleWindow(string vehicleName)}} <br />
;Parameters<br />
*'''vehicleName''' = Name of vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateScheduleWindow("brake2"); <br />
;Notes<br />
*Updates the schedule window from the given vehicle.<br />
<br><br />
<br />
===UpdateViewDetails===<br />
{{MethodHeader|public void UpdateViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetails(vehicle);<br />
;Notes<br />
*Called by Vehicle.UpdateViewDetails() when a vehicle's load has changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===UpdateViewDetailsLocomotive===<br />
{{MethodHeader|public void UpdateViewDetailsLocomotive(void)}} <br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetailsLocomotive(vehicle);<br />
;Notes<br />
*Called by Locomotive.UpdateViewDetails() when any of the Locomotive's operating parameters have changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===ViewDetails===<br />
{{MethodHeader|public void ViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ViewDetails(vehicle); <br />
;Notes<br />
*This method is called by Vehicle.ViewDetails() when the user has requested to view the details of the consist.<br />
*It will create a Browser window listing information about the train including who the driver character is and the loads of all vehicles.<br />
<br><br />
<br />
===WasRunScheduleSuccessful===<br />
{{MethodHeader|public bool WasRunScheduleSuccessful(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the most recently run schedule was successfully, false otherwise. <br />
;Syntax<br />
train.WasRunScheduleSuccessful(); <br />
;Notes<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class TrainUtil#AreInTrain|TrainUtil.AreInTrain()]]<br><br />
[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]<br><br />
[[Class TrainUtil#IsInTrain|TrainUtil.IsInTrain()]]<br><br />
[[Class World#CreateTrain|World.CreateTrain()]]<br><br />
[[Class World#DeleteTrain|World.DeleteTrain()]]<br><br />
[[Class World#GetTrainList|World.GetTrainList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=Class_Train&diff=20710Class Train2019-08-21T20:07:38Z<p>Ciceronmt: /* SetHighBeams */</p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
**[[Class GSObject|GSObject]] *<br />
***[[Class GameObject|GameObject]]<br />
****Train<br />
<br />
<br><br />
*A train is a collection of vehicles in TRS.<br />
*They act as a single entity and may be controlled using this class.<br />
*A train is placed on a track in script by using [[Class World#CreateTrain|World.CreateTrain()]] or [[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]. <br />
*Trainz will automatically create a Train object for each consist that appears in the game.<br />
*When an existing train is uncoupled and split up into two separate consists a new train object is created.<br />
*Similarly when two trains couple one of the train objects is destroyed.<br />
<br><br />
<br />
==Messages==<br />
*Messages sent to and from Train objects are listed below:<br />
<br><br />
{{TableHeader|width=50%|margin=15px}}<br />
|-<br />
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''<br />
|-<br />
|Schedule||Abort||Train||Train <br />
|-<br />
|Schedule||Complete||Train||Broadcast <br />
|-<br />
|Schedule||Touch||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Deleted||Train||<br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal notify||Train||Broadcast <br />
|-<br />
|[[Signal Messages|Train]]||Entered red signal||Signal||Train <br />
|-<br />
|[[Object Messages|Train]]||EnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerEnterTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||InnerLeaveTrack||Track||Train <br />
|-<br />
|[[Object Messages|Train]]||LeaveTrack||Track||Train <br />
|-<br />
|[[Train Messages|Train]]||Over advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Over speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||ReachedTarget||Train||Train<br />
|-<br />
|[[Train Messages|Train]]||SlowingForTarget||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StartedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||StoppedMoving||Train||Train <br />
|-<br />
|[[Train Messages|Train]]||Under advisory speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under floating speed limit||Train||Broadcast <br />
|-<br />
|[[Train Messages|Train]]||Under speed limit||Train||Broadcast <br />
|}<br />
<br><br />
<br />
==Constants==<br />
<br><br />
===Train Control Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int CONTROL_MANUAL = 1||User controls train, script can change settings.<br />
|-<br />
|public define int CONTROL_AUTOPILOT = 2||Autopilot controls train.<br />
|-<br />
|public define int CONTROL_AUTOMANUAL = 3||User controls train, autopilot takes over when train is not currently 'focused'.<br />
|-<br />
|public define int CONTROL_SCRIPT = 4||Only the script can control the train.<br />
|}<br />
<br><br />
===Reverser Traction Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int TRACTION_FORWARD = 2||Reverse is in forward setting.<br />
|-<br />
|public define int TRACTION_NEUTRAL = 1||Reverser is in neutral.<br />
|-<br />
|public define int TRACTION_REVERSE = 0||Reverser is in reverse.<br />
|}<br />
<br><br />
===Train Brake Modes===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float TRAIN_BRAKE_RELEASE = 0.0||Train brakes are released.<br />
|-<br />
|public define float TRAIN_BRAKE_INITIAL = 1.0||Train brakes are in initial mode.<br />
|-<br />
|public define float TRAIN_BRAKE_APPLICATION = 2.0||Train brakes are applied.<br />
|-<br />
|public define float TRAIN_BRAKE_HANDLE_OFF = 3.0||Train brake handle is off.<br />
|-<br />
|public define float TRAIN_BRAKE_EMERGENCY = 4.0||Train brakes are in emergency stop position.<br />
|-<br />
|public define float TRAIN_BRAKE_LAP = 5.0||Train brakes are in the lap position, not available for all trains.<br />
|}<br />
<br><br />
===Dynamic Brake States===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int DYNAMIC_BRAKE_TRACTION = 0||Dynamic brakes in traction mode.<br />
|-<br />
|public define int DYNAMIC_BRAKE_NEUTRAL = 1 ||Dynamic brakes in neutral.<br />
|-<br />
|public define int DYNAMIC_BRAKE_BRAKE = 2 ||Dynamic brakes are on.<br />
|}<br />
<br><br />
<br />
===Found Results===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define int RESULT_NONE = 0||Item not found.<br />
|-<br />
|public define int RESULT_FORWARD = 1||Item is in front of train.<br />
|-<br />
|public define int RESULT_INSIDE = 2||Item is within the train, ie between the front and the rear limits.<br />
|-<br />
|public define int RESULT_BACKWARD = 3||Item is behind the train.<br />
|}<br />
<br><br />
===Measurement Conversion Multipliers===<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|public define float KPH_TO_MPS = 0.278||Kilometres per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_MPS = 0.447||Miles per hour -> Metres per second.<br />
|-<br />
|public define float MPH_TO_KPH = 1.609||Miles per hour -> Kilometres per hour.<br />
|}<br />
<br><br />
==Members==<br />
<br><br />
{{TableHeader|width=95%|margin=15px}}<br />
|width=375|<b>public Browser timeTableInfo</b>||A publicly accessible Browser object for timetable information.<br />
|}<br />
<br><br />
==Methods==<br />
<br><br />
<br />
===AddVelocity===<br />
{{MethodHeader|public native void AddVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to add to the current speed of the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.AddVelocity(5.0); <br />
;Notes<br />
*Velocity parameter must be in metres per second and may be negative.<br />
*Use the [[#Measurement Conversion Multipliers|Measurement Conversion Multipliers]] to convert from other units.<br />
<br><br />
<br />
===ClearTrainTimetable===<br />
{{MethodHeader|public void ClearTrainTimetable(ScenarioBehavior rule)}} <br />
;Parameters<br />
*'''rule''' = rule that called [[#SetTrainTimetable|SetTrainTimetable()]] on this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ClearTimeTable(timetableRule); <br />
;Notes<br />
*Clears the train timetable of this train. <br />
*Having cleared the TrainTimetable, it is now safe again to set another TrainTimetable for this train through [[#SetTrainTimetable|SetTrainTimetable()]].<br />
*This method must only be called by the rule which called SetTrainTimetable() in the first place. <br />
*It is the responsibility of the caller to post a (TrainTimetable, Touch) message after calling this function.<br />
<br><br />
<br />
===DecTrainBusy===<br />
{{MethodHeader|public void DecTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.DecTrainBusy(); <br />
;Notes<br />
*Decrements this train's busy count.<br />
*See [[#IsTrainBusy|IsTrainBusy()]] for further details.<br />
<br><br />
<br />
===Derail===<br />
{{MethodHeader|public native void Derail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Derail(); <br />
;Notes<br />
*Deliberately derails the train.<br />
<br><br />
<br />
===EnablePhysics===<br />
{{MethodHeader|public native void EnablePhysics(bool enable)}} <br />
;Parameters<br />
*'''enable''' = True to enable physics calculations for this train, false to disable <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.EnablePhysics(false); <br />
;Notes<br />
*Turning physics off for scenic rolling stock that the player cannot interact with can boost performance.<br />
*There is no point in doing physic calculations for idle rollingstock.<br />
<br><br />
<br />
===GetActiveDriver===<br />
{{MethodHeader|public native DriverCharacter GetActiveDriver(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The active driver of this train, null if there is no driver assigned.<br />
;Syntax<br />
DriverCharacter driver = train.GetActiveDriver(); <br />
;Notes<br />
*There may be more than one driver on a train but there is only one active driver and an individual Locomotive may only have one driver assigned.<br />
<br><br />
<br />
===GetAdvisoryLimit===<br />
{{MethodHeader|public native float GetAdvisoryLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current advisory speed limit set by script. <br />
;Syntax<br />
float speed = train.GetAdvisoryLimit(); <br />
;Notes<br />
<br><br />
<br />
===GetAllowsUserContol===<br />
{{MethodHeader|public native bool GetAllowsUserControl(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train allows the user to control it directly through DCC or Cabin interfaces, false otherwise.<br />
;Syntax<br />
bool canDrive =train.getAllowsUserControl(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotMode===<br />
{{MethodHeader|public native int GetAutopilot Mode(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Control Modes|Train Control Mode]] constants defining the method by which the train is currently controlled.<br />
;Syntax<br />
int controlMode = train.GetAutopilotMode(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopJunctionBase===<br />
{{MethodHeader|public native JunctionBase GetAutopilotStopJunctionBase(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The junction object that is preventing the autopilot from taking this train any further, null if the train is not stopped by a junction. <br />
;Syntax<br />
JunctionBase junction = train GetAutopilotStopJunctionBase(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotStopTrain===<br />
{{MethodHeader|public native Train GetAutopilotStopTrain(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train that is preventing the autopilot from taking this train any further, null if the train is not being held up by another train. <br />
;Syntax<br />
Train otherTrain = train.GetAutopilotStopTrain(); <br />
;Notes<br />
<br><br />
<br />
===GetAutopilotTargetSlowing===<br />
{{MethodHeader|public native bool GetAutopilotTargetSlowing(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the autopilot is slowing down for its target destination, false otherwise. <br />
;Syntax<br />
bool isSlowing = train.GetAutopilotTargetSlowing(); <br />
;Notes<br />
<br><br />
<br />
===GetDCCThrottle===<br />
{{MethodHeader|public native float GetDCCThrottle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The DCC throttle setting for this train when using DCC physics. <br />
;Syntax<br />
float throttle = GetDCCThrottle(); <br />
;Notes<br />
*The returned value will be in the range [-1.0 .. 1.0] where -1.0 is full throttle in reverse, 0.0 is stationary and 1.0 is full throttle forward.<br />
<br><br />
<br />
===GetFrontmostLocomotive===<br />
{{MethodHeader|public native Locomotive GetFrontmostLocomotive(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a reference to the frontmost locomotive in the train. <br />
;Syntax<br />
Loco = Train.GetFrontmostLocomotive(); <br />
;Notes<br />
*<font color=red>The ''front'' of the train is defined relative to the train's current heading.??</font> <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetHeadlightState===<br />
{{MethodHeader|public native bool GetHeadlightState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if headlights are turned on, false otherwise. <br />
;Syntax<br />
bool lights = train.GetHeadlightState(); <br />
;Notes<br />
*Only the frontmost locomotive will display headlighs.<br />
<br><br />
<br />
===GetLastVisitedBuildable===<br />
{{MethodHeader|public Buildable GetLastVisitedBuildable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last [[Class Buildable|Buildable]] object visited by this train, null if there have been no such visits.<br />
;Syntax<br />
Buildable buildable = train.GetLastVisitedBuildable(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedIndustry===<br />
{{MethodHeader|public Industry GetLastVisitedIndustry(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last Industry object visited by this train, null if there have been no such visits. <br />
;Syntax<br />
Industry industry = train.GetLastVisitedIndustry(); <br />
;Notes<br />
<br><br />
<br />
===GetLastVisitedTrack===<br />
{{MethodHeader|public Track GetLastVisitedTrack(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The last track segment visited by this train. <br />
;Syntax<br />
Track track = train.GetLastVisitedTrack(); <br />
;Notes<br />
*Note that the returned value may be null. <font color=red>How is that possible?</font><br />
<br><br />
<br />
===GetHighBeams===<br />
{{MethodHeader|public bool GetHighBeams(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the frontmost locomotive's high beams are on, false otherwise. <br />
;Syntax<br />
bool High_Lights = train.GetHighBeams(); <br />
;Notes<br />
*See also [[Class Vehicle#GetHighBeams|Vehicle.GetHighBeams()]]<br />
<br><br />
<br />
===GetMaximumCouplingStressVehicle===<br />
{{MethodHeader|public native Vehicle GetMaximumCouplingStressVehicle(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The Vehicle in this consist that is experiencing the greatest level of coupling stress. <br />
;Syntax<br />
Vehicle vehicle = GetMaximumCouplingStressVehicle(); <br />
;Notes<br />
<br><br />
<br />
===GetPantographState===<br />
{{MethodHeader|public native int GetPantographState(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The state of the pantographs of the electric locomotives in this train. <br />
;Syntax<br />
int pantoState = train.GetPantographState(); <br />
;Notes<br />
*The returned value will be in the range [0..3] where:<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===GetPhysicsModel===<br />
{{MethodHeader|public native int GetPhysicsModel(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The mode of control chosen by the player to drive the locomotive <br />
;Syntax<br />
int Mode = train.GetPhysicsModel(); <br />
;Notes<br />
*The returned value will be :<br />
**2 = CabinControl<br />
**1 = DCCMode<br />
<br><br />
<br />
<br />
===GetSmoothedVelocity===<br />
{{MethodHeader|public native float GetSmoothedVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns a smoothed velocity, intended for human consumption. <br />
;Syntax<br />
float speed = train.GetSmoothedVelocity(); <br />
;Notes<br />
*If you require an accurate velocity readout for physics operations, use [[#GetVelocity|GetVelocity()]]. <br />
<br><br />
<br />
===GetSpeedLimit===<br />
{{MethodHeader|public native float GetSpeedLimit(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The current sign posted speed limit. <br />
;Syntax<br />
float permittedSpeed = train.GetSpeedLimit(); <br />
;Notes<br />
*The speed limit is dependent on trackside signs placed in Surveyor as well as the direction of the train.<br />
*A default value applies to track that isn't sign posted.<br />
<br><br />
<br />
===GetTrackmarkDirection===<br />
{{MethodHeader|public native int GetTrackmarkDirection(TrackMark mark)}} <br />
;Parameters<br />
*'''mark''' = A reference to the Trackmark to search for.<br />
;Returned Value<br />
* One of the [[#Found Results|Found Result]] values representing the location of the given track mark relative to this train. <br />
;Syntax<br />
int location = train.GetTrackmarkDirection(trackmark); <br />
;Notes<br />
<br><br />
<br />
===GetTrainBrakes===<br />
{{MethodHeader|public native float GetTrainBrakes(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*One of the [[#Train Brake Modes|Train Brake mode]] constants indicating the current state of this train's brakes. <br />
;Syntax<br />
float brakeState = train.GetTrainBrakes(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainDisplayName===<br />
{{MethodHeader|public native string GetTrainDisplayName(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*A localised display name for this train. <br />
;Syntax<br />
string trainName = train.GetTrainDisplayName(); <br />
;Notes<br />
*This will be a name Trainz has created for the consist such as "Consist 0" and will match the description shown in the Minimap view. <br />
<br><br />
<br />
===GetTrainPriorityNumber===<br />
{{MethodHeader|public native int GetTrainPriorityNumber(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Train priority value in the range [1 .. 3] <br />
;Syntax<br />
int priority = train.GetTrainPriorityNumber();<br />
;Notes<br />
*See [[#SetTrainPriority|SetTrainPriority()]] for further details. <br />
<br><br />
<br />
===GetTrainTimetable===<br />
{{MethodHeader|public TrainTimetable GetTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The TrainTimetable that the train is currently using, null if there is none.<br />
;Syntax<br />
TrainTimetable timetable = train.GetTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===GetTrainVelocity===<br />
{{MethodHeader|public native float GetTrainVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity in metres per second.<br />
;Syntax<br />
float speed = train.GetTrainVelocity(); <br />
;Notes<br />
* This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display. If you want human-readable display, use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] instead.<br />
<br><br />
<br />
<br />
===GetVehicles===<br />
{{MethodHeader|public native Vehicle[ ] GetVehicles(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*Returns an array consisting of all the vehicles making up this train. <br />
;Syntax<br />
Vehicle[] vehicles = train.GetVehicles(); <br />
;Notes<br />
*GetVehicles[0] is always the front vehicle of the train relative to the train's current heading. <br />
*The train's heading may not correspond to its physical appearance and can change during game play.<br />
<br><br />
<br />
===GetVelocity===<br />
{{MethodHeader|public native float GetVelocity(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*The train's current velocity. <br />
;Syntax<br />
float speed = train.GetVelocity(); <br />
;Notes<br />
*Warning! The TS10 and TS12 Train.gs scripts advise this method is buggy and to use [[#GetSmoothedVelocity|GetSmoothedVelocity()]] or [[#GetTrainVelocity|GetTrainVelocity()]] instead.<br />
*This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display.<br />
<br><br />
<br />
===HasReachedInnerJunctionRadius===<br />
{{MethodHeader|public bool HasReachedJunctionInnerJunctionRadius(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if this train is within the inner radius of the given junction, false otherwise. <br />
;Syntax<br />
bool arrived = train.HasReachedInnerJunctionRadius(junction10); <br />
;Notes<br />
<br><br />
<br />
===HasTrainTimetable===<br />
{{MethodHeader|public bool HasTrainTimetable(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train has an attached TrainTimetable, false otherwise. <br />
;Syntax<br />
bool timed = train.HasTrainTimetable(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleRunning===<br />
{{MethodHeader|public bool IsScheduleRunning(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if this train is currently running to a Schedule, false otherwise. <br />
;Syntax<br />
bool scheduled = train.IsScheduleRunning(); <br />
;Notes<br />
<br><br />
<br />
===IsScheduleWindowVisible===<br />
{{MethodHeader|public bool IsScheduleWindowVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the schedule window for this train is currently open, false otherwise. <br />
;Syntax<br />
bool windowOpen = IsScheduleWindowVisible(); <br />
;Notes<br />
<br><br />
<br />
===IsStillInJunction===<br />
{{MethodHeader|public bool IsStillInJunction(JunctionBase junction)}} <br />
;Parameters<br />
*'''junction''' = JunctionBase object to query. <br />
;Returned Value<br />
*True if the train holds a Permit for the given junction, flse otherwise. <br />
;Syntax<br />
bool inJunction = train.IsStillInJunction(junction10);<br />
;Notes<br />
<br><br />
<br />
===IsStopped===<br />
{{MethodHeader|public native bool IsStopped(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train is currently stationary, false if it is in motion. <br />
;Syntax<br />
bool moving=train.IsMoving(); <br />
;Notes<br />
<br><br />
<br />
===IsTrainBusy===<br />
{{MethodHeader|public bool IsTrainBusy(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the train's 'busy' count is greater than zero, false otherwise. <br />
;Syntax<br />
bool busy = train.IsTrainBusy(); <br />
;Notes<br />
*Using the [[#IncTrainBusy|IncTrainBusy()]] method, any piece of script code can tag a train being busy. <br />
*The train can be untagged later by calling DecTrainBusy(). <br />
*This mechanism is mainly used by industries that are doing something with the train. <br />
*A train can be tagged as being busy more than once by calling IncTrainBusy() multiple times so different industries can tag the train. <br />
*Each time IncTrainBusy() is called, an internal busy count is incremented and if that busy count is greater than zero, the train is considered busy.<br />
<br><br />
<br />
===IsViewDetailsVisible===<br />
{{MethodHeader|public bool IsViewDetailsVisible(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*true if the ViewDetails window for this train is visible, false otherwise. <br />
;Syntax<br />
bool visible = train.IsViewDetailsVisible(); <br />
;Notes<br />
<br><br />
<br />
===MapObjectIsInFront===<br />
{{MethodHeader|public bool MapObjectIsInFront(MapObject obj, float range)}} <br />
;Parameters<br />
*'''obj''' = MapObject to search for.<br />
*'''range''' = Maximum search distance. <br />
;Returned Value<br />
*True if the object is found within the specified distance and in front of the train, false otherwise. <br />
;Syntax<br />
bool isClose = train.MapObjectIsInFront(terminus,100.0); <br />
;Notes<br />
<br><br />
<br />
===ReleaseTrackPermits===<br />
{{MethodHeader|public void ReleaseTrackPermits(Permit[ ] permitList)}} <br />
;Parameters<br />
*'''permitList''' = Permit array containing a list of permits to release. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ReleaseTrackPermits(permitList); <br />
;Notes<br />
*This method will release any permits from the ''permitList'' array that are currently held by this train.<br />
*Any other permits in the array that are not held by this train will be ignored.<br />
<br><br />
<br />
===RunSchedule===<br />
{{MethodHeader|public thread void RunSchedule(Schedule schedule, bool loop, float delay)}} <br />
;Parameters<br />
*'''schedule''' = The Schedule that the train is to follow.<br />
*'''loop''' = False to run the schedule once, True to repeat it continuously.<br />
*'''delay''' = Time in seconds to wait before starting the schedule. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.RunSchedule(schedule,false,10.0); <br />
;Notes<br />
*See [[Class Schedule|Schedule]] for information on how to build a schedule.<br />
*Only one schedule may run on a train at a time and the user cannot control the train when it is running a schedule.<br />
*This method is a thread, so the calling code does not need to wait for it to finish and return before executing other code.<br />
<br><br />
<br />
===SetAdvisoryLimit===<br />
{{MethodHeader|public native void SetAdvisoryLimit(float speed)}} <br />
;Parameters<br />
*'''speed''' = Speed limit to set in <del>KPH</del> metres/second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAdvisoryLimit(60.0);<br />
;Notes<br />
*Sets an advisory speed limit for a script controlled train.<br />
*Use zero in the speed parameter to clear any previously imposed limit.<br />
*<font color=red>Does this really use KPH, most similar methods use MPS</font><br />
*<font color=red>Experimental evidence confirms that it's in m/s not kph or mph</font><br />
<br><br />
<br />
===SetAutopilotMode===<br />
{{MethodHeader|public native void SetAutopilotMode(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Control Modes|Train Control Mode]] constants specifying the method by which this train is controlled. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotMode(Train.CONTROL_AUTOMANUAL); <br />
;Notes<br />
<br><br />
<br />
===SetAutopilotTarget===<br />
{{MethodHeader|public native void SetAutopilotTarget(Buildable buildable, string trigger)<br>public native void SetAutopilotTarget(Trackside trackside)<br>public native void SetAutopilotTarget(Track track)<br>public native void SetAutopilotTarget(JunctionBase junction)}} <br />
;Parameters<br />
*'''buildable''' = Buildable object to use as a destination.<br />
*'''trigger''' = Attached trigger within the buildable, specified by name.<br />
*'''trackside''' = Trackside object to use as a destination.<br />
*'''track''' = Track segment to use as a destination.<br />
*'''junction''' = JunctionBase object to use as a destination.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutopilotTarget("Kings Cross Station","trigger1"); <br />
;Notes<br />
*This method sets a destination for the autopilot to take this train to.<br />
*Objects from respective child classes such as industries, signals and trackmarks may be specified.<br />
<br><br />
<br />
===SetAutopilotTargetMinimumDistance===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumDistance(float distance)}} <br />
;Parameters<br />
*'''distance''' = The minimum distance in metres, between the train and the autopilot target, to be reached before the train will start to slow down. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train SetAutopilotTargetMinimumDistance(100.0);<br />
;Notes<br />
<br><br />
<br />
===SetAutoPilotTargetMinimumSpeed===<br />
{{MethodHeader|public native void SetAutopilotTargetMinimumSpeed(float speed)}} <br />
;Parameters<br />
*'''speed''' = Minimum speed, in metres per second, that the train should be travelling at when it reaches the Autopilot target. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetAutoPilotTargetMinimumSpeed(20.0); <br />
;Notes<br />
*<font color=red>The documentation seems to mean that the train should be going at 20.0 OR MORE. Shouldn't it be MaximumSpeed???</font><br />
<br><br />
<br />
===SetBail===<br />
{{MethodHeader|public native void SetBail(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetBail(); <br />
;Notes<br />
*Depresses the bail control for a short period.<br />
<br><br />
<br />
===SetCouplingMask===<br />
{{MethodHeader|public void SetCouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the trains exposed couplers are allowed to couple.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetCouplingMask(Vehicle.COUPLE_NONE); // prevents this train from coupling to another in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from coupling in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDCCThrottle===<br />
{{MethodHeader|public native void SetDCCThrottle(float throttle)}} <br />
;Parameters<br />
*'''throttle''' = Float value in the range -1.0 .. 1.0 defining the throttle setting for the train when using DCC physics. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDCCThrottle(0.0); //sets the throttle to neutral. <br />
;Notes<br />
*Full speed ahead is 1.0<br />
*Maximum in reverse is -1.0<br />
*Neutral is 0.0<br />
<br><br />
<br />
===SetDecouplingMask===<br />
{{MethodHeader|public void SetDecouplingMask(int mask)}} <br />
;Parameters<br />
*'''mask''' = A mask specifying which of the couplers are allowed to couple, applies to all of the vehicles in the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDecouplingMask(Vehicle.COUPLE_FRONT|Vehicle.COUPLE_BACK); // prevents vehicles being uncoupled from the train in Driver mode.<br />
;Notes<br />
*The mask can be built using the [[Class Vehicle#Coupler Flags|Coupler Flag]] constants defined in [[Class Vehicle]].<br />
*This method will not prevent vehicles or trains from being uncoupled in Surveyor, but takes effect in Driver mode.<br />
<br><br />
<br />
===SetDynamicBrakeMode===<br />
{{MethodHeader|public native void SetDynamicBrakeMode(int mode)}} <br />
;Parameters<br />
*One of the [[#Dynamic Brake States|Dynamic Brake State]] constants indicating the current state of this train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetDynamicBrakeMode(Train.DYNAMIC_BRAKE_TRACTION); <br />
;Notes<br />
<br><br />
<br />
===SetFloatingLimit===<br />
{{MethodHeader|public native void SetFloatingLimit(float delta, bool enable)}} <br />
;Parameters<br />
*'''delta''' = Tolerance allowed from the posted limit in metres per second.<br />
*'''enable''' = Use true to enable messages related to floating limits, false to disable.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetFloatingLimit(5.0,true); <br />
;Notes<br />
*Sets the floating speed limit level above the sign posted limit.<br />
*The floating limit is an amount of tolerance above the current speed limit. <br />
*Messages for floating speed violations are not to be confused with regular speed limit messages.<br />
*The floating limit is monitored by the Scenario.Monitor() thread, and may be used for point deduction when speeding. It should therefore be reserved for player trains.<br />
<br><br />
<br />
===SetHandBrake===<br />
{{MethodHeader|public void SetHandBrake(bool state)}} <br />
;Parameters<br />
*'''state''' = Use true to apply the handbrake to all vehicles in this train which are not Locomotives, false to release the handbrake.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHandBrake(true)' <br />
;Notes<br />
<br><br />
<br />
===SetHeadlightState===<br />
{{MethodHeader|public native void SetHeadlightState(bool lightsOn)}} <br />
;Parameters<br />
*'''lightsOn''' = True to turn the headlights on, false to turn them off. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetHeadlightState(true); <br />
;Notes<br />
*This method affects only the headlights on the frontmost locomotive.<br />
<br><br />
<br />
===SetHighBeams===<br />
{{MethodHeader|public void SetHighBeams(bool value)}} <br />
;Parameters<br />
*'''value''' = True to turn on high beams, false to turn them off. <br />
;Returned Value<br />
*None<br />
;Syntax<br />
train.SetHighBeams(true); <br />
;Notes<br />
*See also [[Class Vehicle#SetHighBeams|Vehicle.SetHighColor()]]<br />
<br><br />
<br />
===SetLastVisitedBuildable===<br />
{{MethodHeader|public void SetLastVisitedBuildable(Buildable buildable)}} <br />
;Parameters<br />
*'''buildable''' = Sets the last visited buildable to the given object. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetLastVisitedBuildable(KingsCrossStation); <br />
;Notes<br />
<br><br />
<br />
===SetManualThrottle===<br />
{{MethodHeader|public native void SetManualThrottle(int notch)}} <br />
;Parameters<br />
*'''notch''' = Value in the range 0 .. 8 to set the throttle. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetManualThrottle(5); <br />
;Notes<br />
<br><br />
<br />
===SetPantogaphState===<br />
{{MethodHeader|public native void SetPantographState(int state)}} <br />
;Parameters<br />
*'''state''' = Value in the range 0 .. 3 to set the pantographs if this train has them. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetPantographState(3); <br />
;Notes<br />
*Use one of these values for ''state'':<br />
**0 = Both pantographs down.<br />
**1 = Front pantograph up.<br />
**2 = Rear pantograph up.<br />
**3 = Both pantographs up.<br />
<br><br />
<br />
===SetReverser===<br />
{{MethodHeader|public native void SetReverser(int mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Reverser Traction Modes|Reverser Traction Mode]] constants defining the required state of the train's reverser lever. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetReverser(Train.TRACTION_REVERSE); <br />
;Notes<br />
<br><br />
<br />
===SetTrainBrakes===<br />
{{MethodHeader|public native void SetTrainBrakes(float mode)}} <br />
;Parameters<br />
*'''mode''' = One of the [[#Train Brake States|Train Brake State]] constants defining the required state of the train's brakes. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainBrakes(Train.TRAIN_BRAKE_EMERGENCY); <br />
;Notes<br />
<br><br />
<br />
===SetTrainPriorityNumber===<br />
{{MethodHeader|public native void SetTrainPriority Number(int priority)}} <br />
;Parameters<br />
*'''priority''' = Priority value in the range 1 .. 3. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainPriorityNumber(2); <br />
;Notes<br />
*All trains and track sections can be assigned a priority value in the range of [1 - 3] with the default value being 2.<br />
*The priority value is not a numerical scale of precedence, but a value for the AI driver to attempt to match.<br />
*This means the driver will ''prefer'' track sections that have a priority equal to that of the train.<br />
*Changing the priority of the train only takes affect when the driver restarts a new schedule.<br />
<br><br />
<br />
===SetTrainTimetable===<br />
{{MethodHeader|public void SetTrainTimetable(TrainTimetable timetable)}} <br />
;Parameters<br />
*'''timetable''' = Assigns the specified timetable to this train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetTrainTimetable(timetable);<br />
;Notes<br />
*This train must not already have a TrainTimetable assigned.<br />
*To ensure that this proviso is met, use [[#ClearTrainTimetabel|ClearTrainTimetable()]] prior to calling this method.<br />
*It is the responsibility of the caller to post a "TrainTimetable","Touch" message after calling this function.<br />
<br><br />
<br />
===SetVelocity===<br />
{{MethodHeader|public native void SetVelocity(float velocity)}} <br />
;Parameters<br />
*'''velocity''' = Velocity to apply to the train, in metres per second.<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SetVelocity(0.0); // stops the train, subject to braking performance. <br />
;Notes<br />
<br><br />
<br />
===ShowInConsistMenu===<br />
{{MethodHeader|public native void ShowInConsistMenu(bool show)}} <br />
;Parameters<br />
*'''show''' = True to make this train visible to the in-game consist menu, false to hide it. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ShowInConsistMenu(false); <br />
;Notes<br />
<br><br />
<br />
===SoundHorn===<br />
{{MethodHeader|public native void SoundHorn(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.SoundHorn(); <br />
;Notes<br />
*Sounds the horn or whictle for all locomotives in this train.<br />
<br><br />
<br />
===StopSchedule===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any).<br />
<br><br />
<br />
===StopScheduleAndWait===<br />
{{MethodHeader|public void StopSchedule(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopSchedule(); <br />
;Notes<br />
*This method stops the Schedule this train is currently running (if any) and waits until the train's schedule actually stops before returning. <br />
*If the train is not running a schedule, the method returns after broadcasting a "Schedule","Touch" message, in case someone is listening for schedule messages.<br />
<br><br />
<br />
===StopTrainGently===<br />
{{MethodHeader|public native void StopTrainGently(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.StopTrainGently(); <br />
;Notes<br />
*Brings the train to a halt over a short time period.<br />
<br><br />
<br />
===TakePermitOnTrack===<br />
{{MethodHeader|public Permit[ ] TakePermitOnTrack(bool direction)}} <br />
;Parameters<br />
*'''direction''' = Direction relative to the train in which to take out permits. <br />
;Returned Value<br />
*An array including any permits taken which have not yet been granted to this train. Some of these permits may not yet have been granted. <br />
;Syntax<br />
Permit[] permits = train.TakePermitOnTrack(true); <br />
;Notes<br />
*Gets permits on the current track in the given direction.<br />
<br><br />
<br />
===TestTrackPermit===<br />
{{MethodHeader|public native bool TestTrackPermit(Permit permit, bool innerOnly)}} <br />
;Parameters<br />
*'''permit''' = An existing Permit object.<br />
*'''innerOnly''' = If true the method will test only the inner radius, if false the default radius of 150 metres will be used.<br />
;Returned Value<br />
*True if this train is within the track controlled by ''permit'', false otherwise. <br />
;Syntax<br />
bool ownPermit = train.TestTrackPermit(permit1,false); <br />
;Notes<br />
*The method generates an exception if the ''permit'' parameter does not refer to a track.<br />
<br><br />
<br />
===ToggleScheduleWindow===<br />
{{MethodHeader|public void ToggleScheduleWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleScheduleWindow(); <br />
;Notes<br />
*If the schedule window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, UpdateScheduleWindow() is called to create it for display.<br />
<br><br />
<br />
===ToggleViewDetailsWindow===<br />
{{MethodHeader|public void ToggleViewDetailsWindow(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ToggleViewDetailsWindow(); <br />
;Notes<br />
*If the ViewDetails window is already open/visible, this method will destroy it.<br />
*Otherwise if the view details window is not visible, ViewDetails() is called to create it for display.<br />
<br><br />
<br />
===TrackSearch===<br />
{{MethodHeader|public native MapObject[ ] TrackSearch(bool direction, float distance)}} <br />
;Parameters<br />
*'''direction''' = Direction to search relative to the train's heading, true for forwards, false for backwards.<br />
*'''distance''' = Maximum search distance in metres. <br />
;Returned Value<br />
*An array of objects found along the track in the defined search direction, the array might be empty. <br />
;Syntax<br />
MapObject[] objects = train.TrackSearch(true,5000.0) // searches 5km forwards along the track. <br />
;Notes<br />
*Gets all of the Trackside and SceneryWithTrack objects on a length of track that is either in front of or behind this train. <br />
*Descendants of these classes are also returned.<br />
<br><br />
<br />
===TracksideIsInFront===<br />
{{MethodHeader|public bool TracksideIsInFront(Trackside obj, float range)}} <br />
;Parameters<br />
*'''obj''' = Trackside object to search for.<br />
*'''range''' = Mximum search distance. <br />
;Returned Value<br />
*True if the object is logically forward of this train, false otherwise. <br />
;Syntax<br />
bool found = train.TracksideIsInFront(signal1,500.0); <br />
;Notes<br />
<br><br />
<br />
===Turnaround===<br />
{{MethodHeader|public native void Turnaround(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.Turnaround(); <br />
;Notes<br />
*Reverses the logical direction of the train, ie changes its heading.<br />
*The physical direction of the vehicles is not altered but the throttle direction is reversed.<br />
*If the camera is focused on the train in tracking view when this method is called the camera's direction of view (relative to the map) will alter through 180 degrees.<br />
<br><br />
<br />
===UpdateScheduleWindow===<br />
{{MethodHeader|public void UpdateScheduleWindow(string vehicleName)}} <br />
;Parameters<br />
*'''vehicleName''' = Name of vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateScheduleWindow("brake2"); <br />
;Notes<br />
*Updates the schedule window from the given vehicle.<br />
<br><br />
<br />
===UpdateViewDetails===<br />
{{MethodHeader|public void UpdateViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetails(vehicle);<br />
;Notes<br />
*Called by Vehicle.UpdateViewDetails() when a vehicle's load has changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===UpdateViewDetailsLocomotive===<br />
{{MethodHeader|public void UpdateViewDetailsLocomotive(void)}} <br />
;Parameters<br />
*None<br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.UpdateViewDetailsLocomotive(vehicle);<br />
;Notes<br />
*Called by Locomotive.UpdateViewDetails() when any of the Locomotive's operating parameters have changed so that the train's detail window can be amended.<br />
<br><br />
<br />
===ViewDetails===<br />
{{MethodHeader|public void ViewDetails(Vehicle vehicle)}} <br />
;Parameters<br />
*'''vehicle''' = Reference to a vehicle within the train. <br />
;Returned Value<br />
*None <br />
;Syntax<br />
train.ViewDetails(vehicle); <br />
;Notes<br />
*This method is called by Vehicle.ViewDetails() when the user has requested to view the details of the consist.<br />
*It will create a Browser window listing information about the train including who the driver character is and the loads of all vehicles.<br />
<br><br />
<br />
===WasRunScheduleSuccessful===<br />
{{MethodHeader|public bool WasRunScheduleSuccessful(void)}} <br />
;Parameters<br />
*None <br />
;Returned Value<br />
*True if the most recently run schedule was successfully, false otherwise. <br />
;Syntax<br />
train.WasRunScheduleSuccessful(); <br />
;Notes<br />
<br><br />
<br />
==Code Examples==<br />
<br><br />
<br />
==Related Methods==<br />
[[Class TrainUtil#AreInTrain|TrainUtil.AreInTrain()]]<br><br />
[[Class TrainUtil#CreateTrainFromSoup|TrainUtil.CreateTrainFromSoup()]]<br><br />
[[Class TrainUtil#IsInTrain|TrainUtil.IsInTrain()]]<br><br />
[[Class World#CreateTrain|World.CreateTrain()]]<br><br />
[[Class World#DeleteTrain|World.DeleteTrain()]]<br><br />
[[Class World#GetTrainList|World.GetTrainList()]]<br><br />
<br><br />
<br />
==Categories==<br />
[[Category:Script Class]]</div>Ciceronmthttps://wiki.trainzsimulator.com/index.php?title=List_of_Standard_Messages&diff=20683List of Standard Messages2019-08-20T13:53:06Z<p>Ciceronmt: </p>
<hr />
<div>*[[TrainzScript Language Reference|API Hierarchy]]<br />
<br />
*This list is a first step towards documenting Trainz use of messages. It has been generated by scanning one or two copies of jetlog.txt from TC, together with the TC scripts folder and the TRS2006 copy of index.chm. There are probably many standard messages missing and there are some obscure ones listed. Please add anything that is missing. I will progressively link and document the list. <br />
__NOTOC__ __NOEDITSECTION__<br />
<br><br />
<br />
{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"<br />
|-<br />
|width="15"|<br />
|width="250"|Message<br />
|width="165"|Source & Destination<br />
|Purpose<br />
|<br />
{{IndexSplit|A}}<br />
|-<br />
|<br />
|[[Animation-Event Message|Animation-Event,''eventname'']]<br />
|meshobject > meshobject<br />
|Sent when an animation triggers an event. These events are included in *.kin files generated by Max when the 'Query for Event' box is checked during animation export. They are used to enable code to be executed in sync with animations.<br />
{{IndexSplit|B}}<br />
|-<br />
|<br />
|BaseIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|[[Browser Messages|Browser-Closed,''null'']]<br />
|browser > broadcast<br />
|Sent when any in game browser is closed.<br />
|-<br />
|<br />
|Browser-Key,ScriptObjectives<br />
|? > ?<br />
|Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?<br />
|-<br />
|<br />
|[[Browser Messages|Browser-URL,''live://linkname'']]<br />
|browser > broadcast<br />
|Sent when the user clicks in a link in a custom browser<br />
|-<br />
|<br />
|Build,Cancelled<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Completed<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
|-<br />
|<br />
|Build,Started<br />
|? > buildable<br />
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.<br />
{{IndexSplit|C}}<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Interior-Changed]]<br />
|new train? > broadcast<br />
|Sent when a different train is selected.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Target-Changed]]<br />
|new target? > broadcast<br />
|Sent when the camera selects a different target, may not be a train.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,External-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Internal-View]]<br />
|? > Broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Roaming-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|[[Camera Messages|Camera,Tracking-View]]<br />
|? > broadcast<br />
|Sent when the camera mode is changed.<br />
|-<br />
|<br />
|Check,Speed<br />
|vehicle > vehicle<br />
|Sent continuously to ensure that jetlog isn't allowed to remain legible :-)<br />
{{IndexSplit|D}}<br />
|-<br />
|<br />
|DriverCharacter,BoardedTrain<br />
|driver > broadcast<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|DriverCharacter,Created<br />
|driver > broadcast<br />
|Sent when a driver character is initialised<br />
|-<br />
|<br />
|DriverCharacter,LeftTrain<br />
|driver > broadcast<br />
|Sent when a driver leaves a train<br />
|-<br />
|<br />
|DriverDisplay,ResetTripMeter<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|DriverModule,DCC-Panel-Created]]<br />
|? > broadcast<br />
|Sent when driver selection widget has been created<br />
|-<br />
|<br />
|DriverSetup,CharactersDone<br />
|? > broadcast<br />
|Sent when driver characters have been initialised<br />
{{IndexSplit|G}}<br />
|-<br />
|<br />
|GenericIndustry,LoadComplete<br />
|industry > industry<br />
|Sent when an industry loading operation has completed<br />
|-<br />
|<br />
|GenericIndustry,ProcessComplete<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|H}}<br />
|-<br />
|<br />
|HandleTrain,Release<br />
|industry > train<br />
|Sent when an industry loading operation has completed<br />
{{IndexSplit|I}}<br />
|-<br />
|<br />
|[[Interface Messages|Interface,ClickSystemButton]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOff]]<br />
|? > broadcast<br />
|Sent when the minimap is opened<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,MapViewOn]]<br />
|? > broadcast<br />
|Sent when the minimap is closed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,New-Driver-Message]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Enter]]<br />
|object > broadcast<br />
|Sent on mouseover an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Mouse-Leave]]<br />
|? > broadcast<br />
|Sent on mouseout of an object<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]<br />
|? > broadcast<br />
|Sent when the interface units are changed<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-Interface]]<br />
|? > broadcast<br />
|Sent when the main HUD is turned on or off<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Left-Click]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]<br />
|<br />
|<br />
{{IndexSplit|J}}<br />
|-<br />
|<br />
|[[Object Messages|Junction,Enter]]<br />
|junction > train<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerEnter]]<br />
|junction > train<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,InnerLeave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Leave]]<br />
|junction > train<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Junction,Stopped]]<br />
|junction > train<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|Junction,Toggled<br />
|junction > broadcast<br />
|Sent when a junctionbase object is toggled<br />
{{IndexSplit|M}}<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Details]]<br />
|? > object<br />
|Sent when the user right-clicks an object and selects 'View Details' from the resulting menu, some assets provide a built-in browser in response to this message.<br />
|-<br />
|<br />
|[[MapObject Messages|MapObject,View-Schedule]]<br />
|? > ?<br />
|Sent when the user right-clicks an object and selects 'View Schedule' from the resulting menu. The vehicle must have a timetable for this menu item to be displayed.<br />
|-<br />
|<br />
|MeshObject-Click,*<br />
|<br />
|<br />
{{IndexSplit|O}}<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|crossing > crossing<br />
|Train has entered crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|crossing > crossing<br />
|Train has left crossing trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > junction<br />
|Sent when a train enters a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|train > junction<br />
|Sent when a train enters a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > junction<br />
|Sent when a train leaves a junction's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > junction<br />
|Sent when a train stops in a junction trigger area<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trackmark<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trackmark<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trackmark<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|train > trigger<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|train > trigger<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|train > trigger<br />
|Sent when a train stops at a trigger<br />
|-<br />
|<br />
|[[Object Messages|Object,Enter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerEnter]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,InnerLeave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|Object,Leave]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|Object,Stopped]]<br />
|vehicle > scenerywithtrack<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|OnlineAccess,ReceiveMessage<br />
|? > onlineaccess<br />
|Message awaiting collection<br />
|-<br />
|<br />
|OnlineAccess,StatusChange<br />
|? > onlineaccess<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,StatusChange<br />
|? > onlinegroup<br />
|Network status change<br />
|-<br />
|<br />
|OnlineGroup,UsersChange<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserRemoved,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserAdded,*<br />
|? > onlinegroup<br />
|Network users change<br />
|-<br />
|<br />
|OnlineGroup.UserStatus,*<br />
|? > onlinegroup<br />
|Network users change<br />
{{IndexSplit|P}}<br />
|-<br />
|<br />
|Permit,Granted<br />
|? > objectrequesting<br />
|Sent when a track or junction permit is granted<br />
|-<br />
|<br />
|PortalTunnel,EmitTrain<br />
|portal > portal<br />
|Sent when a portal produces a train<br />
|-<br />
|<br />
|[[pfx Message|pfx,''particledata'']]<br />
|script > object<br />
|Sent by script to control particle effects<br />
|-<br />
|<br />
|Process-Start,''processname''<br />
|industry > industry<br />
|Sent when an industry process has started<br />
|-<br />
|<br />
|Process-Stop,''processname''<br />
|industry > industry<br />
|Sent when an industry process has completed<br />
{{IndexSplit|S}}<br />
|-<br />
|<br />
|Scenario,KillMonitor<br />
|? > ?<br />
|Sent to terminate a scenario thread<br />
|-<br />
|<br />
|Scenario,Quit<br />
|? > ?<br />
|Sent to terminate a scenario<br />
|-<br />
|<br />
|ScenarioBehaviour,Touch<br />
|? > ?<br />
|Called on a parent rule when the child rule completes. May also indicate other state changes.<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Enter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerEnter]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle enters a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,InnerLeave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's inner area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Leave]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a vehicle leaves a scenery trigger's outer area<br />
|-<br />
|<br />
|[[Object Messages|SceneryTrigger,Stopped]]<br />
|scenerywithtrack > vehicle<br />
|Sent when a train stops in a scenery trigger<br />
|-<br />
|<br />
|Schedule,Abort<br />
|train > train<br />
|Sent when a command schedule is abandoned<br />
|-<br />
|<br />
|Schedule,Complete<br />
|train > broadcast<br />
|Sent when a command schedule is completed<br />
|-<br />
|<br />
|Schedule,Touch<br />
|train > train<br />
|Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.<br />
|-<br />
|<br />
|[[Signal Messages|Signal,StateChanged]]<br />
|signal > broadcast<br />
|Signal aspect has changed<br />
|-<br />
|<br />
|StationMain.Timer,Tick<br />
|station > station<br />
|Sent by stations to initiate a periodic update<br />
{{IndexSplit|T}}<br />
|-<br />
|<br />
|Timer,Tick<br />
|? > ?<br />
|A common custom message used by various scripts to implement timed polling.<br />
|-<br />
|<br />
|Timetable,<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Enter]]<br />
|trackmark > train<br />
|Sent when a train enters a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Leave]]<br />
|trackmark > train<br />
|Sent when a train leaves a trackmark<br />
|-<br />
|<br />
|[[Object Messages|Trackmark,Stopped]]<br />
|trackmark > train<br />
|Sent when a train stops at a trackmark<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal]]<br />
|signal > train<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Entered red signal notify]]<br />
|train > broadcast<br />
|Train has entered signal<br />
|-<br />
|<br />
|[[Signal Messages|Train,Passed Signal]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Over speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under advisory speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the current advisory speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Over floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train exceeds the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Under floating speed limit]]<br />
|train > broadcast<br />
|Sent when a train slows below the floating speed limit.<br />
|-<br />
|<br />
|[[Train Messages|Train,Cleanup]]<br />
|? > ?<br />
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.<br />
|-<br />
|<br />
|[[Train Messages|Train,Deleted]]<br />
|train > ?<br />
|Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.<br />
|-<br />
|<br />
|Train,ThreadAITrainStoppedMovingFailed<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to enter the expected junction.<br />
|-<br />
|<br />
|Train,CommandCoupleVehicleTimer<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.<br />
|-<br />
|<br />
|Train,CommandReverseTrain.Pulse<br />
|train > train<br />
|Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.<br />
|-<br />
|<br />
|[[Train Messages|Train,DriverBoarded]]<br />
|train > driver<br />
|Sent when a driver boards a train<br />
|-<br />
|<br />
|Train,NotifyBell<br />
|train > train<br />
|Sent when the interface bell button is clicked. Does not work since build 4.3<br />
|-<br />
|<br />
|Train,NotifyHeadlights<br />
|train > train<br />
|Sent when the interface headlight button is clicked. Does not work since build 4.3<br />
|-<br />
|<br />
|Train,NotifyHorn<br />
|train > train<br />
|Sent when the interface horn button is clicked<br />
|-<br />
|<br />
|Train,NotifyPantographs<br />
|train > train<br />
|Sent when the interface pantograph button is clicked. Does not work since build 4.3<br />
|-<br />
|<br />
|Train,NotifySanding<br />
|<br />
|Does not work since build 4.3<br />
|-<br />
|<br />
|Train,TurnAround<br />
|<br />
|Does not work since build 4.3<br />
|-<br />
|<br />
|[[Train Messages|Train,ReachedTarget]]<br />
|? > ?<br />
|Sent by Trainz when a train reaches the specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,SlowingForTarget]]<br />
|train > train<br />
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Apply]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,Handbrake-Release]]<br />
|<br />
|<br />
|-<br />
|<br />
|[[Train Messages|Train,StartedMoving]]<br />
|train > train<br />
|Sent when a train starts to move<br />
|-<br />
|<br />
|[[Train Messages|Train,StoppedMoving]]<br />
|train > train<br />
|Sent when a train stops<br />
|-<br />
|<br />
|[[Train Messages|Train,ThrottleChanged]]<br />
|<br />
|<br />
|-<br />
|<br />
|Train,Tick<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,EnterTrack]]<br />
|track > train<br />
|Sent when a train enters a track section<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerEnterTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,InnerLeaveTrack]]<br />
|track > train<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Train,LeaveTrack]]<br />
|track > train<br />
|Sent when a train leaves a track section<br />
|-<br />
|<br />
|Train.ThreadAITrainStuck,Touch<br />
|train > train<br />
|?<br />
|-<br />
|<br />
|TrainTimetable,Touch<br />
|? > ?<br />
|?<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Enter]]<br />
|trigger > train<br />
|Sent when a train enters a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Leave]]<br />
|trigger > train<br />
|Sent when a train leaves a trigger<br />
|-<br />
|<br />
|[[Object Messages|Trigger,Stopped]]<br />
|trigger > train<br />
|Sent when a train stops at a trigger<br />
{{IndexSplit|V}}<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,BadCouple]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples at excessive speed<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Collided]]<br />
|vehicle > broadcast<br />
|Sent on a collision between vehicles<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Coupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle couples to another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Decoupled]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle uncouples from another<br />
|-<br />
|<br />
|[[Vehicle Messages|Vehicle,Derailed]]<br />
|vehicle > broadcast<br />
|Sent when a vehicle is derailed<br />
|-<br />
|<br />
|Vehicle,LoadComplete<br />
|industry > vehicle<br />
|Sent when loading of a vehicle from an industry is complete<br />
|-<br />
|<br />
|Vehicle,Coupler breakage<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler breakage notify<br />
|<br />
|<br />
|-<br />
|<br />
|Vehicle,Coupler Repaired<br />
|<br />
|<br />
{{IndexSplit|W}}<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]<br />
|waybillmanager > broadcast<br />
|?<br />
|-<br />
|<br />
|[[ModuleInit Message|World,ModuleInit]]<br />
|? > broadcast<br />
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes<br />
|-<br />
|<br />
|World,Paused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Unpaused<br />
|? > broadcast<br />
|?<br />
|-<br />
|<br />
|World,Day<br />
|? > broadcast<br />
|Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver<br />
|-<br />
|<br />
|World,Night<br />
|? > broadcast<br />
|Sent 1.) at ca. 18:15 ~ 0.260611 GameTime 2.) whenever TS starts Driver or Surveyor and Playtime is beween 18:15 and 05:45 3.) sometimes when TS switched to Driver or Surveyor<br />
|}</div>Ciceronmt