Session Rule List with Parameters

Revision as of 05:11, 19 September 2017

Session Rule List (Work in progress) Please Note: All rules are copyrighted by N3V Games

This is a list of the Trainz Session Rules: These rules can be copied and pasted to show how you're programming your Session

Achievement Rules

Achievement Check Rule This rule allows you to customize session gameplay based on whether the player has received an achievement

Advanced Industry Load Configuration: Names industry, lock train's controls?, overrides begin load and begin unload

 Target object	??	name of object such as Power Station, Coal Pit or Portal
 Lock train's controls	checked	during a stopped load/unload operation
 Override 'begin load' and 'begin unload'	checked	# of seconds to override

Multiple Resource Check: Checks resource for completion

Wait for the designated queues from choose fall below, reach/exceed Units number amount of units Products click choose from session list Add Object click choose from session list

Objective Add: Sets up a game Objective with ID and display Name

Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent Completion Target click to set target number Icon click choose from list Display Name click insert Name Unique Objective ID click set ID Custom Message insert typed message in text area

Objective Check: Executes child rules when objective is complete Unique Objective ID click insert ID number Mode click choose Wait for completion, Wait for failure, Wait for progress

Objective Update: Changes progress outcome according to Property choices Unique Objective ID click to set ID number Monday, September 18, 2017 Page 1 of 18 Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater Amount click insert number Power Station Rule Sets up Station and Consumers Power Station click to choose from session Stations Consumers(Add Object) click to choose from session list Ranked Session Begin Begins a ranked Session Countdown requires a Starting Value insert hrs., min,sec 1 through 5 stars, points for each star insert number of points Session timer mode fill-in chooses: Timer, Countdown, None Ranked Session Complete Completes the active ranked Session Set the active ranked session as fill-in choose: Complete, Failed Customize the completion message check insert text message Resource Check Check the progress of the amount of a resource and target object Watch industry queue or Watch vehicle fill-in choose one or the other Note: Both have: Target Object, Queue: click to choose Complete when designated queue fill-in equals or exceeds required amount, falls below required amount Session Complete Rule Set session to a percentage of completion Set session to percent complete click to insert number in percent Separate achievements for completion check Station Visited Check Rule Waits for any train to call at one of the designated stations Trigger click to choose from list Add Industry click to add from session list Accept all trains fill-in Accept trains matching specific criteria fill-in to choose from session list Danger Rules ATP Speed Limiter Limits speed over set limit speed limit over the set limit mph AWS Configuration This rule configures the Trainz implementation of AWS Use modern sound set for unfitted cabs? check Simulate AWS for unfitted cabs? check Passive with HUD hidden fill-in Active fill-in Passive fill-in Clean UP Derailed Trains Cleans up derailed train cars Set delay to clean up derailed train cars values Coupler Breakage Check Checks for breaking couplers. No parameters. None Coupler Breakage HUD HUD displays warning about coupler stress and breakage Show the Coupler Breakage Display fill-in must choose one or the other Hide the Coupler Breakage Display fill-in must choose one or the other Replace Missing Vehicles Rule Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule Respawn trains if they are abandoned check Respawn trains fill-in choose: at their original locations, from portals from Session List Safety System Engaged Check Rule Checks for safety systems making penalty applications on users Trigger only once check Safety System Isolated Check Rule Checks for safety systems being isolated by users Trigger only once check Set Coupler Masks Set the coupling/decoupling masks on the selected vehicles Add vehicle click to select from session list Coupling Mask, Decoupling Mask: click to select: lock or unlock Add All click to select all vehicle in session Delete All click to delete all vehicle from list Signal Passed At Danger Check Rule Checks for Drivers passing signals at danger Trigger only once check to set Speeding Check Rule Checks to see if player control trains are over the speed Watch for trains travelling above the fill-in Allow an over speed tolerance of click to insert mph over posted limit Watch for trains travelling above a fill-in to insert custom speed limit Warning: This method is very Vehicle Physics Overrides the default vehicle physics properties Accept all trains fill-in Cab sway level is set ? % click to insert percent of sway Traction boost is % ? while sanding click to insert percent of boost Tractions reduced to ? % while click to set traction percent Maximum tractive effort adjusted by ? click to insert percent amount Show coupler breakage in HUD check to set Couplers break when coupling above ? click to set speed Accept trains matching specific criteria fill-in to insert specific trains Couplers break at ? kN check to insert amount of force Wait for Derailment Waits for a derailment to occur Trigger derailment watch once check to set Navigation DestSignTable Table for creating a table of destination signs Enable Track Marks as destinations check Enable table of destinations check Import destination from texture-group. name Destination Name name Enable industries/stations as check Interlocking Tower Configure Path Alters settings on an interlocking tower path Interlocking Tower choose Name and Objects Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session Show path activation message in Driver check

