List of Standard Messages

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (1 revision)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
*[[TrainzScript Langage Reference|API Hierarchy]]
+
*[[TrainzScript Language Reference|API Hierarchy]]
  
 
*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.  
 
*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.  
Line 17: Line 17:
 
|[[Animation-Event Message|Animation-Event,''eventname'']]
 
|[[Animation-Event Message|Animation-Event,''eventname'']]
 
|meshobject > meshobject
 
|meshobject > meshobject
−
|Sent when an animation triggers an event. These events are included in *.kin files generated by max or gmax when the 'Query for Event' box is checked during animation export.  They are used to enable code to be executed in sync with animations.
+
|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.
 
{{IndexSplit|B}}
 
{{IndexSplit|B}}
 
|-
 
|-
Line 106: Line 106:
 
|driver > broadcast
 
|driver > broadcast
 
|Sent when a driver leaves a train
 
|Sent when a driver leaves a train
 +
|-
 +
|
 +
|DriverDisplay,ResetTripMeter
 +
|
 +
|
 
|-
 
|-
 
|
 
|
Line 134: Line 139:
 
|Sent when an industry loading operation has completed
 
|Sent when an industry loading operation has completed
 
{{IndexSplit|I}}
 
{{IndexSplit|I}}
 +
|-
 +
|
 +
|[[Interface Messages|Interface,ClickSystemButton]]
 +
|
 +
|
 
|-
 
|-
 
|
 
|
Line 144: Line 154:
 
|? > broadcast
 
|? > broadcast
 
|Sent when the minimap is closed
 
|Sent when the minimap is closed
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]
 +
|
 +
|
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]
 +
|
 +
|
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,New-Driver-Message]]
 +
|
 +
|
 
|-
 
|-
 
|
 
|
Line 164: Line 189:
 
|? > broadcast
 
|? > broadcast
 
|Sent when the main HUD is turned on or off
 
|Sent when the main HUD is turned on or off
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]
 +
|
 +
|
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]
 +
|
 +
|
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]
 +
|
 +
|
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Left-Click]]
 +
|
 +
|
 +
|-
 +
|
 +
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]
 +
|
 +
|
 
{{IndexSplit|J}}
 
{{IndexSplit|J}}
 
|-
 
|-
Line 206: Line 256:
 
|? > ?
 
|? > ?
 
|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.
 
|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.
 +
|-
 +
|
 +
|MeshObject-Click,*
 +
|
 +
|
 
{{IndexSplit|O}}
 
{{IndexSplit|O}}
 
|-
 
|-
Line 315: Line 370:
 
|
 
|
 
|OnlineGroup,UsersChange
 
|OnlineGroup,UsersChange
 +
|? > onlinegroup
 +
|Network users change
 +
|-
 +
|
 +
|OnlineGroup.UserRemoved,*
 +
|? > onlinegroup
 +
|Network users change
 +
|-
 +
|
 +
|OnlineGroup.UserAdded,*
 +
|? > onlinegroup
 +
|Network users change
 +
|-
 +
|
 +
|OnlineGroup.UserStatus,*
 
|? > onlinegroup
 
|? > onlinegroup
 
|Network users change
 
|Network users change
Line 445: Line 515:
 
|train > broadcast
 
|train > broadcast
 
|Train has entered signal
 
|Train has entered signal
 +
|-
 +
|
 +
|[[Signal Messages|Train,Passed Signal]]
 +
|
 +
|
 
|-
 
|-
 
|
 
|
Line 509: Line 584:
 
|Train,NotifyBell
 
|Train,NotifyBell
 
|train > train
 
|train > train
−
|Sent when the interface bell button is clicked
+
|Sent when the interface bell button is clicked.
 +
|-
 +
|
 +
|Train,BrakeLightChanged
 +
|train > ?
 +
|Sent if the train's brake is moved to Modes 0 or from Modes 0.
 +
|-
 +
|
 +
|Train,ThrottleChanged
 +
|train > ?
 +
|Sent if throttle position changes.
 
|-
 
|-
 
|
 
|
 
|Train,NotifyHeadlights
 
|Train,NotifyHeadlights
 
|train > train
 
|train > train
−
|Sent when the interface headlight button is clicked
+
|Sent when the interface headlight button is clicked.
 
