https://wiki.trainzsimulator.com/api.php?action=feedcontributions&feedformat=atom&user=Trev999 2026-11-05T07:54:44Z User contributions MediaWiki 1.46.2 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10171 2017-09-23T04:53:50Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Message Source Option: Custom text'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be displayed with the message<br /> Icon: &quot;Clear icon&quot; - clears any currently displayed icon<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Message Source Option: A predefined HTML page'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> HTML Page: - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.html&quot; is optional.<br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional<br /> Autoplay Wave: - check to play the .wav sound file as soon as message is displayed. If unchecked sound will not be played.<br /> <br /> '''Message Source Option: A predefined string-table entry from a HTML asset'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required string-table.<br /> String Table Token: - <br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional.<br /> Autoplay Wave: - check to play the .wav sound file as soon as message is displayed. If unchecked sound will not be played.<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules)'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change the value of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> Variables are saved in the session file and persist from one saved game to another.<br /> They can be accessed/modified by the following '''driver commands''':<br /> <br /> '''Driver Commands by trev999:'''<br /> '''Set S-Variable driver command: '''<br /> '''Skip if session-variable driver command: '''<br /> '''Wait until S-variable driver command: '''<br /> <br /> '''Driver Commands by atilabarut'''<br /> '''ChangeSVariables driver command: '''<br /> '''WaitUntilSVariable driver command: '''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10170 2017-09-23T04:50:29Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Message Source Option: Custom text'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be displayed with the message<br /> Icon: &quot;Clear icon&quot; - clears any currently displayed icon<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Message Source Option: A predefined HTML page'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> HTML Page: - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.html&quot; is optional.<br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional<br /> Autoplay Wave: - check to play the .wav sound file as soon as message is displayed. If unchecked sound will not be played.<br /> <br /> '''Message Source Option: A predefined string-table entry from a HTML asset'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required string-table.<br /> String Table Token: - <br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional.<br /> Autoplay Wave: - check to play the .wav sound file as soon as message is displayed. If unchecked sound will not be played.<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules)'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change the value of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> Variables are saved in the session file and persist from one saved game to another.<br /> They can be accessed/modified by the following '''driver commands''':<br /> <br /> '''Driver Commands by trev999:'''<br /> <br /> '''Set S-Variable driver command: '''<br /> <br /> '''Skip if session-variable driver command: '''<br /> <br /> '''Wait until S-variable driver command: '''<br /> <br /> '''Driver Commands by atilabarut'''<br /> <br /> '''ChangeSVariables driver command: '''<br /> <br /> '''WaitUntilSVariable driver command: '''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10168 2017-09-23T04:48:54Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Message Source Option: Custom text'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be displayed with the message<br /> Icon: &quot;Clear icon&quot; - clears any currently displayed icon<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Message Source Option: A predefined HTML page'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> HTML Page: - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.html&quot; is optional.<br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional<br /> Autoplay Wave: - check to play the .wav sound file as soon as message is displayed. If unchecked sound will not be played.<br /> <br /> '''Message Source Option: A predefined string-table entry from a HTML asset'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> String Table Token: - <br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional.<br /> Autoplay Wave: - check to play the .wav sound file as soon as message is displayed. If unchecked sound will not be played.<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules)'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change the value of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> Variables are saved in the session file and persist from one saved game to another.<br /> They can be accessed/modified by the following '''driver commands''':<br /> <br /> '''By trev999:'''<br /> <br /> '''Set S-Variable driver command: '''<br /> <br /> '''Skip if session-variable driver command: '''<br /> <br /> '''Wait until S-variable driver command: '''<br /> <br /> '''By atilabarut'''<br /> <br /> '''ChangeSVariables driver command: '''<br /> <br /> '''WaitUntilSVariable driver command: '''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10165 2017-09-23T04:44:57Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Message Source Option: Custom text'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be displayed with the message<br /> Icon: &quot;Clear icon&quot; - clears any currently displayed icon<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Message Source Option: A predefined HTML page'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> HTML Page: - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.html&quot; is optional.<br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional<br /> Autoplay Wave: - check to play .wav sound file. If unchecked sound will not be played even if you have specified its filename and HTML asset.<br /> <br /> '''Message Source Option: A predefined string-table entry from a HTML asset'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> String Table Token: - <br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional.<br /> Autoplay Wave: - check to play .wav sound file. If unchecked sound will not be played even if you have specified its filename and HTML asset.<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules)'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change the value of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> Variables are saved in the session file and persist from one saved game to another.<br /> They can be accessed/modified by the following ''driver commands''<br /> <br /> '''By trev999:'''<br /> <br /> '''Set S-Variable'''<br /> <br /> '''Skip if session-variable'''<br /> <br /> '''Wait until S-variable'''<br /> <br /> '''By atilabarut'''<br /> <br /> '''ChangeSVariables'''<br /> <br /> '''WaitUntilSVariable'''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10164 2017-09-23T04:44:17Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Message Source Option: Custom text'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be displayed with the message<br /> Icon: &quot;Clear icon&quot; - clears any currently displayed icon<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Message Source Option: A predefined HTML page'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> HTML Page: - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.html&quot; is optional.<br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional<br /> Autoplay Wave: - check to play .wav sound file. If unchecked sound will not be played even if you have specified its filename and HTML asset.<br /> <br /> '''Message Source Option: A predefined string-table entry from a HTML asset'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> String Table Token: - <br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional.<br /> Autoplay Wave: - check to play .wav sound file. If unchecked sound will not be played even if you have specified its filename and HTML asset.<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules)'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change the value of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> Variables are saved in the session file and persist from one saved game to another.<br /> They can be accessed/modified by the following ''driver commands''<br /> <br /> '''By trev999:'''<br /> <br /> '''Set S-Variable'''<br /> <br /> '''Skip if session-variable'''<br /> <br /> '''Wait until S-variable'''<br /> <br /> '''By atilabarut'''<br /> <br /> '''ChangeSVariables'''<br /> <br /> '''WaitUntilSVariable'''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10161 2017-09-23T04:41:13Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Message Source Option: Custom text'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be display with the message<br /> Icon: &quot;Clear icon&quot; - clears any currently displayed icon<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Message Source Option: A predefined HTML page'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> HTML Page: - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.html&quot; is optional.<br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional<br /> Autoplay Wave: - check to play .wav sound file. If unchecked sound will not be played even if you have specified its filename the HTML asset.<br /> <br /> '''Message Source Option: A predefined string-table entry from a HTML asset'''<br /> HTML Asset: - select the name of the HTML asset from those installed that contains the required HTML page<br /> String Table Token: - <br /> HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.<br /> Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension &quot;.wav&quot; is optional.<br /> Autoplay Wave: - check to play .wav sound file. If unchecked sound will not be played even if you have specified its filename the HTML asset.<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules)'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change the value of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> Variables are saved in the session file and persist from one saved game to another.<br /> They can be accessed/modified by the following ''driver commands''<br /> <br /> '''By trev999:'''<br /> <br /> '''Set S-Variable'''<br /> <br /> '''Skip if session-variable'''<br /> <br /> '''Wait until S-variable'''<br /> <br /> '''By atilabarut'''<br /> <br /> '''ChangeSVariables'''<br /> <br /> '''WaitUntilSVariable'''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10156 2017-09-23T04:21:34Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> Pause game while message is displayed: - check to stop the game until this message is switched off<br /> Close previous popup windows: - check to close any Message Popups currently displayed before this message is shown<br /> Message location: Top Left/Top Right/Bottom Left/Bottom Right - select one<br /> Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced) - select one<br /> <br /> '''Custom text option:'''<br /> Icon: &quot;Click here to set&quot; - shows a list of texture icons. Select one to be display with the message<br /> Custom text: Enter text in dialogue box. You will be limited to about 6 lines of text<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Properties (common to all these rules'''<br /> variable-name<br /> conditions<br /> value<br /> text to use as a label in the HUD<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Variable Modify Rule:''' Change amount of variable 'variable-name'.<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'text'.<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10154 2017-09-23T04:05:31Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal to' 'number' the child rules will be executed in order.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Modify Rule:''' Change amount of variable 'variable-name'.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'your-text'.<br /> <br /> '''Properties'''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10153 2017-09-23T04:04:48Z

