Simutrans-Squirrel-API OTRP v63_4
Loading...
Searching...
No Matches
schedule_x Class Reference
Collaboration diagram for schedule_x:

Public Member Functions

 schedule_x ()
void set_next_line (line_x line)
void set_next_line ()

Public Attributes

array< schedule_entry_x > entries
way_types waytype
integer base_waiting_time
integer current
integer flags
integer max_speed
line_x departure_slot_group_id
line_x next_line

Detailed Description

Class holding the schedule

Definition at line 57 of file api_schedule.cc.

Constructor & Destructor Documentation

◆ schedule_x()

schedule_x::schedule_x ( )

Constructor

Member Function Documentation

◆ set_next_line()

void schedule_x::set_next_line ( line_x line)

Sets the next line, applying validity checks (waytype match, >=2 entries, stoppable halt at first stop). Pass null to unset.

Note
The underlying C++ implementation calls unset_next_line() before running validity checks. Therefore, if a non-null line is passed and fails the checks, the existing next_line is still cleared. After a failed call, next_line will be null.
Parameters
linethe candidate next line, or null

Member Data Documentation

◆ base_waiting_time

integer schedule_x::base_waiting_time

Additional base waiting time for this schedule.

Definition at line 76 of file api_schedule.cc.

◆ current

integer schedule_x::current

Current stop of schedule: default first stop (schedule of line) or next stop of convoy (schedule of convoy).

In order to change this value for a convoy call convoy_x::change_schedule.

Definition at line 86 of file api_schedule.cc.

◆ departure_slot_group_id

line_x schedule_x::departure_slot_group_id

The leader line of the departure slot group. A line in its own group has this set to its own line. null if not assigned to any departure slot group.

Definition at line 103 of file api_schedule.cc.

◆ entries

array< schedule_entry_x > schedule_x::entries

The list of schedule targets.

Definition at line 66 of file api_schedule.cc.

◆ flags

integer schedule_x::flags

Schedule-level flags bitmask (TEMPORARY=1, SAME_DEP_TIME=2, FULL_LOAD_ACCELERATION=4, FULL_LOAD_TIME=8, REVERSE_DEFAULT=16).

Definition at line 91 of file api_schedule.cc.

◆ max_speed

integer schedule_x::max_speed

Schedule-level operational maximum speed (km/h). 0 means no limit.

Definition at line 96 of file api_schedule.cc.

◆ next_line

line_x schedule_x::next_line

The line to which the convoy transitions when this schedule is completed. Read-only: use set_next_line to change this value. null if not set.

Definition at line 110 of file api_schedule.cc.

◆ waytype

way_types schedule_x::waytype

Waytype of schedule.

Definition at line 71 of file api_schedule.cc.


The documentation for this class was generated from the following file: