List of Standard Messages

2009-04-04T22:22:28Z

Klapec:

*[[TrainzScript Langage 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.
__NOTOC__ __NOEDITSECTION__
<br>

{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"
|-
|width="15"|
|width="250"|Message
|width="165"|Source & Destination
|Purpose
|
{{IndexSplit|A}}
|-
|
|[[Animation-Event Message|Animation-Event,''eventname'']]
|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.
{{IndexSplit|B}}
|-
|
|BaseIndustry,LoadComplete
|industry > industry
|Sent when an industry loading operation has completed
|-
|
|[[Browser Messages|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 Messages|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.
{{IndexSplit|C}}
|-
|
|[[Camera Messages|Camera,Interior-Changed]]
|new train? > broadcast
|Sent when a different train is selected.
|-
|
|[[Camera Messages|Camera,Target-Changed]]
|new target? > broadcast
|Sent when the camera selects a different target, may not be a train.
|-
|
|[[Camera Messages|Camera,External-View]]
|? > broadcast
|Sent when the camera mode is changed.
|-
|
|[[Camera Messages|Camera,Internal-View]]
|? > Broadcast
|Sent when the camera mode is changed.
|-
|
|[[Camera Messages|Camera,Roaming-View]]
|? > broadcast
|Sent when the camera mode is changed.
|-
|
|[[Camera Messages|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 :-)
{{IndexSplit|D}}
|-
|
|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
|-
|
|[[Interface Messages|DriverModule,DCC-Panel-Created]]
|? > broadcast
|Sent when driver selection widget has been created
|-
|
|DriverSetup,CharactersDone
|? > broadcast
|Sent when driver characters have been initialised
{{IndexSplit|G}}
|-
|
|GenericIndustry,LoadComplete
|industry > industry
|Sent when an industry loading operation has completed
|-
|
|GenericIndustry,ProcessComplete
|industry > industry
|Sent when an industry process has completed
{{IndexSplit|H}}
|-
|
|HandleTrain,Release
|industry > train
|Sent when an industry loading operation has completed
{{IndexSplit|I}}
|-
|
|[[Interface Messages|Interface-Event,MapViewOff]]
|? > broadcast
|Sent when the minimap is opened
|-
|
|[[Interface Messages|Interface-Event,MapViewOn]]
|? > broadcast
|Sent when the minimap is closed
|-
|
|[[Interface Messages|Interface-Event,Mouse-Enter]]
|object > broadcast
|Sent on mouseover an object
|-
|
|[[Interface Messages|Interface-Event,Mouse-Leave]]
|? > broadcast
|Sent on mouseout of an object
|-
|
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]
|? > broadcast
|Sent when the interface units are changed
|-
|
|[[Interface Messages|Interface-Event,Toggle-Interface]]
|? > broadcast
|Sent when the main HUD is turned on or off
{{IndexSplit|J}}
|-
|
|[[Object Messages|Junction,Enter]]
|junction > train
|Sent when a train enters a junction's outer area
|-
|
|[[Object Messages|Junction,InnerEnter]]
|junction > train
|Sent when a train enters a junction's inner area
|-
|
|[[Object Messages|Junction,InnerLeave]]
|junction > train
|Sent when a train leaves a junction's inner area
|-
|
|[[Object Messages|Junction,Leave]]
|junction > train
|Sent when a train leaves a junction's outer area
|-
|
|[[Object Messages|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
{{IndexSplit|M}}
|-
|
|[[MapObject Messages|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 Messages|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.
{{IndexSplit|O}}
|-
|
|[[Object Messages|Object,Enter]]
|crossing > crossing
|Train has entered crossing trigger area
|-
|
|[[Object Messages|Object,Leave]]
|crossing > crossing
|Train has left crossing trigger area
|-
|
|[[Object Messages|Object,Enter]]
|train > junction
|Sent when a train enters a junction's outer area
|-
|
|[[Object Messages|Object,InnerEnter]]
|train > junction
|Sent when a train enters a junction's inner area
|-
|
|[[Object Messages|Object,InnerLeave]]
|train > junction
|Sent when a train leaves a junction's inner area
|-
|
|[[Object Messages|Object,Leave]]
|train > junction
|Sent when a train leaves a junction's outer area
|-
|
|[[Object Messages|Object,Stopped]]
|train > junction
|Sent when a train stops in a junction trigger area
|-
|
|[[Object Messages|Object,Enter]]
|train > trackmark
|Sent when a train enters a trackmark
|-
|
|[[Object Messages|Object,Leave]]
|train > trackmark
|Sent when a train leaves a trackmark
|-
|
|[[Object Messages|Object,Stopped]]
|train > trackmark
|Sent when a train stops at a trackmark
|-
|
|[[Object Messages|Object,Enter]]
|train > trigger
|Sent when a train enters a trigger
|-
|
|[[Object Messages|Object,Leave]]
|train > trigger
|Sent when a train leaves a trigger
|-
|
|[[Object Messages|Object,Stopped]]
|train > trigger
|Sent when a train stops at a trigger
|-
|
|[[Object Messages|Object,Enter]]
|vehicle > scenerywithtrack
|Sent when a vehicle enters a scenery trigger's outer area
|-
|
|[[Object Messages|Object,InnerEnter]]
|vehicle > scenerywithtrack
|Sent when a vehicle enters a scenery trigger's inner area
|-
|
|[[Object Messages|Object,InnerLeave]]
|vehicle > scenerywithtrack
|Sent when a vehicle leaves a scenery trigger's inner area
|-
|
|[[Object Messages|Object,Leave]]
|vehicle > scenerywithtrack
|Sent when a vehicle leaves a scenery trigger's outer area
|-
|
|[[Object Messages|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
{{IndexSplit|P}}
|-
|
|Permit,Granted
|? > objectrequesting
|Sent when a track or junction permit is granted
|-
|
|PortalTunnel,EmitTrain
|portal > portal
|Sent when a portal produces a train
|-
|
|[[pfx Message|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
{{IndexSplit|S}}
|-
|
|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.
|-
|
|[[Object Messages|SceneryTrigger,Enter]]
|scenerywithtrack > vehicle
|Sent when a vehicle enters a scenery trigger's outer area
|-
|
|[[Object Messages|SceneryTrigger,InnerEnter]]
|scenerywithtrack > vehicle
|Sent when a vehicle enters a scenery trigger's inner area
|-
|
|[[Object Messages|SceneryTrigger,InnerLeave]]
|scenerywithtrack > vehicle
|Sent when a vehicle leaves a scenery trigger's inner area
|-
|
|[[Object Messages|SceneryTrigger,Leave]]
|scenerywithtrack > vehicle
|Sent when a vehicle leaves a scenery trigger's outer area
|-
|
|[[Object Messages|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 Messages|Signal,StateChanged]]
|signal > broadcast
|Signal aspect has changed
|-
|
|StationMain.Timer,Tick
|station > station
|Sent by stations to initiate a periodic update
{{IndexSplit|T}}
|-
|
|Timer,Tick
|? > ?
|A common custom message used by various scripts to implement timed polling.
|-
|
|Timetable,
|? > ?
|?
|-
|
|[[Object Messages|Trackmark,Enter]]
|trackmark > train
|Sent when a train enters a trackmark
|-
|
|[[Object Messages|Trackmark,Leave]]
|trackmark > train
|Sent when a train leaves a trackmark
|-
|
|[[Object Messages|Trackmark,Stopped]]
|trackmark > train
|Sent when a train stops at a trackmark
|-
|
|[[Signal Messages|Train,Entered red signal]]
|signal > train
|Train has entered signal
|-
|
|[[Signal Messages|Train,Entered red signal notify]]
|train > broadcast
|Train has entered signal
|-
|
|[[Train Messages|Train,Over speed limit]]
|train > broadcast
|Sent when a train exceeds the current speed limit.
|-
|
|[[Train Messages|Train,Under speed limit]]
|train > broadcast
|Sent when a train slows below the current speed limit.
|-
|
|[[Train Messages|Train,Over advisory speed limit]]
|train > broadcast
|Sent when a train exceeds the current advisory speed limit.
|-
|
|[[Train Messages|Train,Under advisory speed limit]]
|train > broadcast
|Sent when a train slows below the current advisory speed limit.
|-
|
|[[Train Messages|Train,Over floating speed limit]]
|train > broadcast
|Sent when a train exceeds the floating speed limit.
|-
|
|[[Train Messages|Train,Under floating speed limit]]
|train > broadcast
|Sent when a train slows below the floating speed limit.
|-
|
|[[Train Messages|Train,Cleanup]]
|? > ?
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.
|-
|
|[[Train Messages|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 Messages|Train,DriverBoarded]]
|train > driver
|Sent when a driver boards a train
|-
|
|Train,NotifyBell
|train > train
|Sent when the interface bell button is clicked
|-
|
|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 Messages|Train,ReachedTarget]]
|? > ?
|Sent by Trainz when a train reaches the specified Autopilot Target Position.
|-
|
|[[Train Messages|Train,SlowingForTarget]]
|train > train
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.
|-
|
|[[Train Messages|Train,StartedMoving]]
|train > train
|Sent when a train starts to move
|-
|
|[[Train Messages|Train,StoppedMoving]]
|train > train
|Sent when a train stops
|-
|
|Train,Tick
|train > train
|?
|-
|
|[[Object Messages|Train,EnterTrack]]
|track > train
|Sent when a train enters a track section
|-
|
|[[Object Messages|Train,InnerEnterTrack]]
|track > train
|?
|-
|
|[[Object Messages|Train,InnerLeaveTrack]]
|track > train
|?
|-
|
|[[Object Messages|Train,LeaveTrack]]
|track > train
|Sent when a train leaves a track section
|-
|
|Train.ThreadAITrainStuck,Touch
|train > train
|?
|-
|
|TrainTimetable,Touch
|? > ?
|?
|-
|
|[[Object Messages|Trigger,Enter]]
|trigger > train
|Sent when a train enters a trigger
|-
|
|[[Object Messages|Trigger,Leave]]
|trigger > train
|Sent when a train leaves a trigger
|-
|
|[[Object Messages|Trigger,Stopped]]
|trigger > train
|Sent when a train stops at a trigger
{{IndexSplit|V}}
|-
|
|[[Vehicle Messages|Vehicle,BadCouple]]
|vehicle > broadcast
|Sent when a vehicle couples at excessive speed
|-
|
|[[Vehicle Messages|Vehicle,Collided]]
|vehicle > broadcast
|Sent on a collision between vehicles
|-
|
|[[Vehicle Messages|Vehicle,Coupled]]
|vehicle > broadcast
|Sent when a vehicle couples to another
|-
|
|[[Vehicle Messages|Vehicle,Decoupled]]
|vehicle > broadcast
|Sent when a vehicle uncouples from another
|-
|
|[[Vehicle Messages|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
{{IndexSplit|W}}
|-
|
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]
|waybillmanager > broadcast
|?
|-
|
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]
|waybillmanager > broadcast
|?
|-
|
|[[ModuleInit Message|World,ModuleInit]]
|? > broadcast
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes
|-
|
|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
|}

TrainzOnline - User contributions [en]

List of Standard Messages