SimulationDefinition

Used by tips and tricks and main menu simulations. Simulations can be controlled at runtime via LuaSimulation.

Type

struct

Properties

planet

• Type: SpaceLocationID
• Optional: true

game_view_settings

• Type: GameViewSettings
• Optional: true

Only applied to the simulation if a test player is created through LuaSimulation::create_test_player.

save

• Type: FileName
• Optional: true

The save file that is used for this simulation. If not given and generate_map is true, a map is generated by the game.

init_file

• Type: FileName
• Optional: true

This code is run as a (silent) console command inside the simulation when it is first initialized. Since this is run as a console command, the restrictions of console commands apply, e.g. require is not available, see here.

init

• Type: string
• Optional: true

Only loaded if init_file is not defined.

This code is run as a (silent) console command inside the simulation when it is first initialized. Since this is run as a console command, the restrictions of console commands apply, e.g. require is not available, see here.

update_file

• Type: FileName
• Optional: true

This code is run as a (silent) console command inside the simulation every time the simulation is updated. Since this is run as a console command, the restrictions of console commands apply, e.g. require is not available, see here.

update

• Type: string
• Optional: true

Only loaded if update_file is not defined.

This code is run as a (silent) console command inside the simulation every time the simulation is updated. Since this is run as a console command, the restrictions of console commands apply, e.g. require is not available, see here.

mods

• Type: Array<string>
• Optional: true

An array of mods whose runtime scripts will be loaded for this simulation, if they are present and enabled.

init_update_count

• Type: uint32
• Optional: true

Amount of ticks that this simulation should run for before the simulation is shown to the player. These updates happen after init/init_file has been run and at the highest possible rate (> 60 UPS).

length

• Type: uint32
• Optional: true

How long this simulation takes. In the main menu simulations, another simulation will start after this simulation ends.

generate_map

• Type: boolean
• Optional: true

If save is not given and this is true, a map gets generated by the game for use in the simulation.

checkboard

• Type: boolean
• Optional: true

If this is true, the map of the simulation is set to be a lab-tile checkerboard in the area of {{-20, -15},{20, 15}} when the scenario is first initialized (before init/init_file run).

hide_health_bars

• Type: boolean
• Optional: true

mute_technology_finished_sound

• Type: boolean
• Optional: true

mute_alert_sounds

• Type: boolean
• Optional: true

volume_modifier

• Type: float
• Optional: true

Multiplier for the simulation volume set by the player in the sound settings.

override_volume

• Type: boolean
• Optional: true

If true, overrides the simulation volume set by the player in the sound settings, simply setting the volume modifier to 1.

mute_wind_sounds

• Type: boolean
• Optional: true

Overrides whether a simulation has its wind sounds muted.

Tips and Tricks simulations and Factoriopedia simulations have their wind sounds muted by default, other simulations don't.

hide_factoriopedia_gradient

• Type: boolean
• Optional: true