get_entity_count(name) → uint | Count entities of given type. |
disable_research() | Disable research for this force. |
enable_research() | Enable research for this force. |
disable_all_prototypes() | Disable all recipes and technologies. |
reset_recipes() | Load the original version of all recipes from the prototypes. |
enable_all_recipes() | Unlock all recipes. |
enable_all_technologies() | Unlock all technologies. |
research_all_technologies() | Research all technologies. |
reset_technologies() | Load the original versions of technologies from prototypes. |
reset() | Reset everything. |
chart(surface, area) | Chart a portion of the map. |
clear_chart() | Remove all charted area from the chart. |
rechart() | Force a rechart of the whole chart. |
chart_all() | Chart all generated chunks. |
is_chunk_charted(surface, position) → boolean | Has a chunk been charted? |
get_ammo_damage_modifier(ammo) → double | |
set_ammo_damage_modifier(ammo, modifier) | |
get_gun_speed_modifier(ammo) → double | |
set_gun_speed_modifier(ammo, modifier) | |
get_turret_attack_modifier(turret) → double | |
set_turret_attack_modifier(turret, modifier) | |
set_cease_fire(other, cease_fire) | Stop attacking members of a given force. |
get_cease_fire(other) → boolean | Will this force attack members of another force? |
is_pathfinder_busy() → boolean | Is pathfinder busy? |
kill_all_units() | Kill all units and flush the pathfinder. |
find_logistic_network_by_position(position, surface) → LuaLogisticNetwork | |
set_kill_count(entity, count) | |
get_kill_count(entity) → uint | How many entities of a given type were killed by this force. |
set_spawn_position(position, surface) | |
get_spawn_position(surface) → Position | |
name :: string [R] | Name of the force. |
technologies :: dictionary string → LuaTechnology [R] | Technologies owned by this force, indexed by their name. |
recipes :: dictionary string → LuaRecipe [R] | Recipes available to this force, indexed by their name. |
manual_mining_speed_modifier :: double [RW] | Multiplier of the manual mining speed. |
manual_crafting_speed_modifier :: double [RW] | Multiplier of the manual crafting speed. |
laboratory_speed_modifier :: double [RW] | |
logistic_robot_speed_modifier :: double [RW] | |
logistic_robot_storage_modifier :: double [RW] | |
current_research :: LuaTechnology or string [RW] | The current research in progress. |
research_progress :: double [RW] | Progress of current research, as a number in range [0, 1]. |
inserter_stack_size_bonus :: uint [RW] | Number of extra items that can be transferred (so 1 + inserter_stack_size_bonus is transfer
stack size)
|
character_logistic_slot_count :: double [RW] | Number of character logistic slots. |
character_trash_slot_count :: double [RW] | Number of character trash slots. |
quickbar_count :: uint [RW] | Number of character quick bars. |
maximum_following_robot_count :: uint [RW] | Maximum number of follower robots. |
ghost_time_to_live :: uint [RW] | The time, in ticks, before a placed ghost disappears. |
players :: array of LuaPlayer [R] | Players belonging to this force. |
ai_controllable :: boolean [RW] | Enables some higher-level AI behaviour for this force. |
logistic_networks :: dictionary string → array of LuaLogisticNetwork [R] | List of logistic networks, grouped by surface. |
kill_counts :: dictionary string → uint [R] | For each entity, the number of kills of that entity achieved by this force. |
LuaForce
encapsulates data local to each "force" or "faction" of the game.
Default forces are player, enemy and neutral. Players and mods can create
additional forces (up to 64 total).
Count entities of given type.
Disable research for this force.
Enable research for this force.
Disable all recipes and technologies. Only recipes and technologies enabled explicitly will be useable from this point.
Load the original version of all recipes from the prototypes.
Unlock all recipes.
Unlock all technologies.
Research all technologies.
Load the original versions of technologies from prototypes. Preserves research state of technologies.
Reset everything. All technologies are set to not researched, all modifiers are set to default values.
Chart a portion of the map. The chart for the given area is refreshed; it creates chart for any parts of the given area that haven't been charted yet.
game.local_player.force.chart(game.local_player.surface,
{{x = -1024, y = -1024}, {x = 1024, y = 1024}})
Remove all charted area from the chart.
Force a rechart of the whole chart.
Chart all generated chunks.
Has a chunk been charted?
{0, 0}
and {1, 0}
are one whole chunk away from each other.Will this force attack members of another force?
Is pathfinder busy? When the pathfinder is busy, it won't accept any more pathfinding requests.
Kill all units and flush the pathfinder.
nil
.How many entities of a given type were killed by this force.
Name of the force.
player
"
game.local_player.print(game.local_player.force.name)
Technologies owned by this force, indexed by their name.
game.local_player.force.technologies["iron-working"].researched = true
Recipes available to this force, indexed by their name.
game.local_player.print(game.local_player.force.recipes["basic-transport-belt"].category)
Multiplier of the manual mining speed. Default value is 0
.
The actual mining speed will be multiplied by 1 + manual_mining_speed_modifier
.
game.local_player.force.manual_mining_speed_modifier = 1
Multiplier of the manual crafting speed. Default value is 0
.
The actual crafting speed will be multiplied by 1 + manual_crafting_speed_modifier
.
game.local_player.force.manual_crafting_speed_modifier = 1
The current research in progress. Reading this attribute gives a LuaTechnology of the
current technology in research, or nil
if no research is currently ongoing. Writing this
attribute expects a string specifying a technology name; writing will start a research
of the specified technology.
Progress of current research, as a number in range [0, 1].
Number of extra items that can be transferred (so 1 + inserter_stack_size_bonus
is transfer
stack size)
Number of character logistic slots.
Number of character trash slots.
Number of character quick bars.
Maximum number of follower robots.
The time, in ticks, before a placed ghost disappears.
Players belonging to this force.
Enables some higher-level AI behaviour for this force. When set to true
, biters belonging to
this force will automatically expand into new territories, build new spawners, and form unit
groups. By default, this value is true
for the enemy force and false
for all others.
false
does not turn off biters' AI. They will still move around and attack
players who come close.List of logistic networks, grouped by surface.