LuaSchedule

The schedule of a particular LuaTrain or LuaSpacePlatform.

Attributes

owner

• Read: LuaTrain | LuaSpacePlatform
• Write: unknown
• Optional: true

The owner of this schedule.

interrupt_count

• Read: uint32
• Write: unknown
• Optional: false

current

• Read: uint32
• Write: unknown
• Optional: false

The schedule index of the current destination.

tick_of_last_schedule_change

• Read: MapTick
• Write: unknown
• Optional: false

tick_of_last_activity

• Read: MapTick
• Write: MapTick
• Optional: false

The time when the train or space platform was last considered active for the inactivity condition.

Note: when writing, value must not be larger than LuaGameScript::tick

ticks_in_station

• Read: MapTick
• Write: unknown
• Optional: false

How long this train or space platform has been in the current station.

group

• Read: string
• Write: string
• Optional: true

The group this schedule is part of, if any.

valid

• Read: boolean
• Write: unknown
• Optional: false

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name

• Read: string
• Write: unknown
• Optional: false

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Methods

add_wait_condition

LuaSchedule.add_wait_condition(record_position: ScheduleRecordPosition, condition_index: uint32, type: WaitConditionType)

Call As

schedule.add_wait_condition(record_position, condition_index, type)

Call Convention

• takes_table: false
• table_optional: false

Adds the given wait condition to the given record.

Parameters

• record_position: ScheduleRecordPosition
• condition_index: uint32
• type: WaitConditionType

remove_wait_condition

LuaSchedule.remove_wait_condition(record_position: ScheduleRecordPosition, condition_index: uint32)

Call As

schedule.remove_wait_condition(record_position, condition_index)

Call Convention

• takes_table: false
• table_optional: false

Removes the given wait condition from the given record.

Parameters

• record_position: ScheduleRecordPosition
• condition_index: uint32

set_wait_condition_mode

LuaSchedule.set_wait_condition_mode(record_position: ScheduleRecordPosition, condition_index: uint32, mode: string)

Call As

schedule.set_wait_condition_mode(record_position, condition_index, mode)

Call Convention

• takes_table: false
• table_optional: false

Sets the comparison on the given wait condition.

Parameters

• record_position: ScheduleRecordPosition
• condition_index: uint32
• mode: string — "and", or "or"

change_wait_condition

LuaSchedule.change_wait_condition(record_position: ScheduleRecordPosition, condition_index: uint32, wait_condition: WaitCondition)

Call As

schedule.change_wait_condition(record_position, condition_index, wait_condition)

Call Convention

• takes_table: false
• table_optional: false

Changes the wait condition on the given record to the new values.

Parameters

• record_position: ScheduleRecordPosition
• condition_index: uint32
• wait_condition: WaitCondition

add_record

LuaSchedule.add_record(data: AddRecordData) -> uint32?

Call As

schedule.add_record(data)

Call Convention

• takes_table: false
• table_optional: false

Adds the given record to the end of the current schedule or at the given index using the provided data.

Parameters

• data: AddRecordData

Returns

• uint32? — The index the record was added at.

remove_record

LuaSchedule.remove_record(record_position: ScheduleRecordPosition)

Call As

schedule.remove_record(record_position)

Call Convention

• takes_table: false
• table_optional: false

Removes the record at the given record position, if the record position is valid.

Parameters

• record_position: ScheduleRecordPosition

copy_record

LuaSchedule.copy_record(source_schedule: LuaSchedule, source_index: uint32, destination_index: uint32)

Call As

schedule.copy_record(source_schedule, source_index, destination_index)

Call Convention

• takes_table: false
• table_optional: false

Copies the record from the given schedule at the given index into this schedule at the given index.

Parameters

• source_schedule: LuaSchedule
• source_index: uint32
• destination_index: uint32

add_interrupt

LuaSchedule.add_interrupt(interrupt: ScheduleInterrupt)

Call As

schedule.add_interrupt(interrupt)

Call Convention

• takes_table: false
• table_optional: false

Adds the given interrupt to the schedule if an interrupt with the given name does not already exist.

Parameters

• interrupt: ScheduleInterrupt

remove_interrupt

LuaSchedule.remove_interrupt(index: uint32)

Call As

schedule.remove_interrupt(index)

Call Convention

• takes_table: false
• table_optional: false

Removes the interrupt at the given index, if the index is valid.

Parameters

• index: uint32

activate_interrupt

LuaSchedule.activate_interrupt(index: uint32)

Call As

schedule.activate_interrupt(index)

Call Convention

• takes_table: false
• table_optional: false

Activates the interrupt at the given index, if the index is valid.

Parameters

• index: uint32

change_interrupt

LuaSchedule.change_interrupt(index: uint32, interrupt: ScheduleInterrupt)

Call As

schedule.change_interrupt(index, interrupt)

Call Convention

• takes_table: false
• table_optional: false

Changes the interrupt at the given index to the provided values. Note, the names must match.

Parameters

• index: uint32
• interrupt: ScheduleInterrupt

rename_interrupt

LuaSchedule.rename_interrupt(old_name: string, new_name: string)

Call As

schedule.rename_interrupt(old_name, new_name)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• old_name: string — The interrupt to rename
• new_name: string — The new name - if it already exists, does nothing.

go_to_station

LuaSchedule.go_to_station(schedule_index: uint32)

Call As

schedule.go_to_station(schedule_index)

Call Convention

• takes_table: false
• table_optional: false

Sets the train or space platform to go to a destination, including changing the train/space platform to automatic mode.

Parameters

• schedule_index: uint32 — The schedule index

set_stopped

LuaSchedule.set_stopped(stopped: boolean)

