LuaSimulation

Functions for use during simulations. This object cannot be saved, and cannot be used outside of a simulation.

The simulation object instance can be obtained from LuaGameScript::simulation.

Attributes

camera_player_cursor_position

• Read: MapPosition
• Write: MapPosition
• Optional: true

camera_position

• Read: MapPosition
• Write: MapPosition
• Optional: true

camera_surface_index

• Read: uint32
• Write: uint32
• Optional: true

hide_cursor

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

camera_zoom

• Read: unknown
• Write: double
• Optional: false

camera_player

• Read: unknown
• Write: PlayerIdentification
• Optional: false

camera_player_cursor_direction

• Read: unknown
• Write: defines.direction
• Optional: false

camera_alt_info

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

smart_belt_building

• Read: unknown
• Write: boolean
• Optional: true

gui_tooltip_interval

• Read: unknown
• Write: double
• Optional: false

active_quickbars

• Read: unknown
• Write: uint8
• Optional: false

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

create_test_player

LuaSimulation.create_test_player{ name: string } -> LuaPlayer

Call As

simulation.create_test_player{ name=name }

Call Convention

• takes_table: true
• table_optional: false

Parameters

• name: string — The name of the new player.

Returns

• LuaPlayer — The created player.

get_slot_position

LuaSimulation.get_slot_position{ inventory_index: InventoryIndex, slot_index: ItemStackIndex, inventory?: "character" | "entity" } -> MapPosition?

Call As

simulation.get_slot_position{ inventory_index=inventory_index, slot_index=slot_index }

Call Convention

• takes_table: true
• table_optional: false

Parameters

• inventory_index: InventoryIndex
• slot_index: ItemStackIndex — This index is 0-based, unlike other inventory indices.
• inventory?: "character" | "entity" — Defaults to "character".

Returns

• MapPosition? — Position of the GUI slot on the screen, if successfully found.

get_widget_position

LuaSimulation.get_widget_position{ type: SimulationWidgetType, data?: string, data2?: string } -> MapPosition?

Call As

simulation.get_widget_position{ type=type }

Call Convention

• takes_table: true
• table_optional: false

Parameters

• type: SimulationWidgetType
• data?: string
• data2?: string

Returns

• MapPosition? — Center of the GUI widget on the screen, if successfully found.

activate_rail_planner

LuaSimulation.activate_rail_planner{ position?: MapPosition, ghost_mode?: boolean, build_mode?: defines.build_mode }

Call As

simulation.activate_rail_planner{ position=position }

Call Convention

• takes_table: true
• table_optional: true

Activate the rail planner at the given position.

Parameters

• position?: MapPosition
• ghost_mode?: boolean — Defaults to false.
• build_mode?: defines.build_mode — Defaults to normal.

deactivate_rail_planner

LuaSimulation.deactivate_rail_planner()

Call As

simulation.deactivate_rail_planner()

Call Convention

• takes_table: false
• table_optional: false

Deactivate the rail planner.

move_cursor

LuaSimulation.move_cursor{ position: MapPosition, speed?: double } -> boolean

Call As

simulation.move_cursor{ position=position }

Call Convention

• takes_table: true
• table_optional: false

Move the cursor towards the given position at the given speed.

Parameters

• position: MapPosition
• speed?: double — Defaults to 0.2.

Returns

• boolean — Whether the cursor will reach the target position with this move.

mouse_down

LuaSimulation.mouse_down()

Call As

simulation.mouse_down()

Call Convention

• takes_table: false
• table_optional: false

Send a left mouse button-down event at its current position.

mouse_up

LuaSimulation.mouse_up()

Call As

simulation.mouse_up()

Call Convention

• takes_table: false
• table_optional: false

Send a left mouse button-up event at its current position.

mouse_click

LuaSimulation.mouse_click()

Call As

simulation.mouse_click()

Call Convention

• takes_table: false
• table_optional: false

Send a left mouse button click event at its current position. This is equivalent to calling LuaSimulation::mouse_down, then LuaSimulation::mouse_up.

control_down

LuaSimulation.control_down{ control: string, notify: boolean }

Call As

simulation.control_down{ control=control, notify=true }

Call Convention

• takes_table: true
• table_optional: false

Send a control press event at the current cursor position.

Parameters

• control: string — The name of the control input to press.
• notify: boolean — Whether to show flying text of the activated control.

control_up

LuaSimulation.control_up{ control: string }

Call As

simulation.control_up{ control=control }

Call Convention

• takes_table: true
• table_optional: false

Send a control release event at the current cursor position.

Parameters

• control: string — The name of the control input to release.

control_press

LuaSimulation.control_press{ control: string, notify: boolean }

Call As

simulation.control_press{ control=control, notify=true }

Call Convention

• takes_table: true
• table_optional: false

Send a control down and up event at the current cursor position. This is equivalent to calling LuaSimulation::control_down, then LuaSimulation::control_up.

Parameters

• control: string — The name of the control input to press and release.
• notify: boolean — Whether to show flying text of the activated control.

write

LuaSimulation.write{ text?: string }

Call As

simulation.write{ text=text }

Call Convention

• takes_table: true
• table_optional: false

Write text as if it was typed by a player. Overwrites existing text by selecting it first.

Parameters

• text?: string — The text to write. Does nothing if no text is provided.

scroll_clipboard_forwards

LuaSimulation.scroll_clipboard_forwards()

Call As

simulation.scroll_clipboard_forwards()

Call Convention

• takes_table: false
• table_optional: false

Scroll the clipboard forwards by one entry.

scroll_clipboard_backwards

LuaSimulation.scroll_clipboard_backwards()

Call As

simulation.scroll_clipboard_backwards()

Call Convention

• takes_table: false
• table_optional: false

Scroll the clipboard backwards by one entry.