Main toplevel type, provides access to most of the API though its members. An instance
of LuaGameScript is available as the global object named game
.
help() | Internal |
set_game_state{game_finished=…, player_won=…, next_level=…, can_continue=…, victorious_force=…} | Set scenario state. |
get_entity_by_tag(tag) → LuaEntity | |
show_message_dialog{text=…, image=…, point_to=…, style=…} | Show an in-game message dialog. |
disable_tips_and_tricks() | Disable showing tips and tricks. |
is_demo() → boolean | Is this the demo version of Factorio? |
reload_script() | Forces a reload of the scenario script from the original scenario location. |
reload_mods() | Forces a reload of all mods. |
save_atlas() | Saves the current configuration of Atlas to a file. |
check_consistency() | Run internal consistency checks. |
regenerate_entity(entities) | Regenerate autoplacement of some entities on all surfaces. |
take_screenshot{player=…, by_player=…, surface=…, position=…, resolution=…, zoom=…, path=…, show_gui=…, show_entity_info=…, anti_alias=…, quality=…, allow_in_replay=…, daytime=…, water_tick=…} | Take a screenshot and save it to a file. |
set_wait_for_screenshots_to_finish() | Forces the screenshot saving system to wait until all queued screenshots have been written to disk. |
take_technology_screenshot{force=…, path=…, by_player=…, selected_technology=…, skip_disabled=…, quality=…} | |
table_to_json(data) → string | Convert a table to a JSON string |
json_to_table(json) → Any | Convert a JSON string to a table |
write_file(filename, data, append, for_player) | Write a string to a file. |
remove_path(path) | Remove file or directory. |
remove_offline_players(players) | Remove players who are currently not connected from the map. |
force_crc() | Force a CRC check. |
create_force(force) → LuaForce | Create a new force. |
merge_forces(source, destination) | Marks two forces to be merge together. |
create_surface(name, settings) → LuaSurface | Create a new surface |
server_save(name) | Instruct the server to save the map. |
auto_save(name) | Instruct the game to perform an auto-save. |
delete_surface(surface) | Deletes the given surface and all entities on it. |
disable_replay() | Disables replay saving for the current save file. |
disable_tutorial_triggers() | Disables tutorial triggers, that unlock new tutorials and show notices about unlocked tutorials. |
direction_to_string(direction) | Converts the given direction into the string version of the direction. |
print(message, color) | Print text to the chat console all players. |
create_random_generator(seed) → LuaRandomGenerator | Creates a deterministic standalone random generator with the given seed or if a seed is not provided the initial map seed is used. |
check_prototype_translations() | Goes over all items, entities, tiles, recipes, technologies among other things and logs if the locale is incorrect. |
play_sound{path=…, position=…, volume_modifier=…} → boolean | Plays a sound for every player in the game on every surface. |
is_valid_sound_path(SoundPath) → boolean | Checks if the given sound path is valid. |
is_valid_sprite_path(sprite_path) → boolean | Returns true if sprite_path is valid and contains loaded sprite, otherwise false . |
kick_player(PlayerSpecification, reason) | Kicks the given player from this multiplayer game. |
ban_player(PlayerSpecification, reason) | Bans the given player from this multiplayer game. |
unban_player(PlayerSpecification) | Unbans the given player from this multiplayer game. |
purge_player(PlayerSpecification) | Purges the given players messages from the game. |
mute_player(PlayerSpecification) | Mutes the given player. |
unmute_player(PlayerSpecification) | Unmutes the given player. |
count_pipe_groups() | Counts how many distinct groups of pipes exist in the world. |
is_multiplayer() → boolean | Is the map loaded is multiplayer? |
get_active_entities_count(surface) → uint | Gets the number of entities that are active (updated each tick). |
get_map_exchange_string() → string | Gets the map exchange string for the map generation settings that were used to create this map. |
parse_map_exchange_string(map_exchange_string) → MapExchangeStringData | Convert a map exchange string to map gen settings and map settings. |
get_train_stops(opts) → array of LuaEntity | Gets train stops matching the given filters. |
get_player(player) → LuaPlayer | Gets the given player or returns nil if no player is found. |
get_surface(surface) → LuaSurface | Gets the given surface or returns nil if no surface is found. |
create_profiler() → LuaProfiler | Creates a LuaProfiler, which is used for measuring script performance. |
evaluate_expression(expression, variables) → double | Evaluate an expression, substituting variables as provided. |
get_filtered_entity_prototypes(filters) → CustomDictionary string → LuaEntityPrototype | |
get_filtered_item_prototypes(filters) → CustomDictionary string → LuaItemPrototype | |
get_filtered_equipment_prototypes(filters) → CustomDictionary string → LuaEquipmentPrototype | |
get_filtered_mod_setting_prototypes(filters) → CustomDictionary string → LuaModSettingPrototype | |
get_filtered_achievement_prototypes(filters) → CustomDictionary string → LuaAchievementPrototype | |
get_filtered_tile_prototypes(filters) → CustomDictionary string → LuaTilePrototype | |
get_filtered_decorative_prototypes(filters) → CustomDictionary string → LuaDecorativePrototype | |
get_filtered_fluid_prototypes(filters) → CustomDictionary string → LuaFluidPrototype | |
get_filtered_recipe_prototypes(filters) → CustomDictionary string → LuaRecipePrototype | |
get_filtered_technology_prototypes(filters) → CustomDictionary string → LuaTechnologyPrototype | |
create_inventory(size) → LuaInventory | Creates an inventory that is not owned by any game object. |
get_script_inventories(mod) → dictionary string → array of LuaInventory | Gets the inventories created through LuaGameScript::create_inventory |
reset_time_played() | Resets the amount of time played for this map. |
encode_string(string) → string | Deflates and base64 encodes the given string. |
decode_string(string) → string | Base64 decodes and inflates the given string. |
object_name :: string [R] | This objects name. |
player :: LuaPlayer [R] | The player typing at the console - nil in all other instances. |
players :: CustomDictionary uint or string → LuaPlayer [R] | |
map_settings :: MapSettings [R] | |
difficulty_settings :: DifficultySettings [R] | Although it can be done; because different difficulties can have different technology or recipe trees it's not recommended to change difficulty settings mid-game. |
difficulty :: defines.difficulty [R] | Current scenario difficulty. |
forces :: CustomDictionary uint or string → LuaForce [R] | |
entity_prototypes :: CustomDictionary string → LuaEntityPrototype [R] | |
item_prototypes :: CustomDictionary string → LuaItemPrototype [R] | |
fluid_prototypes :: CustomDictionary string → LuaFluidPrototype [R] | |
tile_prototypes :: CustomDictionary string → LuaTilePrototype [R] | |
equipment_prototypes :: CustomDictionary string → LuaEquipmentPrototype [R] | |
damage_prototypes :: CustomDictionary string → LuaDamagePrototype [R] | |
virtual_signal_prototypes :: CustomDictionary string → LuaVirtualSignalPrototype [R] | |
equipment_grid_prototypes :: CustomDictionary string → LuaEquipmentGridPrototype [R] | |
recipe_prototypes :: CustomDictionary string → LuaRecipePrototype [R] | |
technology_prototypes :: CustomDictionary string → LuaTechnologyPrototype [R] | |
decorative_prototypes :: CustomDictionary string → LuaDecorativePrototype [R] | |
particle_prototypes :: CustomDictionary string → LuaParticlePrototype [R] | |
autoplace_control_prototypes :: CustomDictionary string → LuaAutoplaceControlPrototype [R] | |
noise_layer_prototypes :: CustomDictionary string → LuaNoiseLayerPrototype [R] | |
mod_setting_prototypes :: CustomDictionary string → LuaModSettingPrototype [R] | |
custom_input_prototypes :: CustomDictionary string → LuaCustomInputPrototype [R] | |
ammo_category_prototypes :: CustomDictionary string → LuaAmmoCategoryPrototype [R] | |
named_noise_expressions :: CustomDictionary string → LuaNamedNoiseExpression [R] | |
item_subgroup_prototypes :: CustomDictionary string → LuaGroup [R] | |
item_group_prototypes :: CustomDictionary string → LuaGroup [R] | |
fuel_category_prototypes :: CustomDictionary string → LuaFuelCategoryPrototype [R] | |
resource_category_prototypes :: CustomDictionary string → LuaResourceCategoryPrototype [R] | |
achievement_prototypes :: CustomDictionary string → LuaAchievementPrototype [R] | |
module_category_prototypes :: CustomDictionary string → LuaModuleCategoryPrototype [R] | |
equipment_category_prototypes :: CustomDictionary string → LuaEquipmentCategoryPrototype [R] | |
trivial_smoke_prototypes :: CustomDictionary string → LuaTrivialSmokePrototype [R] | |
shortcut_prototypes :: CustomDictionary string → LuaShortcutPrototype [R] | |
recipe_category_prototypes :: CustomDictionary string → LuaRecipeCategoryPrototype [R] | |
styles :: CustomDictionary string → string [R] | The styles that LuaGuiElement can use. |
tick :: uint [R] | Current map tick. |
ticks_played :: uint [R] | The number of ticks since this game was 'created'. |
tick_paused :: boolean [RW] | If the tick has been paused. |
ticks_to_run :: uint [RW] | The number of ticks to be run while the tick is paused. |
finished :: boolean [R] | Is the scenario finished? |
speed :: float [RW] | Speed to update the map at. |
surfaces :: CustomDictionary uint or string → LuaSurface [R] | |
active_mods :: dictionary string → string [R] | The active mods versions. |
connected_players :: array of LuaPlayer [R] | The online players This is primarily useful when you want to do some action against all online players. |
permissions :: LuaPermissionGroups [R] | |
backer_names :: CustomDictionary uint → string [R] | |
default_map_gen_settings :: MapGenSettings [R] | The default map gen settings for this save. |
enemy_has_vision_on_land_mines :: boolean [RW] | Determines if enemy land mines are completely invisible or not. |
autosave_enabled :: boolean [RW] | True by default. |
draw_resource_selection :: boolean [RW] | True by default. |
pollution_statistics :: LuaFlowStatistics [R] | The pollution statistics for this map. |
max_force_distraction_distance :: double [R] | |
max_force_distraction_chunk_distance :: uint [R] | |
max_electric_pole_supply_area_distance :: float [R] | |
max_electric_pole_connection_distance :: double [R] | |
max_beacon_supply_area_distance :: double [R] | |
max_gate_activation_distance :: double [R] | |
max_inserter_reach_distance :: double [R] | |
max_pipe_to_ground_distance :: uint8 [R] | |
max_underground_belt_distance :: uint8 [R] |
Internal
Set scenario state.
Show an in-game message dialog.
point_to={type="nowhere"}
to remove the arrow entirely.) The dialog itself will be placed near the arrow's target.Disable showing tips and tricks.
Is this the demo version of Factorio?
Forces a reload of the scenario script from the original scenario location.
Forces a reload of all mods.
Saves the current configuration of Atlas to a file. This will result in huge file containing all of the game graphics moved to as small space as possible.
Run internal consistency checks. Allegedly prints any errors it finds.
Take a screenshot and save it to a file.
Forces the screenshot saving system to wait until all queued screenshots have been written to disk.
"player
" force is used.true
, disabled technologies will be skipped. Their successors
will be attached to the disabled technology's parents. Defaults to false
.Convert a JSON string to a table
nil
if the json was invalid.Write a string to a file.
true
, this will append to the end of the file. Defaults to false
, which will overwrite any pre-existing file with the new data.Remove file or directory. Given path is taken relative to the script output directory. Can be used to remove files created by LuaGameScript::write_file.
Force a CRC check. Tells all peers to calculate their current map CRC; these CRC are then compared against each other. If a mismatch is detected, the game is desynced and some peers are forced to reconnect.
Create a new force.
Marks two forces to be merge together. All entities in the source force will be reassigned to the target force. The source force will then be destroyed.
Create a new surface
Instruct the server to save the map.
Instruct the game to perform an auto-save.
Deletes the given surface and all entities on it.
Disables replay saving for the current save file. Once done there's no way to re-enable replay saving for the save file without loading an old save.
Disables tutorial triggers, that unlock new tutorials and show notices about unlocked tutorials.
Converts the given direction into the string version of the direction.
Print text to the chat console all players.
Creates a deterministic standalone random generator with the given seed or if a seed is not provided the initial map seed is used.
Goes over all items, entities, tiles, recipes, technologies among other things and logs if the locale is incorrect.
Plays a sound for every player in the game on every surface.
Checks if the given sound path is valid.
Returns true
if sprite_path is valid and contains loaded sprite, otherwise false
. Sprite path of type file
doesn't validate if file exists.
Kicks the given player from this multiplayer game. Does nothing if this is a single player game or if the player running this isn't an admin.
Bans the given player from this multiplayer game. Does nothing if this is a single player game of if the player running this isn't an admin.
Unbans the given player from this multiplayer game. Does nothing if this is a single player game of if the player running this isn't an admin.
Purges the given players messages from the game. Does nothing if the player running this isn't an admin.
Mutes the given player. Does nothing if the player running this isn't an admin.
Unmutes the given player. Does nothing if the player running this isn't an admin.
Counts how many distinct groups of pipes exist in the world.
Is the map loaded is multiplayer?
Gets the number of entities that are active (updated each tick).
Gets the map exchange string for the map generation settings that were used to create this map.
Convert a map exchange string to map gen settings and map settings.
Gets train stops matching the given filters.
Creates a LuaProfiler, which is used for measuring script performance.
Evaluate an expression, substituting variables as provided. For details on the formula, see the relevant page on the Factorio wiki.
local formula = game.forces["player"].technologies["mining-productivity-4"].research_unit_count_formula
local units = game.evaluate_expression(formula, { L = 10, l = 10 })
Creates an inventory that is not owned by any game object. It can be resized later with LuaInventory::resize.
Gets the inventories created through LuaGameScript::create_inventory
"core
".Resets the amount of time played for this map.
Deflates and base64 encodes the given string.
nil
if the encode failed.Base64 decodes and inflates the given string.
nil
if the decode failed.This objects name.
The player typing at the console - nil
in all other instances. See LuaGameScript::players for accessing all players.
Although it can be done; because different difficulties can have different technology or recipe trees it's not recommended to change difficulty settings mid-game.
Current scenario difficulty.
The styles that LuaGuiElement can use. A mapping of style name to style type.
Current map tick.
The number of ticks since this game was 'created'. A game is 'created' either by using "new game" or "new game from scenario".
If the tick has been paused. This means that entity update has been paused.
The number of ticks to be run while the tick is paused. When LuaGameScript::tick_paused is true, ticks_to_run behaves the following way: While this is > 0, the entity update is running normally and this value is decremented every tick. When this reaches 0, the game will pause again.
Is the scenario finished?
Speed to update the map at. 1.0 is normal speed -- 60 UPS.
The active mods versions. The keys are mod names, the values are the versions.
for name, version in pairs(game.active_mods) do
p.print(name .. " version " .. version)
end
The online players
This is primarily useful when you want to do some action against all online players.
The default map gen settings for this save.
Determines if enemy land mines are completely invisible or not.
True by default. Can be used to disable autosaving. Make sure to turn it back on soon after.
True by default. Can be used to disable the highlighting of resource patches when they are hovered on the map.
The pollution statistics for this map.