Interlocking Tower Set Path Will set the state of an interlocking tower path for a train Interlocking Tower choose Names and Objects Multiple Junction Alignment Check Checks multiple junctions are in alignment Wait until the following junctions are choose all or anyone Add junction click add junction from session list Add all click add all junctions from session list Delete all click deletes all junctions from rule list Navigation Display Creates a navigation point Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any Note: See help icon for more Style click choose Required Stop, Automatic, Manual Display Text insert text Location click choose train vehicle from session list Train(optional) choose train from session list Unique set ID name must be lowercase and no spaces Icon click choose from list Navigation Point Complete Marks a navigation point complete Mark navigation point click set index number Complete in set click to set ID Navigation Set Check Checks if a navigation point is complete/incomplete Checks if navigation point is set click set ID Is click Complete, Incomplete Navigation Set Clear Clears a navigation point set Clear the navigation point set click to set ID Navigation Set Hide/Show Show or hide navigation point set The navigation point click hide, show Navigation point set click to set ID Schedule Rule Allows a schedule of timed events to be applied to a train Insert track mark click to select from session list

Note: Both has an arrival and departure set time hr:min:sec Current Train click to select from session list Insert destination click to select from session list Set Junctions Sets the selected junctions to a specific state Warning: not compatible with Interlocking Tower Assets Add Junction click to select session junction list Add All click Delete All click Warning: Not compatible with Set Signal Extended rule Warning: not compatible with Interlocking Tower Assets Set signal click to select from session list State ' to select state from list Trigger Check Waits for any train to enter one of the designated triggers Accept all trains fill-in Accept trains matching specific criteria fill-in to choose from session list Add Trigger click to choose from session list Trigger only once check to set Wait for child rules to complete even if check to set Only activate when the entering click to choose forward, backward Wait on Navigation Point Waits for a nav point to be complete Wait for navigation point ? click to choose from session list in set ? to be completed click to insert ID Wait on Train Stop/Start Wait for a train to stop or start Accept all trains fill-in to set Accept trains matching specific criteria fill-in to set and choose from session list Wait for a train that matches the click to choose: start moving, stop moving Trigger rule once check to set Note: One or the other fill-ins must be Drivers Control Type Sets control type Current control method is: Easy Mode, Choice one of the three

