Track Functions

Aus EEP Handbuch
Version vom 8. September 2018, 10:41 Uhr von Marc Horstmann (Diskussion | Beiträge)

(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche
EEPRegister_X_Track() EEPRegister_X_Track(ID)
type: function
    EEPRegisterRailTrack(1)
                
caller: script
defined in: EEP
parameters: one
returns: one
requires: EEP 11.3 plug-in 3
purpose: Registers a track element for “occupied” enquiries.
notes:
  • The _X_ is to be substituted by one of the following strings:
    • Rail: for the rail track system.
    • Road: for the street system.
    • Tram: for the commuter tracks system.
    • Auxiliary: for the auxiliary track system
    • Control: for the control track system
  • Argument is the ID of the track element.
  • Return value is true, if the targeted track exists, else false.
  • Registration is mandatory for EEPIs_X_TrackReserved() function.


EEPIs_X_TrackReserved() EEPIs_X_TrackReserved(ID)
type: function
    hResult, hData = EEPIsRailTrackReserved(1,true)
                
caller: script
defined in: EEP
parameters: one (optional two)
returns: two (optional three)
requires: EEP 11.3 plug-in 3, EEP 13.2 plug-in 2
purpose: Enquires if the specified track element is occupied by any vehicle.
notes:
  • The _X_ is to be substituted by one of the following strings:
    • Rail: for the rail track system.
    • Road: for the street system.
    • Tram: for the commuter tracks system.
    • Auxiliary: for the auxiliary track system
    • Control: for the control track system
  • Argument is the ID of the track element.
  • An optional second argument may be added when plug-in 2 for EEP 13 is installed. If true is provided as a second argument, the name of the train occupying this track is returned as a third value.
  • First return value is true, if the targeted track element exists and has been registered prior to the enquiry.
  • Second return value is true, if the track element is occupied, else false.
  • Third return value is the name of the train occupying this track. If more than one train occupies this track, the name of the train closest to the track’s end is returned.
  • Remember to register track before using this function!