|-
 
|-
 
|
 
|
Line 524: Line 609:
 
|Train,NotifyPantographs
 
|Train,NotifyPantographs
 
|train > train
 
|train > train
−
|Sent when the interface pantograph button is clicked
+
|Sent when the interface pantograph button is clicked.
 +
|-
 +
|
 +
|Train,NotifySanding
 +
|
 +
|
 +
|-
 +
|
 +
|Train,TurnAround
 +
|
 +
|
 
|-
 
|-
 
|
 
|
Line 535: Line 630:
 
|train > train
 
|train > train
 
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.
 
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.
 +
|-
 +
|
 +
|[[Train Messages|Train,Handbrake-Apply]]
 +
|
 +
|It works?
 +
|-
 +
|
 +
|[[Train Messages|Train,Handbrake-Release]]
 +
|
 +
|It works?
 
|-
 
|-
 
|
 
|
Line 626: Line 731:
 
|industry > vehicle
 
|industry > vehicle
 
|Sent when loading of a vehicle from an industry is complete
 
|Sent when loading of a vehicle from an industry is complete
 +
|-
 +
|
 +
|Vehicle,Coupler breakage
 +
|
 +
|
 +
|-
 +
|
 +
|Vehicle,Coupler breakage notify
 +
|
 +
|
 +
|-
 +
|
 +
|Vehicle,Coupler Repaired
 +
|
 +
|
 
{{IndexSplit|W}}
 
{{IndexSplit|W}}
 
|-
 
|-
Line 642: Line 762:
 
|? > broadcast
 
|? > broadcast
 
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes
 
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes
 +
|-
 +
|
 +
|World,Paused
 +
|? > broadcast
 +
|?
 
|-
 
|-
 
|
 
|

Latest revision as of 23:43, 14 September 2019

  • 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.


Message Source & Destination Purpose

A

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Animation-Event,eventname meshobject > meshobject 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.

B

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
BaseIndustry,LoadComplete industry > industry Sent when an industry loading operation has completed
Browser-Closed,null browser > broadcast Sent when any in game browser is closed.
Browser-Key,ScriptObjectives ? > ? Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?
Browser-URL,live://linkname browser > broadcast Sent when the user clicks in a link in a custom browser
Build,Cancelled ? > buildable 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.
Build,Completed ? > buildable 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.
Build,Started ? > buildable 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.

C

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Camera,Interior-Changed new train? > broadcast Sent when a different train is selected.
Camera,Target-Changed new target? > broadcast Sent when the camera selects a different target, may not be a train.
Camera,External-View ? > broadcast Sent when the camera mode is changed.
Camera,Internal-View ? > Broadcast Sent when the camera mode is changed.
Camera,Roaming-View ? > broadcast Sent when the camera mode is changed.
Camera,Tracking-View ? > broadcast Sent when the camera mode is changed.
Check,Speed vehicle > vehicle Sent continuously to ensure that jetlog isn't allowed to remain legible :-)

D

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
DriverCharacter,BoardedTrain driver > broadcast Sent when a driver boards a train
DriverCharacter,Created driver > broadcast Sent when a driver character is initialised
DriverCharacter,LeftTrain driver > broadcast Sent when a driver leaves a train
DriverDisplay,ResetTripMeter
DriverModule,DCC-Panel-Created ? > broadcast Sent when driver selection widget has been created
DriverSetup,CharactersDone ? > broadcast Sent when driver characters have been initialised

G

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
GenericIndustry,LoadComplete industry > industry Sent when an industry loading operation has completed
GenericIndustry,ProcessComplete industry > industry Sent when an industry process has completed

H

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
HandleTrain,Release industry > train Sent when an industry loading operation has completed

I

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Interface,ClickSystemButton
Interface-Event,MapViewOff ? > broadcast Sent when the minimap is opened
Interface-Event,MapViewOn ? > broadcast Sent when the minimap is closed
Interface-Event,Minimap-Mouse-Enter
Interface-Event,Minimap-Mouse-Leave
Interface-Event,New-Driver-Message
Interface-Event,Mouse-Enter object > broadcast Sent on mouseover an object
Interface-Event,Mouse-Leave ? > broadcast Sent on mouseout of an object
Interface-Event,Set-Metric-Mode ? > broadcast Sent when the interface units are changed
Interface-Event,Toggle-Interface ? > broadcast Sent when the main HUD is turned on or off
Interface-Event,Toggle-ButtonBar
Interface-Event,Toggle-CustomHUD
Interface-Event,Toggle-VehicleControls
Interface-Event,Left-Click
Interface-Event,Surveyor-Left-Click