<p>Trev999: /* Variable Rules: */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Variable Check Rule:''' If variable 'variable-name' is 'less than/greater than/equal' to 'number' the child rules will be executed in order.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Modify Rule:''' Change amount of variable 'variable-name'.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'variable-name' every second.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Show Rule:''' Adds the variable 'variable-name' to the custom HUD with label 'your-text'.<br /> <br /> '''Properties'''<br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Session_Rules_By_Categories_With_Properties&diff=10152 2017-09-23T03:56:28Z

<p>Trev999: /* Danger Rules */</p> <hr /> <div>'''This page is under construction'''<br /> <br /> TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''<br /> <br /> =='''Achievement Rules'''==<br /> <br /> '''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload<br /> <br /> '''Properties:'''<br /> Target object ?? name of object such as Power Station, Coal Pit or Portal<br /> Lock train's controls checked during a stopped load/unload operation<br /> Override 'begin load' and 'begin unload' checked # of seconds to override<br /> <br /> '''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations<br /> <br /> '''Properties:'''<br /> Trigger click to choose from list<br /> Add Industry click to add from session list<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> <br /> '''Power Station Rule:''' Sets up Station and Consumers<br /> <br /> '''Properties:'''<br /> Power Station click to choose from session Stations<br /> Consumers(Add Object) click to choose from session list<br /> <br /> '''Resource Check Rule:''' Check the progress of the amount of a resource and target object<br /> <br /> '''Properties:'''<br /> Watch industry queue or Watch vehicle fill-in choose one or the other<br /> Note: Both have: Target Object, Queue: click to choose<br /> Complete when designated queue fill-in equals or exceeds required amount, falls below required amount<br /> <br /> <br /> '''Multiple Resource Check Rule:''' Checks resource for completion<br /> <br /> '''Properties:'''<br /> Wait for the designated queues from choose fall below, reach/exceed<br /> Units number amount of units<br /> Products click choose from session list<br /> Add Object click choose from session list<br /> <br /> '''Objective Add Rule:''' Sets up a game Objective with ID and display Name<br /> <br /> '''Properties:'''<br /> Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent<br /> Completion Target click to set target number<br /> Icon click choose from list<br /> Display Name click insert Name<br /> Unique Objective ID click set ID<br /> Custom Message insert typed message in text area <br /> <br /> '''Objective Check Rule:''' Executes child rules when objective is complete<br /> <br /> '''Properties:'''<br /> Unique Objective ID click insert ID number<br /> Mode click choose Wait for completion, Wait for failure, Wait for progress<br /> <br /> '''Objective Update Rule:''' Changes progress outcome according to Property choices<br /> <br /> '''Properties:'''<br /> Unique Objective ID click to set ID number<br /> 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<br /> Amount click insert number<br /> <br /> <br /> '''Ranked Session Begin Rule:''' Begins a ranked Session<br /> <br /> '''Properties:'''<br /> Countdown requires a Starting Value insert hrs., min,sec<br /> 1 through 5 stars, points for each star insert number of points<br /> Session timer mode fill-in chooses: Timer, Countdown, None<br /> <br /> '''Ranked Session Complete Rule:''' Completes the active ranked Session<br /> <br /> '''Properties:'''<br /> Set the active ranked session as fill-in choose: Complete, Failed<br /> Customize the completion message check insert text message<br /> <br /> <br /> '''Session Complete Rule:''' Set session to a percentage of completion<br /> <br /> '''Properties:'''<br /> Set session to percent complete click to insert number in percent<br /> Separate achievements for completion check<br /> <br /> <br /> =='''Danger Rules'''==<br /> <br /> '''ATP Speed Limiter Rule:''' Limits speed over set limit<br /> <br /> '''Properties:'''<br /> speed limit over the set limit mph<br /> <br /> '''Speeding Check Rule:''' Checks to see if player control trains are over the speed <br /> <br /> '''Properties:'''<br /> Watch for trains travelling above the fill-in<br /> Allow an over speed tolerance of click to insert mph over posted limit<br /> Watch for trains travelling above a fill-in to insert custom speed limit<br /> Warning: This method is very <br /> <br /> '''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals<br /> <br /> '''Properties:'''<br /> Use modern sound set for unfitted cabs? check<br /> Simulate AWS for unfitted cabs? check<br /> Passive with HUD hidden fill-in<br /> Active fill-in<br /> Passive fill-in<br /> <br /> '''Wait for Derailment Rule:''' Waits for a derailment to occur<br /> <br /> '''Properties:'''<br /> Trigger derailment watch once check to set<br /> <br /> '''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars<br /> <br /> '''Properties:'''<br /> Set delay to clean up derailed train cars values<br /> <br /> '''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule<br /> <br /> '''Properties:'''<br /> Respawn trains if they are abandoned check<br /> Respawn trains fill-in choose: at their original locations, from portals from Session List<br /> <br /> '''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage<br /> <br /> '''Properties:'''<br /> Show the Coupler Breakage Display fill-in must choose one or the other<br /> Hide the Coupler Breakage Display fill-in must choose one or the other<br /> <br /> '''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles<br /> <br /> '''Properties:'''<br /> Add vehicle click to select from session list<br /> Coupling Mask, Decoupling Mask : click to select: lock or unlock<br /> Add All click to select all vehicle in session<br /> Delete All click to delete all vehicle from list<br /> <br /> '''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users<br /> <br /> '''Properties:'''<br /> Trigger only once check<br /> <br /> '''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger<br /> <br /> '''Properties:'''<br /> Trigger only once check to set<br /> <br /> '''Vehicle Physics Rule:''' Overrides the default vehicle physics properties<br /> <br /> '''Properties:''' <br /> Accept all trains fill-in<br /> Cab sway level is set ? % click to insert percent of sway<br /> Traction boost is % ? while sanding click to insert percent of boost<br /> Tractions reduced to ? % while click to set traction percent<br /> Maximum tractive effort adjusted by ? click to insert percent amount<br /> Show coupler breakage in HUD Rule check to set<br /> Couplers break when coupling above ? click to set speed<br /> Accept trains matching specific criteria fill-in to insert specific trains<br /> Couplers break at ? kN check to insert amount of force<br /> <br /> =='''Navigation Rules'''==<br /> <br /> <br /> '''DestSignTable Rule:''' Table for creating a table of destination signs<br /> <br /> '''Properties:'''<br /> Enable Track Marks as destinations check<br /> Enable table of destinations check<br /> Import destination from texture-group. name<br /> Destination Name name<br /> Enable industries/stations as check<br /> Interlocking Tower Configure Path Alters settings on an interlocking tower path<br /> Interlocking Tower choose Name and Objects<br /> Interlocking Tower Path Selection UI Will automatically react to messages from Interlocking <br /> Towers and display a path selection dialog to the player. <br /> Disable by removing rule from session<br /> Show path activation message in Driver check<br /> <br /> '''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train<br /> <br /> '''Properties:'''<br /> Interlocking Tower choose Names and Objects<br /> Multiple Junction Alignment Check Checks multiple junctions are in alignment<br /> Wait until the following junctions are choose all or anyone<br /> Add junction click add junction from session list<br /> Add all click add all junctions from session list<br /> Delete all click deletes all junctions from rule list<br /> <br /> '''Navigation Display Rule:''' Creates a navigation point<br /> <br /> '''Properties:'''<br /> 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<br /> Note: See help icon for more <br /> Style click choose Required Stop, Automatic, Manual<br /> Display Text insert text<br /> Location click choose train vehicle from session list<br /> Train(optional) choose train from session list<br /> Unique set ID name must be lowercase and no spaces<br /> Icon click choose from list<br /> <br /> '''Navigation Point Complete Rule:''' Marks a navigation point complete<br /> <br /> '''Properties:'''<br /> Mark navigation point click set index number<br /> Complete in set click to set ID<br /> <br /> '''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete<br /> <br /> '''Properties:'''<br /> Checks if navigation point is set click set ID<br /> Is click Complete, Incomplete<br /> Navigation Set Clear Clears a navigation point set<br /> Clear the navigation point set click to set ID<br /> Navigation Set Hide/Show Show or hide navigation point set<br /> The navigation point click hide, show<br /> Navigation point set click to set ID<br /> <br /> '''Schedule Rule:''' Allows a schedule of timed events to be applied to a train<br /> <br /> '''Properties:'''<br /> Insert track mark click to select from session list<br /> Note: Both has an arrival and departure set time hr:min:sec<br /> Current Train click to select from session list<br /> Insert destination click to select from session list<br /> <br /> '''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Add Junction click to select session junction list<br /> Add All click<br /> Delete All click<br /> <br /> '''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''<br /> <br /> '''Properties:'''<br /> Set signal click to select from session list<br /> State ' to select state from list<br /> <br /> '''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in<br /> Accept trains matching specific criteria fill-in to choose from session list<br /> Add Trigger click to choose from session list<br /> Trigger only once check to set<br /> Wait for child rules to complete even if check to set<br /> Only activate when the entering click to choose forward, backward<br /> <br /> '''Wait on Navigation Point Rule:''' Waits for a nav point to be complete<br /> <br /> '''Properties:'''<br /> Wait for navigation point ? click to choose from session list<br /> in set ? to be completed click to insert ID<br /> <br /> '''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start<br /> <br /> '''Properties:'''<br /> Accept all trains fill-in to set<br /> Accept trains matching specific criteria fill-in to set and choose from session list<br /> Wait for a train that matches the click to choose: start moving, stop moving<br /> Trigger rule once check to set<br /> Note: One or the other fill-ins must be <br /> <br /> =='''Driver Rules'''==<br /> <br /> '''Control Type Rule''' Sets control type<br /> <br /> '''Properties:'''<br /> Current control method is: Easy Mode, Choice one of the three<br /> <br /> <br /> '''Control Check Rule:''' Activates child rules based on the control method changes<br /> <br /> '''Properties:'''<br /> Excite child rules when: DCC mode is fill-in one or the other<br /> Excite child rules: Every time control fill-in one or the other<br /> <br /> <br /> '''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule<br /> <br /> '''Properties:'''<br /> Trigger add Trigger<br /> Portal index from PCP value<br /> Use UnPortal yes/no<br /> Delay from Trigger to Emit: seconds value<br /> <br /> '''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry<br /> <br /> '''Properties:'''<br /> Apply to every vehicle in the session fill-in<br /> Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles<br /> Note: One of the Applies will always be <br /> Load/Unload for industry Disable/Enable choose Industry<br /> <br /> '''Driver Command Rule:''' Specify which commands will be available for the drivers<br /> <br /> '''Properties''':<br /> Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.<br /> Navigate To TrackMarkList V2- No description.<br /> Navigate To Station V2- No description.<br /> Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.<br /> Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.<br /> Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.<br /> Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.<br /> Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.<br /> Drive To Station V2- No description.<br /> Drive To Track mark List V2- No description.<br /> Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.<br /> Drive To Industry- Drive to a specific industry.<br /> Change Destination Sign-Changes the destination signs of a train.<br /> <br /> WaitFor- Pauses the driver's schedule for a set duration of time.<br /> Wait For Random- TRS2008: Wait for specified or optionally random period of time.<br /> Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).<br /> WaitUntil- No description.<br /> <br /> VR Set Train Lamps-Driver command that sets the train lamps. <br /> Notify- Notifies the player of schedule progress/completion.<br /> Reverse Tram- Reverse a tram(max 2 cars).<br /> Couple- Couple train to designate vehicle. <br /> Decouple- Decouples the train at the specified vehicle. <br /> UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).<br /> Halt Train- Brings the train to a complete stop.<br /> Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.<br /> Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger <br /> station before using this command.<br /> Cab: Wait-Maintains current control state until some condition is met.<br /> Delete Train- Causes the train and its driver to be deleted from the session.<br /> Hornz- Driver sounds the train horn.<br /> Cab: Set Control-Sets a cab mode control.<br /> Headlights On/Off-Allows the driver to to switch the headlights on and off.<br /> Interior Lights Command- Driver command to switch interior lights on or off for the current train.<br /> Set Max Speed To- No description.<br /> <br /> Release Junction - Lets a driver release the junction they have been holding.<br /> Move Turntable- TRS2008: Move turntable to a stop point .<br /> <br /> Load- Loads the train's vehicles at the industry the driver is currently at with the train.<br /> Unload- Unload train vehicles at current industry location.<br /> Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.<br /> Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.<br /> Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.<br /> <br /> '''Driver Command Check Rule:''' Verifies the driver commands of a driver character<br /> <br /> '''Properties'''<br /> Wait for driver character to have add driver, all, delete all<br /> Trigger Rule once check<br /> Driver character to watch the name driver<br /> <br /> '''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar<br /> <br /> '''Properties'''<br /> The Driver Main Bar choice show/hide<br /> <br /> '''Driver Schedule Rule''' Execution of basic scheduled commands<br /> <br /> '''Properties:'''<br /> Note: Only one of the fill-in can be <br /> Driver Schedule Rule assigned to name driver<br /> Commands insert driver commands in Drive Schedule<br /> Classic style: If there is a schedule fill-in<br /> Killer style: If there is a schedule fill-in<br /> Cooperative style: If there is a schedule fill-in<br /> Active style: Emit a new schedule, only fill-in<br /> <br /> '''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders<br /> <br /> '''Properties'''<br /> Generate new Drivers for empty check<br /> The following drivers will be available Driver's Name Add<br /> Remove all existing Drivers first check<br /> <br /> '''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers<br /> <br /> '''Properties'''<br /> Assign Driver commands check Driver Commands<br /> Train criteria fill in all trains<br /> Train criteria list train only trains matching criteria<br /> <br /> '''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted<br /> <br /> '''Properties'''<br /> Config/txt file tag 'max_permitted_speed-60850 in mph or kph<br /> Add to config.txt and kuid-table for value &lt;KUID2:60850:88000:4<br /> Note: Old root level config tag will <br /> <br /> '''QuickDrive Rule:''' Change the Session settings and add consists in Driver<br /> <br /> '''Properties'''<br /> Set Time to insert time<br /> QuickDrive Consist Option List by <br /> Rate of Change insert rate as number times<br /> Enable gameplay Session Mode check<br /> Enable in game help by default check<br /> Set the default Control method to fill-in choose: Easy Mode, Realistic Mode<br /> Prevent player from changing this check<br /> Realistic mode requires achievement add Achievement's Name<br /> In Asset choose Auran achievements<br /> Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic<br /> Prevent player from changing 10.0 check<br /> Set the default units to fill-in choose: Imperial, Metric, Default<br /> Open QuickDriver Window when check<br /> <br /> '''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train<br /> <br /> '''Properties'''<br /> Note: One or the other fill-ins must be <br /> Accept trains matching specific criteria fill-in to select from session list<br /> Accept all trains fill-in to set<br /> Trigger rule once check to set<br /> Wait for a driver character to get ? a click to select: On, Off<br /> <br /> '''Wait for Driver/Train to be Locally Owned Rule:''' 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<br /> <br /> '''Properties'''<br /> Wait for ownership of a specific Driver fill-in to set<br /> Wait for ownership of Driver fill-in to set<br /> Note: One or the other fill-in must be <br /> Driver or Vehicle click to choose from session lists<br /> <br /> =='''Arrangement of Session Rules:'''==<br /> <br /> '''Ordered List Rule:''' Child rules will be executed in order once this rule starts<br /> <br /> '''Properties'''<br /> Note: One of the two must be chosen<br /> This process will repeat fill-in click to add number of repeats<br /> This process will repeat forever fill-in<br /> <br /> '''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.<br /> <br /> '''Properties'''<br /> After last child run is executed click to choose: First child is chosen again, It will be <br /> used for all successive runs, Successive runs will <br /> do nothing<br /> <br /> '''Random List Rule:''' One of the child rules indented under this rule will be <br /> <br /> '''Properties'''<br /> executed randomly<br /> Once one of the child rule is ?? <br /> <br /> '''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle<br /> <br /> '''Properties'''<br /> None<br /> <br /> '''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules <br /> <br /> '''Properties'''<br /> Rules completes when click choose all rules have reached completed state, <br /> was completed state<br /> <br /> =='''Camera Rules:'''==<br /> <br /> '''Cinematic Camera Rule:''' Provides several different cinematic style cameras<br /> <br /> '''Properties'''<br /> Lock camera controls for the duration check<br /> Prevent rain control for duration check<br /> Camera target: name any of the many objects in session<br /> Camera mode: Stationary, Circle fill-in<br /> Initial camera values: Pitch, Yaw, Zoom value<br /> Total time to animate: seconds value<br /> <br /> '''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties<br /> <br /> '''Properties'''<br /> Change the camera view mode to check to choose: Cab View, External View, Tracking <br /> View, Free Roaming<br /> Vehicle fill-in choose from session vehicles<br /> Set the camera flags to enable/disable check to choose different properties from list<br /> Junction fill-in choose from session junctions<br /> Set the target objet of the camera to check<br /> Map object fill-in choose from map objects<br /> <br /> '''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view<br /> <br /> '''Properties'''<br /> Trigger rule once check to set<br /> Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking <br /> View, Free Roaming View<br /> Wait for the camera to target vehicle ? click to choose form session list<br /> <br /> =='''Message Rules:'''==<br /> <br /> '''Close Message Popup Rule:'''<br /> <br /> '''Properties:'''<br /> None<br /> <br /> '''Issues:'''<br /> This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule<br /> <br /> <br /> '''Custom Script Rule'''<br /> <br /> '''Properties'''<br /> <br /> '''Custom scripted Rule. No Parameters'''<br /> <br /> '''Properties'''<br /> <br /> '''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:'''<br /> <br /> '''Properties'''<br /> <br /> '''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.<br /> <br /> '''Properties'''<br /> <br /> '''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.<br /> <br /> '''Properties'''<br /> <br /> '''Display Video Rule:''' Displays a page from a HTML assets in a browser window.<br /> <br /> '''Properties'''<br /> <br /> '''End Session Rule:''' End Session without saving.<br /> <br /> '''Properties'''<br /> <br /> '''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.<br /> <br /> '''Properties'''<br /> <br /> '''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.<br /> <br /> '''Properties'''<br /> <br /> '''Generic Tree Node Debug Window Rule:''' No description.<br /> <br /> '''Properties'''<br /> <br /> '''InputTable Rule:''' Creating a list of message names to be used for various purposes.<br /> <br /> '''Properties'''<br /> <br /> '''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.<br /> <br /> '''Properties'''<br /> <br /> '''Minimap Options Rule:''' Sets the display options for the minimap.<br /> <br /> '''Properties'''<br /> <br /> '''Play Sound Rule:''' Plays a wav sound file.<br /> <br /> '''Properties'''<br /> <br /> '''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.<br /> <br /> '''Properties'''<br /> <br /> '''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.<br /> <br /> '''Properties'''<br /> <br /> '''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.<br /> <br /> '''Properties'''<br /> <br /> '''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.<br /> <br /> '''Properties'''<br /> <br /> '''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.<br /> <br /> '''Properties:'''<br /> Show/Hide - click one to select<br /> &quot;click here to set&quot; - enter name of layer. Name is case sensitive.<br /> <br /> '''Known Bugs:'''<br /> TANE (all versions) - layers set to '''Hide''' when a game is saved will be visible when the game is reloaded<br /> <br /> '''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.<br /> <br /> '''Properties'''<br /> <br /> '''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.<br /> <br /> '''Properties'''<br /> <br /> '''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.<br /> <br /> '''Properties'''<br /> <br /> '''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.<br /> <br /> =='''Startup Rules:'''==<br /> <br /> '''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.<br /> <br /> '''Properties'''<br /> <br /> '''Startup Options Rule''' Specifies the starting options for the session.<br /> <br /> '''Properties'''<br /> <br /> =='''Time Rules:'''==<br /> <br /> '''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.<br /> <br /> '''Properties'''<br /> <br /> '''Timecheck Rule:''' Executes child rules at a certain time.<br /> <br /> '''Properties'''<br /> <br /> '''Timing Check Rule:''' Triggers sub rules if called within the time window specified.<br /> <br /> '''Properties'''<br /> <br /> '''Wait Rule:''' Wait for number of seconds'<br /> <br /> '''Properties'''<br /> <br /> =='''Variable Rules:'''==<br /> <br /> '''Variable Check Rule:''' If variable 'score' is less than 'number' the child rules will be executed in order.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Modify Rule:''' Change amount of variable score.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Modify Continuous Rule:''' Adds a value to variable 'score' every second.<br /> <br /> '''Properties'''<br /> <br /> '''Variable Show Rule:''' Adds the variable 'Score the custom HUD with label ?.<br /> <br /> '''Properties'''<br /> <br /> <br /> =='''Weather Rules:'''==<br /> <br /> '''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.<br /> <br /> '''Properties'''<br /> <br /> '''Weather Rule:''' Set the weather conditions.<br /> <br /> '''Properties'''</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9919 2017-08-19T17:00:06Z