Call As

schedule.set_stopped(true)

Call Convention

• takes_table: false
• table_optional: false

Sets whether this train is in manual mode or this space platform is paused.

Parameters

• stopped: boolean

set_allow_unloading

LuaSchedule.set_allow_unloading(record_position: ScheduleRecordPosition, allow: boolean)

Call As

schedule.set_allow_unloading(record_position, true)

Call Convention

• takes_table: false
• table_optional: false

Sets if unloading is allowed at the given schedule record position. Only relevant for space platforms.

Parameters

• record_position: ScheduleRecordPosition
• allow: boolean

drag_record

LuaSchedule.drag_record(from: uint32, to: uint32, interrupt_index?: uint32)

Call As

schedule.drag_record(from, to, interrupt_index)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• from: uint32
• to: uint32
• interrupt_index?: uint32 — The interrupt to operate on, if any.

drag_interrupt

LuaSchedule.drag_interrupt(from: uint32, to: uint32)

Call As

schedule.drag_interrupt(from, to)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• from: uint32
• to: uint32

drag_wait_condition

LuaSchedule.drag_wait_condition(record_position: ScheduleRecordPosition, from: uint32, to: uint32)

Call As

schedule.drag_wait_condition(record_position, from, to)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• record_position: ScheduleRecordPosition — The record to change.
• from: uint32
• to: uint32

get_record

LuaSchedule.get_record(record_position: ScheduleRecordPosition) -> ScheduleRecord?

Call As

schedule.get_record(record_position)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• record_position: ScheduleRecordPosition

Returns

• ScheduleRecord?

get_records

LuaSchedule.get_records(interrupt_index?: uint32) -> Array<ScheduleRecord>?

Call As

schedule.get_records()

Call Convention

• takes_table: false
• table_optional: false

Parameters

• interrupt_index?: uint32 — If provided, gets the records for this interrupt.

Returns

• Array<ScheduleRecord>?

set_records

LuaSchedule.set_records(records: Array<ScheduleRecord>, interrupt_index?: uint32)

Call As

schedule.set_records(records, interrupt_index)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• records: Array<ScheduleRecord>
• interrupt_index?: uint32 — If provided, the records will be set on this interrupt.

clear_records

LuaSchedule.clear_records(interrupt_index?: uint32)

Call As

schedule.clear_records()

Call Convention

• takes_table: false
• table_optional: false

Parameters

• interrupt_index?: uint32 — If provided, clears the records for this interrupt.

get_interrupt

LuaSchedule.get_interrupt(index: uint32) -> ScheduleInterrupt?

Call As

schedule.get_interrupt(index)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• index: uint32

Returns

• ScheduleInterrupt?

get_interrupts

LuaSchedule.get_interrupts() -> Array<ScheduleInterrupt>

Call As

schedule.get_interrupts()

Call Convention

• takes_table: false
• table_optional: false

Returns

• Array<ScheduleInterrupt>

set_interrupts

LuaSchedule.set_interrupts(interrupts: Array<ScheduleInterrupt>)

Call As

schedule.set_interrupts(interrupts)

Call Convention

• takes_table: false
• table_optional: false

Parameters

• interrupts: Array<ScheduleInterrupt>

clear_interrupts

LuaSchedule.clear_interrupts()

Call As

schedule.clear_interrupts()

Call Convention

• takes_table: false
• table_optional: false

Removes all interrupts.

get_wait_condition

LuaSchedule.get_wait_condition(record_position: ScheduleRecordPosition, condition_index: uint32) -> WaitCondition?

Call As

schedule.get_wait_condition(record_position, condition_index)

Call Convention

• takes_table: false
• table_optional: false

Gets the wait condition at the given record position if one exists.

Parameters

• record_position: ScheduleRecordPosition
• condition_index: uint32

Returns

• WaitCondition?

get_wait_conditions

LuaSchedule.get_wait_conditions(record_position: ScheduleRecordPosition) -> Array<WaitCondition>?

Call As

schedule.get_wait_conditions(record_position)

Call Convention

• takes_table: false
• table_optional: false

Gets the wait conditions at the given record position if they exist.

Parameters

• record_position: ScheduleRecordPosition

Returns

• Array<WaitCondition>?

get_wait_condition_count

LuaSchedule.get_wait_condition_count(record_position: ScheduleRecordPosition) -> uint32?

Call As

schedule.get_wait_condition_count(record_position)

Call Convention

• takes_table: false
• table_optional: false

The number of wait conditions in the given schedule record.

Parameters

• record_position: ScheduleRecordPosition

Returns

• uint32?

get_inside_interrupt

LuaSchedule.get_inside_interrupt(interrupt_index: uint32) -> boolean

Call As

schedule.get_inside_interrupt(interrupt_index)

Call Convention

• takes_table: false
• table_optional: false

Gets if the given interrupt can be triggered inside other interrupts.

Parameters

• interrupt_index: uint32

Returns

• boolean

set_inside_interrupt

LuaSchedule.set_inside_interrupt(interrupt_index: uint32, value: boolean)

Call As

schedule.set_inside_interrupt(interrupt_index, true)

Call Convention

• takes_table: false
• table_optional: false

Sets if the given interrupt can be triggered inside other interrupts.

Parameters

• interrupt_index: uint32
• value: boolean

get_record_count

LuaSchedule.get_record_count(interrupt_index?: uint32) -> uint32?

Call As

schedule.get_record_count()

Call Convention

• takes_table: false
• table_optional: false

If the given index is invalid, nil is returned.

Parameters

• interrupt_index?: uint32 — If provided, the record count in this interrupt is read.

Returns

• uint32?