J

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Junction,Enter junction > train Sent when a train enters a junction's outer area
Junction,InnerEnter junction > train Sent when a train enters a junction's inner area
Junction,InnerLeave junction > train Sent when a train leaves a junction's inner area
Junction,Leave junction > train Sent when a train leaves a junction's outer area
Junction,Stopped junction > train Sent when a train stops in a junction trigger area
Junction,Toggled junction > broadcast Sent when a junctionbase object is toggled

M

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
MapObject,View-Details ? > object 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.
MapObject,View-Schedule ? > ? 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.
MeshObject-Click,*

O

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Object,Enter crossing > crossing Train has entered crossing trigger area
Object,Leave crossing > crossing Train has left crossing trigger area
Object,Enter train > junction Sent when a train enters a junction's outer area
Object,InnerEnter train > junction Sent when a train enters a junction's inner area
Object,InnerLeave train > junction Sent when a train leaves a junction's inner area
Object,Leave train > junction Sent when a train leaves a junction's outer area
Object,Stopped train > junction Sent when a train stops in a junction trigger area
Object,Enter train > trackmark Sent when a train enters a trackmark
Object,Leave train > trackmark Sent when a train leaves a trackmark
Object,Stopped train > trackmark Sent when a train stops at a trackmark
Object,Enter train > trigger Sent when a train enters a trigger
Object,Leave train > trigger Sent when a train leaves a trigger
Object,Stopped train > trigger Sent when a train stops at a trigger
Object,Enter vehicle > scenerywithtrack Sent when a vehicle enters a scenery trigger's outer area
Object,InnerEnter vehicle > scenerywithtrack Sent when a vehicle enters a scenery trigger's inner area
Object,InnerLeave vehicle > scenerywithtrack Sent when a vehicle leaves a scenery trigger's inner area
Object,Leave vehicle > scenerywithtrack Sent when a vehicle leaves a scenery trigger's outer area
Object,Stopped vehicle > scenerywithtrack Sent when a train stops in a scenery trigger
OnlineAccess,ReceiveMessage ? > onlineaccess Message awaiting collection
OnlineAccess,StatusChange ? > onlineaccess Network status change
OnlineGroup,StatusChange ? > onlinegroup Network status change
OnlineGroup,UsersChange ? > onlinegroup Network users change
OnlineGroup.UserRemoved,* ? > onlinegroup Network users change
OnlineGroup.UserAdded,* ? > onlinegroup Network users change
OnlineGroup.UserStatus,* ? > onlinegroup Network users change

P

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Permit,Granted ? > objectrequesting Sent when a track or junction permit is granted
PortalTunnel,EmitTrain portal > portal Sent when a portal produces a train
pfx,particledata script > object Sent by script to control particle effects
Process-Start,processname industry > industry Sent when an industry process has started
Process-Stop,processname industry > industry Sent when an industry process has completed

S

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Scenario,KillMonitor ? > ? Sent to terminate a scenario thread
Scenario,Quit ? > ? Sent to terminate a scenario
ScenarioBehaviour,Touch ? > ? Called on a parent rule when the child rule completes. May also indicate other state changes.
SceneryTrigger,Enter scenerywithtrack > vehicle Sent when a vehicle enters a scenery trigger's outer area
SceneryTrigger,InnerEnter scenerywithtrack > vehicle Sent when a vehicle enters a scenery trigger's inner area
SceneryTrigger,InnerLeave scenerywithtrack > vehicle Sent when a vehicle leaves a scenery trigger's inner area
SceneryTrigger,Leave scenerywithtrack > vehicle Sent when a vehicle leaves a scenery trigger's outer area
SceneryTrigger,Stopped scenerywithtrack > vehicle Sent when a train stops in a scenery trigger
Schedule,Abort train > train Sent when a command schedule is abandoned
Schedule,Complete train > broadcast Sent when a command schedule is completed
Schedule,Touch train > train Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.
Signal,StateChanged signal > broadcast Signal aspect has changed
StationMain.Timer,Tick station > station Sent by stations to initiate a periodic update

T

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Timer,Tick ? > ? A common custom message used by various scripts to implement timed polling.
Timetable, ? > ? ?
Trackmark,Enter trackmark > train Sent when a train enters a trackmark
Trackmark,Leave trackmark > train Sent when a train leaves a trackmark
Trackmark,Stopped trackmark > train Sent when a train stops at a trackmark
Train,Entered red signal signal > train Train has entered signal
Train,Entered red signal notify train > broadcast Train has entered signal
Train,Passed Signal
Train,Over speed limit train > broadcast Sent when a train exceeds the current speed limit.
Train,Under speed limit train > broadcast Sent when a train slows below the current speed limit.
Train,Over advisory speed limit train > broadcast Sent when a train exceeds the current advisory speed limit.
Train,Under advisory speed limit train > broadcast Sent when a train slows below the current advisory speed limit.
Train,Over floating speed limit train > broadcast Sent when a train exceeds the floating speed limit.
Train,Under floating speed limit train > broadcast Sent when a train slows below the floating speed limit.
Train,Cleanup ? > ? Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.
Train,Deleted train > ? Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.
Train,ThreadAITrainStoppedMovingFailed train > train Internal Train.gs implementation- sent when the AI fails to enter the expected junction.
Train,CommandCoupleVehicleTimer train > train Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.
Train,CommandReverseTrain.Pulse train > train Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.
Train,DriverBoarded train > driver Sent when a driver boards a train
Train,NotifyBell train > train Sent when the interface bell button is clicked.
Train,BrakeLightChanged train > ? Sent if the train's brake is moved to Modes 0 or from Modes 0.
Train,ThrottleChanged train > ? Sent if throttle position changes.
Train,NotifyHeadlights train > train Sent when the interface headlight button is clicked.
Train,NotifyHorn train > train Sent when the interface horn button is clicked
Train,NotifyPantographs train > train Sent when the interface pantograph button is clicked.
Train,NotifySanding
Train,TurnAround
Train,ReachedTarget ? > ? Sent by Trainz when a train reaches the specified Autopilot Target Position.
Train,SlowingForTarget train > train Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.
Train,Handbrake-Apply It works?
Train,Handbrake-Release It works?
Train,StartedMoving train > train Sent when a train starts to move
Train,StoppedMoving train > train Sent when a train stops
Train,Tick train > train ?
Train,EnterTrack track > train Sent when a train enters a track section
Train,InnerEnterTrack track > train ?
Train,InnerLeaveTrack track > train ?
Train,LeaveTrack track > train Sent when a train leaves a track section
Train.ThreadAITrainStuck,Touch train > train ?
TrainTimetable,Touch ? > ? ?
Trigger,Enter trigger > train Sent when a train enters a trigger
Trigger,Leave trigger > train Sent when a train leaves a trigger
Trigger,Stopped trigger > train Sent when a train stops at a trigger

V

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Vehicle,BadCouple vehicle > broadcast Sent when a vehicle couples at excessive speed
Vehicle,Collided vehicle > broadcast Sent on a collision between vehicles
Vehicle,Coupled vehicle > broadcast Sent when a vehicle couples to another
Vehicle,Decoupled vehicle > broadcast Sent when a vehicle uncouples from another
Vehicle,Derailed vehicle > broadcast Sent when a vehicle is derailed
Vehicle,LoadComplete industry > vehicle Sent when loading of a vehicle from an industry is complete
Vehicle,Coupler breakage
Vehicle,Coupler breakage notify
Vehicle,Coupler Repaired

W

 0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
WaybillManager,WaybillsWindowShown waybillmanager > broadcast ?
WaybillManager,WaybillsWindowHidden waybillmanager > broadcast ?
World,ModuleInit ? > broadcast Sent whenever TRS switches to Driver, Surveyor or Railyard modes
World,Paused ? > broadcast ?
World,Unpaused ? > broadcast ?
World,Day ? > broadcast Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver
World,Night ? > broadcast 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
Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=List_of_Standard_Messages&oldid=21344"
Personal tools