<p>Trev999: </p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be open<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin by stating the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We may also declare variables within methods/functions. These then will only be accessible inside the function or method and not in other parts of the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to worry about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in there!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited statement calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrode the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionality for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any changes. What exactly &quot;return types&quot; are will be explained another time :) (it is too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a parameter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as parameter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to be kept informed, if Trainz wants to save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The opposite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we could use the method &quot;GetNamedTagAsBool&quot;. It expects only one parameter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this function has another variant which expects two parameters. The first one is the name of our value, and the other one is a default value, if the selected<br /> value is not set in the Soup. We'll need to use that method because, if we place an object in surveyor, there are no values in the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we add that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes: The truck with a hole where the door should be, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with hole, where the door should be<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects to receive three parameters: The name of our mesh-table entry, a state (true or false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes that have to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.<br /> The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the 'not' operator &quot;!&quot;. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed and learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg<br /> <br /> Edited by --[[User:Trev999|Trev999]] ([[User talk:Trev999|talk]]) 02:28, 20 August 2017 (AEST)</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9918 2017-08-19T16:46:38Z

<p>Trev999: </p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be open<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin by stating the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We may also declare variables within methods/functions. These then will only be accessible inside the function or method and not in other parts of the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to worry about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in there!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited statement calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrode the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionality for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any changes. What exactly &quot;return types&quot; are will be explained another time :) (it is too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a parameter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as parameter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to be kept informed, if Trainz wants to save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The opposite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we could use the method &quot;GetNamedTagAsBool&quot;. It expects only one parameter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this function has another variant which expects two parameters. The first one is the name of our value, and the other one is a default value, if the selected<br /> value is not set in the Soup. We'll need to use that method because, if we place an object in surveyor, there are no values in the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we add that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a hole where the door is, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with hole, where the door should be<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects to receive three parameters: The name of our mesh-table entry, a state (true or false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes, that have to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.<br /> The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the 'not' operator &quot;!&quot;. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed and learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg<br /> <br /> Edited by --[[User:Trev999|Trev999]] ([[User talk:Trev999|talk]]) 02:28, 20 August 2017 (AEST)</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9917 2017-08-19T16:41:53Z

<p>Trev999: </p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be open<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin by stating the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We may also declare variables within methods/functions. These then will only be accessible inside the function or method and not in other parts of the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to worry about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in there!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited statement calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrode the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionality for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any changes. What exactly &quot;return types&quot; are will be explained another time :) (it is too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a parameter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as parameter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to be kept informed, if Trainz wants to save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The opposite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we could use the method &quot;GetNamedTagAsBool&quot;. It expects only one parameter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this function has another variant which expects two parameters. The first one is the name of our value, and the other one is a default value, if the selected<br /> value is not set in the Soup. We'll need to use that method because, if we place an object in surveyor, there are no values in the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we add that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a hole where the door is, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with hole, where the door should be<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects three parameters. The name of our mesh-table entry, a state (true, false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes, that have to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.<br /> The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the 'not' operator &quot;!&quot;. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed and learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg<br /> <br /> Edited by --[[User:Trev999|Trev999]] ([[User talk:Trev999|talk]]) 02:28, 20 August 2017 (AEST)</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9916 2017-08-19T16:39:29Z

<p>Trev999: </p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be open<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin by stating the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We may also declare variables within methods/functions. These then will only be accessible inside the function or method and not in other parts of the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to worry about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in there!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited statement calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrode the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionality for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any changes. What exactly &quot;return types&quot; are will be explained another time :) (it is too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a parameter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as parameter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to be kept informed, if Trainz wants to save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The opposite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we could use the method &quot;GetNamedTagAsBool&quot;. It expects only one parameter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this function has another variant which expects two parameters. The first one is the name of our value, and the other one is a default value, if the selected<br /> value is not set in the Soup. We'll need to use that method because, if we place an object in surveyor, there are no values in the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we add that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a hole where the door is, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with hole, where the door should be<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects three parameters. The name of our mesh-table entry, a state (true, false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes, that have to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.<br /> The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the [[not]] operator &quot;!&quot;. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed and learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg<br /> <br /> Edited by --[[User:Trev999|Trev999]] ([[User talk:Trev999|talk]]) 02:28, 20 August 2017 (AEST)</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9915 2017-08-19T16:36:44Z

<p>Trev999: </p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be open<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin by stating the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We may also declare variables within methods/functions. These then will only be accessible inside the function or method and not in other parts of the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to worry about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in there!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited statement calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrode the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionality for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any changes. What exactly &quot;return types&quot; are will be explained another time :) (it is too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a parameter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as parameter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to be kept informed, if Trainz wants to save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The opposite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we could use the method &quot;GetNamedTagAsBool&quot;. It expects only one parameter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this function has another variant which expects two parameters. The first one is the name of our value, and the other one is a default value, if the selected<br /> value is not set in the Soup. We'll need to use that method because, if we place an object in surveyor, there are no values in the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we add that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a hole where the door is, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with hole, where the door should be<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects three parameters. The name of our mesh-table entry, a state (true, false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes, that have to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.<br /> The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the [not] operator &quot;!&quot;. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed and learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg<br /> <br /> Edited by --[[User:Trev999|Trev999]] ([[User talk:Trev999|talk]]) 02:28, 20 August 2017 (AEST)</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9914 2017-08-19T16:28:50Z

<p>Trev999: Corrected spelling and grammar and made explanations clearer</p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be open<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin by stating the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We also may declare variables within methods/functions. These then will only be accessable inside the function or method and not in other parts of the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We may only declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to worry about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in there!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited statement calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrode the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionality for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any changes. What exactly &quot;return types&quot; are will be explained another time :) (it is too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a parameter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as parameter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to be kept informed, if Trainz wants to save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The opposite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we could use the method &quot;GetNamedTagAsBool&quot;. It expects only one parameter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this function has another variant which expects two parameters. The first one is the name of our value, and the other one is a default value, if the selected<br /> value is not set in the Soup. We'll need to use that method because, if we place an object in surveyor, there are no values in the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we add that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a hole where the door is, a door in the opened state and a door in the closed state. You also may achieve this by using animations, but this way is much easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with hole, where the door should be<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects three parameters. The name of our mesh-table entry, a state (true, false - [visible, invisible]) and a floating-point number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes, that have to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll be hidden.<br /> The closed state mesh is set with the opposite value of m_bDoorOpened. This can be easily done by using the [not] operator &quot;!&quot;. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed and learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg<br /> <br /> Edited by --[[User:Trev999|Trev999]] ([[User talk:Trev999|talk]]) 02:28, 20 August 2017 (AEST)</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Hide-_%26_Unhide_Meshes&diff=9911 2017-08-16T17:14:14Z

<p>Trev999: </p> <hr /> <div>In [[HowTo/Your first Trainz Script]] we created the script:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Today we're gonna use this little example for a vehicle. There is an ice cream truck on the DLS by misterairbrush (&lt;kuid:414943:100987&gt;). This ice cream truck has a door that can be opened or closed.<br /> It looks like:<br /> <br /> [[File:Scripting_02_Truck_1.jpg]] [[File:Scripting_02_Truck_2.jpg]]<br /> <br /> The truck comes equipped with two versions of the door, called meshes. One or the other mesh is visible at any one time but never both together. <br /> We'll learn today how to hide the &quot;wrong&quot; and show the right mesh. Also we want users to be able to select an option in the &quot;?&quot;-Window of the scenery object to determine whether the door is to be open or closed.<br /> <br /> First we need a member variable to store the (user-selected) open/closed state of the door, then we need functions to save and load the information every time the session starts or is saved.<br /> <br /> <br /> Variables store values used in the game. These values can be changed by script and are stored in the computer's memory until needed.<br /> <br /> In Trainz Script there are four (well, really there are five, but we will ignore one this time!) data [[Types]] we can use:<br /> <br /> * '''bool''' - boolean constants true/false<br /> * '''int''' - every number between -2147483647 and 2147483647 (a 32 Bit integer)<br /> * '''string''' - characters<br /> * '''float''' - numbers with a decimal point (32 Bit)<br /> <br /> <br /> Today we'll have a closer look at the '''bool''' type. The others will be explained another time :)<br /> <br /> <br /> In our case, we only need a true/false value.<br /> <br /> '''True''': The user wants the door to be opened<br /> <br /> '''False''': The user wants the door to be closed<br /> <br /> <br /> How do we declare a member variable? This is pretty easy:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We begin with the data-type of our variable and then give it a name. Now we can use it.<br /> This variable now is available in the whole CIceCreamTruck-Class, because we declared it before any other methods, so we may say it's a global variable (that isn't true, but it's easier to explain).<br /> We also may declare variables within methods/functions. These then will only be accessable inside the function or method and not on other places in the script.<br /> In Trainz Script there are now real global variables (that's why I think we may call the members global, even if it's not true). We only may declare variables inside classes.<br /> <br /> <br /> Next, we will have a look at two new methods:<br /> <br /> * '''[[Class_PropertyObject#GetProperties]] (GetProperties)''' - Save data to a soup<br /> * '''[[Class_PropertyObject#SetProperties]] (SetProperties)''' - Fetch data from a Soup<br /> <br /> These methods are implemented in native code. That means we don't have to care about when they are called. We just have to override them. Trainz will call them whenever needed. To override a class means to replace the built-in class with a new one that extends the functions of the original (the parent) while retaining all the original functionality.<br /> Let's override them:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> ; GetProperties:<br /> As I said above, the purpose of this function is to save data into a Soup. It expects a Soup-Object to be returned. You'll see, that Soup is a class, not a data type.<br /> <br /> But we're able to declare class instances as variables too. (Look at: '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();)<br /> <br /> And again: The inherited is in here!<br /> Every function/method we override has in most cases to inherit the parent classes method. The inherited in here calls GetProperties of Class MapObject. This makes sure, that every operation inside a method of the parent class is called too. Remember: We overrided the method. If we don't inherit it here again, the parent classes GetProperties-Method will never be called!<br /> Only miss the call to inherited if you want to disable functionallity for a class, if not, don't forget it.<br /> <br /> In the script above, we return the Soup directly, without any operation. What exactly &quot;return types&quot; are will be explained another time :) (it will be too much detail to go into now!)<br /> <br /> <br /> ; SetProperties:<br /> In this method we get a paramter of type soup. We inherit the MapObject-Setproprties. This time we don't have to return any value. Here we will load the data from the Soup we got as paramter.<br /> <br /> <br /> ; '''Saving data'''<br /> Think of soup as a container into which you throw pieces of paper with names and values. When you want to find out what you wrote on the paper you look through all the pieces until you find the name and then read off the value. <br /> I already explained that Soup is a class. So it may have members, and in fact it has. Look at: [[Class_Soup]]<br /> <br /> I use the variable name as the soup tag name, because it's convenient. The method &quot;SetNamedTag&quot; in class Soup is used to assign a value to each tag in the soup. We can access all public methods inside a class with the dereference operator, that<br /> is a single dot ('''.'''). So, we call the function like this:<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, [VALUE]);<br /> <br /> <br /> Now in script, it looks like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now you'll understand, why we have to return the Soup back to Trainz. We manipulate the values inside the Soup and Trainz has to know it, if Trainz should save the Soup for us.<br /> <br /> <br /> ; '''Loading data'''<br /> The oppisite of &quot;Setting data&quot; (SetNamedTag) is &quot;Getting data&quot; (GetNamedTag). And, yes, Soup has a method called &quot;GetNamedTag&quot;, but it'll return the value as a string. We need a boolean value.<br /> So, we will use the method &quot;GetNamedTagAsBool&quot;. It expects only one paramter, the name of our value inside the Soup. We can directly assign the value of &quot;GetNamedTagAsBool&quot; to our variable.<br /> But this is a oveerloaded function. There are some variants. Another variant expects two parameters. The first one is the name of our value, and the other one is a standard value, if the selected<br /> value is not set in the Soup. We'll need that one! Because if we place an object in surveyor, there are no values inside the Soup. So, we can set an initial value for the door state. In our case we will set the initial door state to closed (so: m_bDoorOpened has to be false).<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> If we put that part into our script it'll look like:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> Now we can display and hide the meshes. But the object itself has to be prepared for it. The Ice cream truck has three meshes. The truck with a whole where the door is, a door in opened state and a door in closed state. You also may achieve this by using animations, but this way is pretty easier.<br /> <br /> [[File:Scripting_2_Truck_whole.jpg]]&lt;br&gt;<br /> Truck with whole, where the door is<br /> <br /> <br /> [[File:Scripting_2_Doors_open.jpg]]&lt;br&gt;<br /> Door in opened state<br /> <br /> <br /> [[File:Scripting_2_Doors_closed.jpg]]&lt;br&gt;<br /> Door in closed state<br /> <br /> <br /> In script we reference the mesh-table entries of config.txt.<br /> It may look like:<br /> <br /> &lt;pre&gt;<br /> [...]<br /> <br /> mesh-table<br /> { <br /> default<br /> {<br /> mesh &quot;truck.im&quot;<br /> auto-create 1<br /> }<br /> <br /> door-opened<br /> {<br /> mesh &quot;door_opened.im&quot;<br /> auto-create 0<br /> }<br /> <br /> door-closed<br /> {<br /> mesh &quot;door_closed.im&quot;<br /> auto-create 0<br /> }<br /> <br /> [...]<br /> }<br /> <br /> [...]<br /> &lt;/pre&gt;<br /> <br /> All meshes we want to control by script may never have an auto-create value of 1! It has to be 0, otherwise we can't take the control over the meshes.<br /> <br /> Our CIceCreamTruck's parent class is MapObject. And MapObject's parent class is MeshObject, and there we will find a method that is called &quot;SetMeshVisible&quot;.<br /> We can use it directly, because we automatically inherit from MeshObject, too.<br /> SetMeshVsible expects three parameters. The name of our mesh-table entry, a state (true, false - [visible, invisible]) and a floating number that sets a fading time in seconds.<br /> We'll leave the last parameter 0.0f.<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;NAME&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''true'''&lt;/font&gt;/&lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> <br /> <br /> We have two meshes, that has to be set. In script we'll hide/show them like this:<br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> };<br /> <br /> <br /> We can use our bool variable for indicating the mesh state. The opened mesh is set with the value of m_bDoorOpened. If m_bDoorOpened is true, the mesh will display, otherwise it'll hide.<br /> The closed state mesh is set with the oppsite value of m_bDoorOpened. This can be easily done by using the &quot;!&quot;-operator. Just place it in front of a boolean variable, to use the opposite value.<br /> <br /> Now you know how to control meshes. Because it will be too much for now, I'll give the last part of the script without explanation and move it to another time :)<br /> <br /> <br /> <br /> ; icecreamtruck.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CIceCreamTruck&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''bool'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public&lt;/font&gt; &lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#0000C0&quot;&gt;GetProperties&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> '''&lt;font color=&quot;#800000&quot;&gt;Soup&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;SetNamedTag&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' SetProperties&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Soup'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;);<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;pSoup&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;GetNamedTagAsBool&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#0000C0&quot;&gt;'''false'''&lt;/font&gt;);<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-opened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> &lt;font color=&quot;#0000C0&quot;&gt;SetMeshVisible&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;door-closed&quot;&lt;/font&gt;, !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;, &lt;font color=&quot;#FF8000&quot;&gt;0.0f&lt;/font&gt;);<br /> }<br /> <br /> &lt;font color=&quot;#008000&quot;&gt;//////////////////////////////////////////////////////////////////////////////////////////////////////////////&lt;/font&gt;<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetDescriptionHTML&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''void'''&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;();<br /> &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; = &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt; + &lt;font color=&quot;#800000&quot;&gt;'''HTMLWindow'''&lt;/font&gt;.&lt;font color=&quot;#0000C0&quot;&gt;CheckBox&lt;/font&gt;(&lt;font color=&quot;#808080&quot;&gt;&quot;live://property/m_bDoorOpened&quot;&lt;/font&gt;, &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;) + &lt;font color=&quot;#808080&quot;&gt;&quot;&amp;amp;nbsp;Open door&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sHtml&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public string''' GetPropertyType&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)&lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt; = &lt;font color=&quot;#808080&quot;&gt;&quot;link&quot;&lt;/font&gt;;<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''return'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sRet&lt;/font&gt;;<br /> }<br /> <br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' LinkPropertyValue&lt;/font&gt;(&lt;font color=&quot;#0000C0&quot;&gt;'''string'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''if'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;sPropertyId&lt;/font&gt; == &lt;font color=&quot;#808080&quot;&gt;&quot;m_bDoorOpened&quot;&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt; = !&lt;font color=&quot;#008000&quot;&gt;m_bDoorOpened&lt;/font&gt;;<br /> }<br /> }<br /> };<br /> <br /> Hope you enjoyed an learned!&lt;br&gt;<br /> Full example here: [[Media:TrainzDevIceCreamTruck.zip]] (Thanks to misterairbursh for the permission!)<br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> callavsg</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=HowTo/Your_first_Trainz_Script&diff=9910 2017-08-16T15:59:39Z

<p>Trev999: --~~~~ corrected spelling and grammar</p> <hr /> <div>Scripting is one of most powerful tools when creating trainz assets.<br /> More and more content creators are using scripts to extend the funciontallity of their contents,<br /> so scripters, like me, get a lot of request for script work.<br /> Finally, I thought, even for small functionallity, it'll be a good idea, if more people know how to script.<br /> <br /> I'm from Germany and this is my first article here, so feel free to send corrections or if you have the permission,<br /> feel free to correct this article on your own!<br /> <br /> First, let us take a theoretical approach:<br /> <br /> Trainz Script is a small programming language and has many similar aspects to Java or C++. I'll say it's a kind of a Framework,<br /> that allows us to implement new features based on built-in classes and their members.<br /> That means we have to assign our assets to a script class. Without a custom script, we do it by selecting the kind of our asset<br /> in config.txt. A kind of &quot;scenery&quot; (not &quot;scenery-trackside&quot;!) will assign the class &quot;MapObject&quot; to our asset.<br /> So, if we want to extend our asset of [[Class MapObject]], we'll have to extend the class itself.<br /> Extending a class means to create a custom script file with a custom class declaration inside of it that inherits from the [[Class MapObject]].<br /> &quot;MapObject&quot; then becomes our parent class and we have all functionallity of this class within our custom implemented class.<br /> <br /> A basic script may look like this:<br /> <br /> <br /> ; myscript.gs<br /> '''&lt;font color=&quot;#0000C0&quot;&gt;include&lt;/font&gt;''' &lt;font color=&quot;#808080&quot;&gt;&quot;MapObject.gs&quot;&lt;/font&gt;<br /> <br /> '''&lt;font color=&quot;#0000C0&quot;&gt;class&lt;/font&gt;''' &lt;font color=&quot;#008000&quot;&gt;CMyClass&lt;/font&gt; '''&lt;font color=&quot;#0000C0&quot;&gt;isclass&lt;/font&gt;''' '''&lt;font color=&quot;#800000&quot;&gt;MapObject&lt;/font&gt;'''<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''public void''' Init&lt;/font&gt;(&lt;font color=&quot;#800000&quot;&gt;'''Asset'''&lt;/font&gt; &lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;)<br /> {<br /> &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);<br /> }<br /> };<br /> <br /> As you see in the little script above, our class already has a member function. This member function (Init) is the most important member we have to implement.<br /> This little function initializes our class and inherits all the properties of our parent class (see: &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;(&lt;font color=&quot;#008000&quot;&gt;pAsset&lt;/font&gt;);).<br /> Without that function with its call to &lt;font color=&quot;#0000C0&quot;&gt;'''inherited'''&lt;/font&gt;, functionality of our asset is not granted, because in this case our parent class won't be initialized.<br /> <br /> <br /> '''Notice:'''<br /> <br /> 1. Never forget the &quot;Init&quot;-Method (method = function within class)!<br /> <br /> 2. Never forget to call &quot;inherited&quot;!<br /> <br /> <br /> <br /> In the config.txt of our asset, we need to set two new tags!<br /> The first tag is the &quot;script&quot;-tag and the second one is the &quot;class&quot;-tag. We have to fill these tags with our script information.<br /> <br /> '''script''': The filename of our script<br /> <br /> '''class''': The class we created for our <br /> <br /> <br /> In our case the config.txt may look like:<br /> <br /> &lt;pre&gt;<br /> trainz-build 3.7<br /> kuid [...]<br /> category-class &quot;[...]&quot;<br /> category-region &quot;[...]&quot;<br /> category-era &quot;[...]&quot;<br /> kind &quot;scenery&quot;<br /> description &quot;[...]&quot;<br /> username &quot;[...]&quot;<br /> script &quot;myscript.gs&quot;<br /> class &quot;CMyClass&quot;<br /> <br /> thumbnails<br /> {<br /> [...]<br /> }<br /> <br /> mesh-table<br /> {<br /> [...]<br /> }<br /> <br /> kuid-table<br /> {<br /> [...]<br /> }<br /> &lt;/pre&gt;<br /> <br /> <br /> ; What we've learned today:<br /> - If we want to extend the functionallity of an asset, we have to extend the Trainz-Script-Class that belongs to our asset (here [[Class MapObject]])<br /> <br /> - We extend our class by implementing a custom class that inherits from our parent class (CMyClass inherits from [[Class MapObject]])<br /> <br /> - All Trainz-Classes that assets can inherit from have the Init-Method and custom classes have to implement the Init-Method, too!<br /> <br /> <br /> If you want to contact me, you may use this e-mail: callavsg@gmx.de<br /> <br /> Until next time!<br /> <br /> callavsg</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Arrays&diff=8939 2016-06-14T17:24:25Z

<p>Trev999: </p> <hr /> <div>==Declaration, Initialisation &amp; Population==<br /> *Arrays need to be declared and initialised before they can be accessed, and it will usually be necessary to populate the array with meaningful data.&lt;br&gt;&lt;br&gt;<br /> <br /> {{MethodHeader|Declaration}}<br /> *A declaration reserves memory for the variable and allocates a name for that particular array. This is analogous to a housing developer buying a site and reserving it for future construction.<br /> <br /> *To declare an array you must first define the type of object which the array will contain, followed by opening and closing square braces and the name you will use to reference the array variable.<br /> <br /> *Just as residential developments can consist of any building type, arrays can consist of almost any class, including classes which you have defined yourself.<br /> <br /> Vehicle[] vehicles;<br /> int[] numberList;<br /> string[] words;<br /> GameObject[] objects;<br /> MyOwnClass[] myObjects;<br /> <br /> {{MethodHeader|Initialisation}}<br /> *In the same way that a developer must decide how many units he wants to build, you must decide how many members your array will initially be able to contain. You will be able to make the array larger or smaller later, for now you are just setting the initial size.<br /> *To initialise the array you use the keyword new, followed by the class of object that the array is to contain and the initial number of members in square brackets.<br /> <br /> vehicles = new Vehicle[5];<br /> numberList = new int[10];<br /> words = new string[2];<br /> objects = new GameObject[3];<br /> myObjects = new MyOwnClass[7];<br /> <br /> *It is possible, and often convenient, to declare and initialise the array in a single statement:<br /> <br /> Vehicle[] vehicles = new Vehicle[5];<br /> int[] numberList = new int[10];<br /> string[] words = new string[2];<br /> GameObject[] objects = new GameObject[3];<br /> MyOwnClass[] myObjects = new MyOwnClass[7];<br /> <br /> {{MethodHeader|Population}}<br /> *We now have a plot of land and some completed buildings but it will still be meaningless to call at an individual house because no-one will be living there.<br /> <br /> *You can populate the individual elements by assigning a value to an indexed position in the array. The syntax for this is:<br /> <br /> vehicles[0] = GetMyTrain().GetVehicles[3];<br /> numberList[0] = 0;<br /> words[3] = &quot;sentences&quot;<br /> objects[0] = me;<br /> myObjects[2] = Router.GetGameObject(&quot;my sibling&quot;);<br /> <br /> {{MethodHeader|Array Methods}}<br /> *A further shortcut is to use a method which returns an array to initialise and populate your array in a single statement. Often the same statement can also contain the declaration:<br /> <br /> Vehicle[] vehicles = World.GetVehicleList();<br /> int[] numberList = GetNumberList(1,10);<br /> string[] words = Str.Tokens(&quot;comma,separated,list&quot;,&quot;,&quot;);<br /> <br /> *You can write your own methods to return arrays:<br /> <br /> int[] GetNumberList(int start, int count) {<br /> int[] result = new int[0];<br /> int i;<br /> for (i = start; i &lt; count; i++) {<br /> result[result.size()] = i;<br /> }<br /> return result;<br /> }<br /> <br /> ==Array Operators==<br /> {{MethodHeader|Appending to an Array}}<br /> *This is a syntax which allows you to increase the size of a properly initialised array by adding a new member to the end. Since array indexing starts at zero, the last member will always be ''array[array.size() - 1]''. <br /> <br /> *Trying to read from ''array[array.size()]'' will result in a range error because you are attempting to access a location which does not exist.<br /> <br /> *Assigning to ''array[array.size()]'' however, will create a new member and increment the number of items in the array.<br /> <br /> vehicles[vehicles.size()] = me;<br /> <br /> {{MethodHeader|Indexing}}<br /> *A subscript enclosed in square brackets serves to define an individual item within an array. The notation will only be meaningful if that particular item has a value assigned. Assuming that this is the case when it isn't is a common error, and one that can be very difficult to find.<br /> <br /> *Given these statements:<br /> <br /> int[] numbers = new int[3];<br /> numbers[0] = 0;<br /> numbers[2] = 2;<br /> <br /> *''numbers[0]'' will return zero as an integer<br /> *''numbers[2]'' will return the value 2<br /> *''numbers[1]'' however will return null since no value has been assigned to that particular item.<br /> <br /> *Array indexing starts at zero (don't ask why) and finishes at ''array.size() - 1''.<br /> <br /> <br /> {{MethodHeader|Range Indexing}}<br /> *Whilst it is straightforward to erase a value from an array by assigning it to null, this doesn't affect the size of the array itself.<br /> <br /> *Given these statements:<br /> <br /> int[] numbers = new int[3];<br /> numbers[0] = 0;<br /> numbers[1] = 1;<br /> numbers[2] = 2;<br /> <br /> *Making the assignment ''numbers[2] = null'' will clear out the value but the array will still contain 3 items.<br /> <br /> *You can delete items and reduce the size of the array at the same time by specifying a range index like this:<br /> <br /> numbers[0,1] = null;<br /> <br /> *The first index is the position of the item to remove and the second is one greater than the position of the last item.<br /> <br /> numbers[0,1] = null removes the first item<br /> numbers[2,3] = null removes the last item<br /> <br /> *Array range indexing is an important tool for use with strings (which are really arrays of characters)<br /> <br /> <br /> {{MethodHeader|size()}}<br /> *''array.size()'' returns a count of the items in the array, this is no guarantee that all of the items have a value.<br /> <br /> <br /> {{anchor|copy}}{{MethodHeader|copy()}}<br /> *''copy()'' creates a duplicate of the array, the syntax is:<br /> <br /> int[] old = new int[3];<br /> int[] new;<br /> new.copy(old);<br /> <br /> *There is a subtle difference between copying an array and creating a duplicate reference to it by assignment. In the case above, the array ''new'' is an entirely separate variable from the array ''old''. Changing the values of one will not affect the other.<br /> <br /> int[] old = new int[3];<br /> int[] new;<br /> new = old;<br /> <br /> *will produce a similar result at first glance, but in this case assigning a new value to ''new[1]'' will also change the value of ''old[1]''. This is because the assignment effectively creates an alternative name for the same data.<br /> <br /> ==Code Samples==<br /> {{MethodHeader|Array Handling Methods}}<br /> *These are example routines which carry out some basic operations on string arrays, all the routines are case sensitive. They can be used for other object types with appropriate modification.<br /> <br /> *Member returns true if the string 's' is contained within the array 'strings'.<br /> <br /> public bool Member(string[] strings, string s) {<br /> int n;<br /> bool result = false;<br /> if (strings.size() == 0) {return result;}<br /> for (n = 0; n &lt; strings.size(); n++) {<br /> if (s == strings[n]) {<br /> result = true;<br /> break;<br /> }<br /> }<br /> return result;<br /> }<br /> <br /> *Add will append string 's' to the end of the array 'strings' as long as 's' is not already present.<br /> <br /> public void Add(string[] strings, string s) {<br /> if (Member(strings,s)) return;<br /> else {strings[strings.size()] = s;}<br /> }<br /> <br /> *Remove will delete any instance of string 's' from the array and reduce the size of the array accordingly.<br /> <br /> public void Remove(string[] strings, string s) {<br /> int n;<br /> if (strings.size() == 0) return;<br /> for (n = 0; n &lt; strings.size(); n++) {<br /> if (s == strings[n]) {strings[n,n+1] = null;}<br /> }<br /> }<br /> <br /> *Sort will perform a case sensitive alpha sort of the strings in the array. This is a flagged bubble sort, simple but slow, and is fine for most small arrays. For large arrays you should write your own quicksort method.<br /> <br /> public void Sort(string[] strings) {<br /> int x,y;<br /> string temp;<br /> bool flag;<br /> for (x = 0; x &lt; strings.size(); x++) {<br /> flag = false;<br /> for (y = 0; y &lt; strings.size() - 1; y++) {<br /> if (strings[y] &gt; strings[y + 1]) {<br /> temp = strings[y + 1];<br /> strings[y + 1] = strings[y];<br /> strings[y] = temp;<br /> flag = true;<br /> }<br /> }<br /> if (!flag) break;<br /> }<br /> }<br /> <br /> ==See Also==</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Help/HelpHowTo&diff=8406 2015-07-04T07:30:57Z

<p>Trev999: </p> <hr /> <div>To access the Help Mode drop-down menu, click on the question mark icon on the right uppermost corner.<br /> [[File:Help mode.jpg|400px|left]]<br /> <br /> == View Trainz Help ==<br /> <br /> This opens a browser window within Trainz to display the<br /> Online Wiki, specificaly on how to use the different driving modes.<br /> <br /> == Get help on... ==<br /> <br /> By first clicking this option and then clicking on an object that<br /> you wish to query, Trainz will open the in-game browser<br /> taking you to the wiki entry providing details or help for that<br /> object.<br /> <br /> == View Session Instructions ==<br /> This opens the Session Instructions window. Use it to review what you must do in the current session.</div>

Trev999 https://wiki.trainzsimulator.com/index.php?title=Help:Menu_Routes&diff=2897 2011-08-14T08:21:56Z

<p>Trev999: </p> <hr /> <div>The Routes Menu will display all the routes you have. It allows you to select a route to edit or drive etc.</div>

Trev999