CPC: Emit Train Used to Emit Trains from the Central Portal Control on Triggered Events. Also works with the Un-Portal Rule Portal index form CPC value Use UnPortal Yes/No Delay from Trigger to Emit: Seconds value CPC: Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule Trigger add Trigger Portal index from PCP value Use UnPortal yes/no Delay from Trigger to Emit: seconds value Disable/Enable Industry Disables vehicle load/unload for industry Apply to every vehicle in the session fill-in Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles Note: One of the Applies will always be Load/Unload for industry Disable/Enable choose Industry Driver Command Specify which commands will be available for the drivers Navigate To Track mark- Driver Release Junction - Lets a driver release Notify- Notifies the player of schedule NavigateToTrackMarkList V2- No NavigateToStation V2- No description ReverseTram- Reverse a tram(max 2 Navigate Via Track mark- Driver UnCouplerFrom- A new Uncouple driver Navigate To- Allows a driver character Halt Train- Brings the train to a Run Around- Instructs the driver to Terminate Passenger Train- This station before using this command MoveTurntable- TRS2008: Move Unload- Unload train vehicles at current VR Set Train Lamps-Driver command WaitFor- Pauses the driver's schedule or WaitForRandom- TRS2008: Wait for WaitForTrigger- Tell a driver to wait WaitUntil- No description Set Max Speed To- No description Drive Via Track mark- Driver command Load- Loads the train's vehicles at the Cab Wait maintains current control state until some condition is met Change Destination Sign Changes signs of a train Couple- Couple train to designate Decouple- Decouples the train at the Delete Train- Causes the train and its Drive Schedule- Driver command that Drive To- Allows a driver character to Hornz- Driver sounds the train horn Drive to Track mark- Driver command Cab Set Control cab mode control Drive To Station V2- No description Drive To Track mark List V2- No Headlights On/Off-Allows the driver to Instant Load Command- Instantly load a Instant Load Locos- Instantly load all InstantUnload- Instantly unload a train- Interior Lights Command- Driver Drive To Industry- Drive to a specific Driver Command Check Verifies the driver commands of a driver character Wait for driver character to have add driver, all, delete all Trigger Rule once check Driver character to watch the name driver

Driver Main Menu Options Show the Driver Main Menu Bar The Driver Main Bar choice show/hide Driver Schedule Rule Execution of basic scheduled commands Note: Only one of the fill-in can be Driver Schedule Rule assigned to name driver Commands insert driver commands in Drive Schedule Classic style: If there is a schedule fill-in Killer style: If there is a schedule fill-in Cooperative style: If there is a schedule fill-in Active style: Emit a new schedule, only fill-in Driver Setup Create the list of drivers for this session and assign them their orders Generate new Drivers for empty check The following drivers will be available Driver's Name Add Remove all existing Drivers first check Enable/Disable Driver Commands Enable/Disable specific driver commands on certain drivers Assign Driver commands check Driver Commands Train criteria fill in all trains Train criteria list train only trains matching criteria MaxPermittedSpeed Controls AI behavior. When active AI Trains only go as fast as permitted Config/txt file tag 'max_permitted_speed-60850 in mph or kph Add to config.txt and kuid-table for value <KUID2:60850:88000:4 Note: Old root level config tag will QuickDrive rule Change the Session settings and add consists in Driver Set Time to insert time QuickDrive Consist Option List by Rate of Change insert rate as number times Enable gameplay Session Mode check Enable in game help by default check Set the default Control method to fill-in choose: Easy Mode, Realistic Mode

Prevent player from changing this check Realistic mode requires achievement add Achievement's Name In Asset choose Auran achievements Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic Prevent player from changing 10.0 check Set the default units to fill-in choose: Imperial, Metric, Default Open QuickDriver Window when check Wait for Driver On/Off Train Waits for a Driver to get off of a train Note: One or the other fill-ins must be Accept trains matching specific criteria fill-in to select from session list Accept all trains fill-in to set Trigger rule once check to set Wait for a driver character to get ? a click to select: On, Off Wait for Driver/Train to be Locally Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused Wait for ownership of a specific Driver fill-in to set Wait for ownership of Driver fill-in to set Note: One or the other fill-in must be Driver or Vehicle click to choose from session lists List Configurations Rules Control Check Rule Activates child rules based on the control method changes Excite child rules when: DCC mode is fill-in one or the other Excite child rules: Every time control fill-in one or the other Ordered List Child rules will be executed in order once this rule starts Note: One of the two must be chosen This process will repeat fill-in click to add number of repeats This process will repeat forever fill-in Progressive List The first child rule is executed on the first run, second child executed on second run, etc.

After last child run is executed click to choose: First child is chosen again, It will be used for all successive runs, Successive runs will do nothing Random List One of the child rules indented under this rule will be executed randomly Once one of the child rule is Reset List Resets and starts all child rules in an ongoing infinite cycle None Simultaneous List Child rules are executed simultaneously once this rules Rules completes when click choose all rules have reached completed state, was completed state Wait for HTML Pages Waits for the Display HTML Pages sequence browser to open/close a specific HTML Page Page name click to insert Page Name Note: One or the other fill-ins must be Close page fill-in to set named ? click to insert name One the page fill-in to open Trigger Rule Once check to set Wait on MiniMap Screen/Main Screen Waits for the MiniMap window to be opened Wait for the MiniMap window to be ? click to set: opened, closed Trigger Rule once check to set Camera Rules Cinematic Camera Provides several different cinematic style cameras Lock camera controls for the duration check Prevent rain control for duration check Camera target: name any of the many objects in session Camera mode: Stationary, Circle fill-in Initial camera values: Pitch, Yaw, Zoom value Total time to animate: seconds value Set Camera Sets the target object and properties of the camera. Preforming the selected properties

Change the camera view mode to check to choose: Cab View, External View, Tracking View, Free Roaming Vehicle fill-in choose from session vehicles Set the camera flags to enable/disable check to choose different properties from list Junction fill-in choose from session junctions Set the target objet of the camera to check Map object fill-in choose from map objects Wait for Camera View Mode Waits for the camera to be changed to the designated view Trigger rule once check to set Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking View, Free Roaming View Wait for the camera to target vehicle ? click to choose form session list Correspondence Rules Close Message Popups Closes message popup None Custom Script Custom scripted rule. No Parameters None Display Custom HUD Show or hide the Custom Heads Up Display Note: One must be chosen Show the Custom Heads Up Display fill-in Hid the Custom Heads Up Display fill-in Display HTML Pages Creates a browser to display the listed HTML files in order as a navigable sequence of pages 4 Make browser window invisible check 1 Index html page name 2 From Asset HTML as the hidden button click to select Use the page 6 Set size-Under Construction!!! check 5 Set position-Under Construction!!! check 2 Disable closing of browser window check 1 Prevent user from exiting browser check

Set browser parameters Delete All From Source Assets Add All From Source Assets Add Page From Source Assets 3 Disable browser window scrolling check Display Video Displays a page from a HTML assets in a browser window html assets select type Note: can also give the video a name Display page index html page Name End Session End Session without saving End the Session number seconds Fade in/out Fade in or out within seconds, color and opacity considered Blue percentage number percent Note: Make one rule to fade in another Note: Sets or removes color overlay, Alpha percentage(opacity) number percent Green percentage number percent Red percentage number percent Fading duration, fade out = alpha near number seconds Flash HUD Icon Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop Flash HUD panel type choose Bottom right menu/Camera Controls/DCC Controls/Driver Main Menu Icon choose depends on HUD panel Time duration number seconds Start/Stop Select HUD Panel to start/stop choose Start/Stop Icon choose see 1 Note: Either Flash or Start/Stop must GenericTreeNode Debug Window None None

InputTable Creating a list of message names to be used for various purposes Add Name message Message Popup Displays a pop-up browser window and waits to be closed Note: Choice of source determine multi Message source choose one Custom text/A pre-defined HTML page(advanced/A pre-defined string-table from HTML asset(advanced) Close previous message pop-up check Pause game while window is displayed check Window location choose one Top Lift/Top Right/ Bottom Left/Bottom Right Minimap Options Sets the display options for the minimap Types of items to display on the check Textures, Gradients, Junctions, Signals, Triggers, Markers, Trackside Labels, Terrian Objects, Industry Names, Named Objects, Consists Note: All can be checked or unchecked Play Sound Plays a wav sound file Play a wav file of HTML Assets click to Name file Asset click to choose Rule completes when click to choose: Sound just started, Sound has finished playing Session Debug Rule Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete None Session Metadata Sets session metadata in the config file. Info can be read by other systems and displayed to the player Length click to insert minutes Difficulty click to select: Normal, Tutorial, Easy, Hard, Expert Type click to select: Simulation or Challenge Set Helper Icon Size Sets the size of helper icons such as the junction lever Scale junction lever arrows to be click to set percentage of default

Set HTML Pages instructs the Display HTML Pages rule to perform specific operations Spare setting 5 check Spare setting 2 check Assets ' to select from list Index click to select String Table Entry Use the string table entry from the fill-in Asset click to select from list Use the page index html form the HTML fill-in Spare setting 4 check 2 Spare setting 3 check Disable scrolling(not implemented) none Window has no 'done' Button check Choose one of the following fill-in Hide/Close window on 'done' action check Index html click to select HTML Page Name Set the following flags for the page click HTML Page Name Set browser parameters to click to set Closing Window by user, scrolling on browser window, hide browser window Instructs the sequence browser to click to set HTML Page Name Instruct the sequence browser to click to set to: Close, Done check button, Previous page, Next Page, First Page, Last Page, Hide Window, Show Window Spare setting 1 check Show/Hide HUD Panel Shows or hides a HUD panel Show, Hide click to select HUD Panel click to select from list Show/Hide Layer Shows or hides a layer from Driver The layer click to choose hide, show Layer's name click to add Layer's Name Show/Hide Minimap Shows the Driver the minimap window Minimap Window click to show, hide window

Show/hide on-screen help Shows or hides On-screen help in Driver On screen help fill-in to Show, Hide, Leave unchanged Vehicles names fill-in to choose Show, Hide, Leave unchanged Wait for Click on HUD Icon Waits for a click on the HUD Icon Trigger rule once check to set Choose HUD Panel click to choose Panel from list Wait for a click on? Icon click choice depends on HUD Panel Wait on Waybill Screen/Main Screen Waits for the Waybill window to be opened Trigger rule once check to set Wait for the Waybill window to be ? click to set: opened, closed Startup Rules Multiplayer Rule Enables this session to be taken online in a Multiplayer environment Suggested maximum number of players number Maximum number of drivers per player number Players are permitted to claim drivers check Automatically target an available train check Startup Options Specifies the starting options for the session Set derailment realism to click to choose None, arcade, Realistic Current control method is click to choose Ask user, Realistic mode, Easy mode Show in-game help check Use units in Driver click to choose default, imperial, metric, Set Time to click to insert hours and minutes Set Weather to click to choose from list Changeability click to choose Off, Periodic, Extreme Rate of click to choose from list Time Rules Clock Rule Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule

This rule send messages to update the Timecheck Executes child rules at a certain time Child rules will be executed at click to insert hours, minutes, seconds(24 hrs. format) Execution time is on the day after the check Timed limited display HTML Displays an html browser window for a limited time Alert show ability click to choose not reshowable on request, reshowable on request Browser left position(SessVar or click to insert number Display duration(SessVar or duratiion in click to insert number of seconds HTLM Asset Name click to select from list Browser height(SessVar or position) click to insert number Browser width(SessVar or position) click to insert number Browser top position(SessVar or click to insert number Page filename click to insert file name Timing Check Rule Triggers subrules if called within the time window specified Start of time window click to insert hours, minutes, seconds End of time window click to insert hours, minutes, seconds Wait Wait for number of seconds Wait for ? Seconds click to insert number of seconds Plus/minus ? Seconds click to insert number of seconds of variance Wait for Click on HUD Icon Same as 96.0 Variable Rules Variable Check If variable 'score' is less than 'number' the child rules will be executed in order A score click to insert number Condition click to choose evaluated only one, changes after check will not affect this rule, evaluated once every second Test that variable click to select name of variable from session list is click to select from list

Variable Modify Change amount of variable score Value click to insert maximum number Amount to change click to insert number Variable click to select from session variable names If rule is stopped click to choose: Do not undo the alteration, Undo the alteration Set the minimum value fill-in Variable click to choose variable name from session list Amount click to insert minimum score Maximum fill-in Variable Name click to choose from session list Change click to choose from: Add to variable, Subtract from variable, Change variable to Variable Modify Continuous Adds a value to variable 'score' every second 'Score' click to insert variable name Change 'score' click to set: Add to, Subtract from, Change variable to Amount to change click to insert amount of change each second Variable Show Adds the variable 'Score the custom HUD with label none Add variable to the custom HUD check to set Name Variable click to insert Name Variable label click to insert Property Label Remove variable click to insert Property Label Weather Rules EIRS Weather Rule NE USA Customize random weather rule relative to the North East Region of the United States Set season to choose Summer/Winter/Fall/Spring Change every minutes number of minutes Environmental impact choose Disable/Enable Weather Set the weather conditions With ? changeability ' to set: Off, Periodic, Extreme Set weather to ? click to set: Clear, Cloudy, Drizzle, Rain, Stormy, Light, Medium Snow, Heavy Show