Prototype of an entity.
has_flag(flag) | → boolean |
Test whether this entity prototype has a certain flag set. |
Test whether this entity prototype has a certain flag set. |
||
get_inventory_size(index) | → uint? |
Gets the base size of the given inventory on this entity or |
Gets the base size of the given inventory on this entity or |
||
help() | → string |
All methods and properties that this object supports. |
All methods and properties that this object supports. |
||
type [R] | :: string |
Type of this prototype. |
Type of this prototype. |
||
name [R] | :: string |
Name of this prototype. |
Name of this prototype. |
||
localised_name [R] | :: LocalisedString |
|
localised_description [R] | :: LocalisedString |
|
max_health [R] | :: float |
Max health of this entity. |
Max health of this entity. |
||
infinite_resource [R] | :: boolean? |
Whether this resource is infinite. |
Whether this resource is infinite. |
||
minimum_resource_amount [R] | :: uint? |
Minimum amount of this resource. |
Minimum amount of this resource. |
||
normal_resource_amount [R] | :: uint? |
The normal amount for this resource. |
The normal amount for this resource. |
||
infinite_depletion_resource_amount [R] | :: uint? |
Every time this infinite resource 'ticks' down, it is reduced by this amount. |
Every time this infinite resource 'ticks' down, it is reduced by this amount. |
||
resource_category [R] | :: string? |
Name of the category of this resource. |
Name of the category of this resource. |
||
mineable_properties [R] | :: table |
Whether this entity is minable and what can be obtained by mining it. |
Whether this entity is minable and what can be obtained by mining it. |
||
items_to_place_this [R] | :: array[ItemStackDefinition]? |
Items that when placed will produce this entity, if any. |
Items that when placed will produce this entity, if any. |
||
collision_box [R] | :: BoundingBox |
The bounding box used for collision checking. |
The bounding box used for collision checking. |
||
secondary_collision_box [R] | :: BoundingBox? |
The secondary bounding box used for collision checking, if any. |
The secondary bounding box used for collision checking, if any. |
||
map_generator_bounding_box [R] | :: BoundingBox |
The bounding box used for map generator collision checking. |
The bounding box used for map generator collision checking. |
||
selection_box [R] | :: BoundingBox |
The bounding box used for drawing selection. |
The bounding box used for drawing selection. |
||
drawing_box [R] | :: BoundingBox |
The bounding box used for drawing the entity icon. |
The bounding box used for drawing the entity icon. |
||
sticker_box [R] | :: BoundingBox |
The bounding box used to attach sticker type entities. |
The bounding box used to attach sticker type entities. |
||
collision_mask [R] | :: CollisionMask |
The collision masks this entity uses |
The collision masks this entity uses |
||
collision_mask_with_flags [R] | :: CollisionMaskWithFlags |
|
default_collision_mask_with_flags [R] | :: CollisionMaskWithFlags |
The hardcoded default collision mask (with flags) for this entity prototype type. |
The hardcoded default collision mask (with flags) for this entity prototype type. |
||
order [R] | :: string |
The string used to alphabetically sort these prototypes. |
The string used to alphabetically sort these prototypes. |
||
group [R] | :: LuaGroup |
Group of this entity. |
Group of this entity. |
||
subgroup [R] | :: LuaGroup |
Subgroup of this entity. |
Subgroup of this entity. |
||
healing_per_tick [R] | :: float? |
Amount this entity can heal per tick, if any. |
Amount this entity can heal per tick, if any. |
||
emissions_per_second [R] | :: double |
Amount of pollution emissions per second this entity will create. |
Amount of pollution emissions per second this entity will create. |
||
corpses [R] | :: dictionary[string → LuaEntityPrototype]? |
Corpses used when this entity is destroyed. |
Corpses used when this entity is destroyed. |
||
selectable_in_game [R] | :: boolean |
Is this entity selectable? |
Is this entity selectable? |
||
selection_priority [R] | :: uint |
The selection priority of this entity - a value between 0 and 255 |
The selection priority of this entity - a value between 0 and 255 |
||
weight [R] | :: double? |
The weight of this vehicle prototype. |
The weight of this vehicle prototype. |
||
resistances [R] | :: dictionary[string → Resistance]? |
List of resistances towards each damage type. |
List of resistances towards each damage type. |
||
fast_replaceable_group [R] | :: string? |
The group of mutually fast-replaceable entities, if any. |
The group of mutually fast-replaceable entities, if any. |
||
next_upgrade [R] | :: LuaEntityPrototype? |
The next upgrade for this entity, if any. |
The next upgrade for this entity, if any. |
||
loot [R] | :: array[Loot]? |
Loot that will be dropped when this entity is killed, if any. |
Loot that will be dropped when this entity is killed, if any. |
||
repair_speed_modifier [R] | :: uint? |
Repair-speed modifier for this entity, if any. |
Repair-speed modifier for this entity, if any. |
||
turret_range [R] | :: uint? |
The range of this turret. |
The range of this turret. |
||
autoplace_specification [R] | :: AutoplaceSpecification? |
Autoplace specification for this entity prototype, if any. |
Autoplace specification for this entity prototype, if any. |
||
belt_speed [R] | :: double? |
The speed of this transport belt. |
The speed of this transport belt. |
||
result_units [R] | :: array[UnitSpawnDefinition]? |
The result units and spawn points with weight and evolution factor for a biter spawner entity. |
The result units and spawn points with weight and evolution factor for a biter spawner entity. |
||
attack_result [R] | :: array[TriggerItem]? |
The attack result of this entity, if any. |
The attack result of this entity, if any. |
||
final_attack_result [R] | :: array[TriggerItem]? |
The final attack result for this projectile. |
The final attack result for this projectile. |
||
attack_parameters [R] | :: AttackParameters? |
The attack parameters for this entity, if any. |
The attack parameters for this entity, if any. |
||
spawn_cooldown [R] | :: table? |
The spawning cooldown for this enemy spawner prototype. |
The spawning cooldown for this enemy spawner prototype. |
||
mining_drill_radius [R] | :: double? |
The mining radius of this mining drill prototype. |
The mining radius of this mining drill prototype. |
||
mining_speed [R] | :: double? |
The mining speed of this mining drill/character prototype. |
The mining speed of this mining drill/character prototype. |
||
logistic_mode [R] | :: string? |
The logistic mode of this logistic container. |
The logistic mode of this logistic container. |
||
max_underground_distance [R] | :: uint8? |
The max underground distance for underground belts and underground pipes. |
The max underground distance for underground belts and underground pipes. |
||
flags [R] | :: EntityPrototypeFlags |
The flags for this entity prototype. |
The flags for this entity prototype. |
||
remains_when_mined [R] | :: array[LuaEntityPrototype] |
The remains left behind when this entity is mined. |
The remains left behind when this entity is mined. |
||
additional_pastable_entities [R] | :: array[LuaEntityPrototype] |
Entities this entity can be pasted onto in addition to the normal allowed ones. |
Entities this entity can be pasted onto in addition to the normal allowed ones. |
||
allow_copy_paste [R] | :: boolean |
When false copy-paste is not allowed for this entity. |
When false copy-paste is not allowed for this entity. |
||
shooting_cursor_size [R] | :: double |
The cursor size used when shooting at this entity. |
The cursor size used when shooting at this entity. |
||
created_smoke [R] | :: table? |
The smoke trigger run when this entity is built, if any. |
The smoke trigger run when this entity is built, if any. |
||
created_effect [R] | :: array[TriggerItem]? |
The trigger to run when this entity is created, if any. |
The trigger to run when this entity is created, if any. |
||
map_color [R] | :: Color? |
The map color used when charting this entity if a friendly or enemy color isn't defined, if any. |
The map color used when charting this entity if a friendly or enemy color isn't defined, if any. |
||
friendly_map_color [R] | :: Color |
The friendly map color used when charting this entity. |
The friendly map color used when charting this entity. |
||
enemy_map_color [R] | :: Color |
The enemy map color used when charting this entity. |
The enemy map color used when charting this entity. |
||
build_base_evolution_requirement [R] | :: double |
The evolution requirement to build this entity as a base when expanding enemy bases. |
The evolution requirement to build this entity as a base when expanding enemy bases. |
||
instruments [R] | :: array[ProgrammableSpeakerInstrument]? |
The instruments for this programmable speaker. |
The instruments for this programmable speaker. |
||
max_polyphony [R] | :: uint? |
The maximum polyphony for this programmable speaker. |
The maximum polyphony for this programmable speaker. |
||
module_inventory_size [R] | :: uint? |
The module inventory size. |
The module inventory size. |
||
ingredient_count [R] | :: uint? |
The max number of ingredients this crafting machine prototype supports. |
The max number of ingredients this crafting machine prototype supports. |
||
crafting_speed [R] | :: double? |
The crafting speed.. |
The crafting speed.. |
||
crafting_categories [R] | :: dictionary[string → boolean]? |
The crafting categories this entity prototype supports. |
The crafting categories this entity prototype supports. |
||
resource_categories [R] | :: dictionary[string → boolean]? |
The resource categories this character or mining drill supports. |
The resource categories this character or mining drill supports. |
||
supply_area_distance [R] | :: double? |
The supply area of this electric pole or beacon prototype. |
The supply area of this electric pole or beacon prototype. |
||
max_wire_distance [R] | :: double |
The maximum wire distance for this entity. |
The maximum wire distance for this entity. |
||
max_circuit_wire_distance [R] | :: double |
The maximum circuit wire distance for this entity. |
The maximum circuit wire distance for this entity. |
||
energy_usage [R] | :: double? |
The direct energy usage of this entity, if any. |
The direct energy usage of this entity, if any. |
||
max_energy_usage [R] | :: double |
The theoretical maximum energy usage for this entity. |
The theoretical maximum energy usage for this entity. |
||
max_energy_production [R] | :: double |
The theoretical maximum energy production for this this entity. |
The theoretical maximum energy production for this this entity. |
||
effectivity [R] | :: double? |
The effectivity of this car prototype, generator prototype. |
The effectivity of this car prototype, generator prototype. |
||
consumption [R] | :: double? |
The energy consumption of this car prototype. |
The energy consumption of this car prototype. |
||
friction_force [R] | :: double? |
The friction of this vehicle prototype. |
The friction of this vehicle prototype. |
||
braking_force [R] | :: double? |
The braking force of this vehicle prototype. |
The braking force of this vehicle prototype. |
||
air_resistance [R] | :: double? |
The air resistance of this rolling stock prototype. |
The air resistance of this rolling stock prototype. |
||
tank_driving [R] | :: boolean? |
If this car prototype uses tank controls to drive. |
If this car prototype uses tank controls to drive. |
||
rotation_speed [R] | :: double? |
The rotation speed of this car prototype. |
The rotation speed of this car prototype. |
||
turret_rotation_speed [R] | :: double? |
The turret rotation speed of this car prototype. |
The turret rotation speed of this car prototype. |
||
guns [R] | :: dictionary[string → LuaItemPrototype]? |
A mapping of the gun name to the gun prototype this prototype uses. |
A mapping of the gun name to the gun prototype this prototype uses. |
||
indexed_guns [R] | :: array[LuaItemPrototype]? |
A vector of the gun prototypes of this car, spider vehicle, artillery wagon, or turret. |
A vector of the gun prototypes of this car, spider vehicle, artillery wagon, or turret. |
||
speed [R] | :: double? |
The default speed of this flying robot, rolling stock or unit. |
The default speed of this flying robot, rolling stock or unit. |
||
speed_multiplier_when_out_of_energy [R] | :: float? |
The speed multiplier when this flying robot is out of energy. |
The speed multiplier when this flying robot is out of energy. |
||
max_payload_size [R] | :: uint? |
The max payload size of this logistics or construction robot. |
The max payload size of this logistics or construction robot. |
||
draw_cargo [R] | :: boolean? |
Whether this logistics or construction robot renders its cargo when flying. |
Whether this logistics or construction robot renders its cargo when flying. |
||
energy_per_move [R] | :: double? |
The energy consumed per tile moved for this flying robot. |
The energy consumed per tile moved for this flying robot. |
||
energy_per_tick [R] | :: double? |
The energy consumed per tick for this flying robot. |
The energy consumed per tick for this flying robot. |
||
max_energy [R] | :: double? |
The max energy for this flying robot. |
The max energy for this flying robot. |
||
min_to_charge [R] | :: float? |
The minimum energy for this flying robot before it tries to recharge. |
The minimum energy for this flying robot before it tries to recharge. |
||
max_to_charge [R] | :: float? |
The maximum energy for this flying robot above which it won't try to recharge when stationing. |
The maximum energy for this flying robot above which it won't try to recharge when stationing. |
||
burner_prototype [R] | :: LuaBurnerPrototype? |
The burner energy source prototype this entity uses, if any. |
The burner energy source prototype this entity uses, if any. |
||
electric_energy_source_prototype [R] | :: LuaElectricEnergySourcePrototype? |
The electric energy source prototype this entity uses, if any. |
The electric energy source prototype this entity uses, if any. |
||
heat_energy_source_prototype [R] | :: LuaHeatEnergySourcePrototype? |
The heat energy source prototype this entity uses, if any. |
The heat energy source prototype this entity uses, if any. |
||
fluid_energy_source_prototype [R] | :: LuaFluidEnergySourcePrototype? |
The fluid energy source prototype this entity uses, if any. |
The fluid energy source prototype this entity uses, if any. |
||
void_energy_source_prototype [R] | :: LuaVoidEnergySourcePrototype? |
The void energy source prototype this entity uses, if any. |
The void energy source prototype this entity uses, if any. |
||
heat_buffer_prototype [R] | :: LuaHeatBufferPrototype? |
The heat buffer prototype this entity uses, if any. |
The heat buffer prototype this entity uses, if any. |
||
building_grid_bit_shift [R] | :: uint |
The log2 of grid size of the building |
The log2 of grid size of the building |
||
fluid_usage_per_tick [R] | :: double? |
The fluid usage of this generator prototype. |
The fluid usage of this generator prototype. |
||
maximum_temperature [R] | :: double? |
The maximum fluid temperature of this generator prototype. |
The maximum fluid temperature of this generator prototype. |
||
burns_fluid [R] | :: boolean? |
Whether this generator prototype burns fluid. |
Whether this generator prototype burns fluid. |
||
scale_fluid_usage [R] | :: boolean? |
Whether this generator prototype scales fluid usage. |
Whether this generator prototype scales fluid usage. |
||
destroy_non_fuel_fluid [R] | :: boolean? |
Whether this generator prototype destroys non-fuel fluids. |
Whether this generator prototype destroys non-fuel fluids. |
||
max_power_output [R] | :: double? |
The default maximum power output of this generator prototype. |
The default maximum power output of this generator prototype. |
||
target_temperature [R] | :: double? |
The target temperature of this boiler prototype. |
The target temperature of this boiler prototype. |
||
fluid [R] | :: LuaFluidPrototype? |
The fluid this offshore pump produces. |
The fluid this offshore pump produces. |
||
fluid_capacity [R] | :: double |
The fluid capacity of this entity or 0 if this entity doesn't support fluids. |
The fluid capacity of this entity or 0 if this entity doesn't support fluids. |
||
pumping_speed [R] | :: double? |
The pumping speed of this offshore or normal pump. |
The pumping speed of this offshore or normal pump. |
||
stack [R] | :: boolean? |
Whether this inserter is a stack-type. |
Whether this inserter is a stack-type. |
||
allow_custom_vectors [R] | :: boolean? |
Whether this inserter allows custom pickup and drop vectors. |
Whether this inserter allows custom pickup and drop vectors. |
||
allow_burner_leech [R] | :: boolean? |
Whether this inserter allows burner leeching. |
Whether this inserter allows burner leeching. |
||
inserter_extension_speed [R] | :: double? |
The extension speed of this inserter. |
The extension speed of this inserter. |
||
inserter_rotation_speed [R] | :: double? |
The rotation speed of this inserter. |
The rotation speed of this inserter. |
||
inserter_pickup_position [R] | :: Vector? |
The pickup position for this inserter. |
The pickup position for this inserter. |
||
inserter_drop_position [R] | :: Vector? |
The drop position for this inserter. |
The drop position for this inserter. |
||
inserter_chases_belt_items [R] | :: boolean? |
True if this inserter chases items on belts for pickup. |
True if this inserter chases items on belts for pickup. |
||
count_as_rock_for_filtered_deconstruction [R] | :: boolean? |
If this simple-entity is counted as a rock for the deconstruction planner "trees and rocks only" filter. |
If this simple-entity is counted as a rock for the deconstruction planner "trees and rocks only" filter. |
||
filter_count [R] | :: uint? |
The filter count of this inserter, loader, or logistic chest. |
The filter count of this inserter, loader, or logistic chest. |
||
time_to_live [R] | :: uint |
The time to live for this prototype or |
The time to live for this prototype or |
||
distribution_effectivity [R] | :: double? |
The distribution effectivity for this beacon prototype. |
The distribution effectivity for this beacon prototype. |
||
explosion_beam [R] | :: double? |
Whether this explosion has a beam. |
Whether this explosion has a beam. |
||
explosion_rotate [R] | :: double? |
Whether this explosion rotates. |
Whether this explosion rotates. |
||
tree_color_count [R] | :: uint8? |
If it is a tree, return the number of colors it supports. |
If it is a tree, return the number of colors it supports. |
||
alert_when_damaged [R] | :: boolean? |
Whether this entity raises an alert when damaged. |
Whether this entity raises an alert when damaged. |
||
alert_when_attacking [R] | :: boolean? |
Whether this turret raises an alert when attacking |
Whether this turret raises an alert when attacking |
||
color [R] | :: Color? |
The color of the prototype, if any. |
The color of the prototype, if any. |
||
collision_mask_collides_with_self [R] | :: boolean |
Does this prototype collision mask collide with itself? |
Does this prototype collision mask collide with itself? |
||
collision_mask_collides_with_tiles_only [R] | :: boolean |
Does this prototype collision mask collide with tiles only? |
Does this prototype collision mask collide with tiles only? |
||
collision_mask_considers_tile_transitions [R] | :: boolean |
Does this prototype collision mask consider tile transitions? |
Does this prototype collision mask consider tile transitions? |
||
allowed_effects [R] | :: dictionary[string → boolean]? |
The allowed module effects for this entity, if any. |
The allowed module effects for this entity, if any. |
||
rocket_parts_required [R] | :: uint? |
The rocket parts required for this rocket silo prototype. |
The rocket parts required for this rocket silo prototype. |
||
rocket_rising_delay [R] | :: uint8? |
The rocket rising delay for this rocket silo prototype. |
The rocket rising delay for this rocket silo prototype. |
||
launch_wait_time [R] | :: uint8? |
The rocket launch delay for this rocket silo prototype. |
The rocket launch delay for this rocket silo prototype. |
||
light_blinking_speed [R] | :: double? |
The light blinking speed for this rocket silo prototype. |
The light blinking speed for this rocket silo prototype. |
||
door_opening_speed [R] | :: double? |
The door opening speed for this rocket silo prototype. |
The door opening speed for this rocket silo prototype. |
||
rising_speed [R] | :: double? |
The rising speed for this rocket silo rocket prototype. |
The rising speed for this rocket silo rocket prototype. |
||
engine_starting_speed [R] | :: double? |
The engine starting speed for this rocket silo rocket prototype. |
The engine starting speed for this rocket silo rocket prototype. |
||
flying_speed [R] | :: double? |
The flying speed for this rocket silo rocket prototype. |
The flying speed for this rocket silo rocket prototype. |
||
flying_acceleration [R] | :: double? |
The flying acceleration for this rocket silo rocket prototype. |
The flying acceleration for this rocket silo rocket prototype. |
||
fixed_recipe [R] | :: string? |
The fixed recipe name for this assembling machine prototype, if any. |
The fixed recipe name for this assembling machine prototype, if any. |
||
construction_radius [R] | :: double? |
The construction radius for this roboport prototype. |
The construction radius for this roboport prototype. |
||
logistic_radius [R] | :: double? |
The logistic radius for this roboport prototype. |
The logistic radius for this roboport prototype. |
||
energy_per_hit_point [R] | :: double? |
The energy used per hitpoint taken for this vehicle during collisions. |
The energy used per hitpoint taken for this vehicle during collisions. |
||
create_ghost_on_death [R] | :: boolean |
If this prototype will attempt to create a ghost of itself on death. |
If this prototype will attempt to create a ghost of itself on death. |
||
ammo_category [R] | :: string? |
Name of the ammo category of this land mine. |
Name of the ammo category of this land mine. |
||
timeout [R] | :: uint? |
The time it takes this land mine to arm. |
The time it takes this land mine to arm. |
||
trigger_collision_mask [R] | :: CollisionMaskWithFlags? |
The collision mask entities must collide with to make this landmine blow up. |
The collision mask entities must collide with to make this landmine blow up. |
||
fluidbox_prototypes [R] | :: array[LuaFluidBoxPrototype] |
The fluidbox prototypes for this entity. |
The fluidbox prototypes for this entity. |
||
neighbour_bonus [R] | :: double? |
|
container_distance [R] | :: double? |
|
belt_distance [R] | :: double? |
|
belt_length [R] | :: double? |
|
is_building [R] | :: boolean |
Everything in the following list is considered a building. |
Everything in the following list is considered a building. |
||
automated_ammo_count [R] | :: uint? |
The amount of ammo that inserters automatically insert into this ammo-turret or artillery-turret. |
The amount of ammo that inserters automatically insert into this ammo-turret or artillery-turret. |
||
max_speed [R] | :: double? |
The max speed of this projectile or flying robot prototype. |
The max speed of this projectile or flying robot prototype. |
||
darkness_for_all_lamps_on [R] | :: float? |
Value between 0 and 1 darkness where all lamps of this lamp prototype are on. |
Value between 0 and 1 darkness where all lamps of this lamp prototype are on. |
||
darkness_for_all_lamps_off [R] | :: float? |
Value between 0 and 1 darkness where all lamps of this lamp prototype are off. |
Value between 0 and 1 darkness where all lamps of this lamp prototype are off. |
||
always_on [R] | :: boolean? |
Whether the lamp is always on (except when out of power or turned off by the circuit network). |
Whether the lamp is always on (except when out of power or turned off by the circuit network). |
||
min_darkness_to_spawn [R] | :: float? |
The minimum darkness at which this unit spawner can spawn entities. |
The minimum darkness at which this unit spawner can spawn entities. |
||
max_darkness_to_spawn [R] | :: float? |
The maximum darkness at which this unit spawner can spawn entities. |
The maximum darkness at which this unit spawner can spawn entities. |
||
call_for_help_radius [R] | :: double? |
|
max_count_of_owned_units [R] | :: double? |
Count of enemies this spawner can sustain. |
Count of enemies this spawner can sustain. |
||
max_friends_around_to_spawn [R] | :: double? |
How many friendly units are required within the spawning_radius of this spawner for it to stop producing more units. |
How many friendly units are required within the spawning_radius of this spawner for it to stop producing more units. |
||
spawning_radius [R] | :: double? |
How far from the spawner can the units be spawned. |
How far from the spawner can the units be spawned. |
||
spawning_spacing [R] | :: double? |
What spaces should be between the spawned units. |
What spaces should be between the spawned units. |
||
radius [R] | :: double |
The radius of this entity prototype. |
The radius of this entity prototype. |
||
cliff_explosive_prototype [R] | :: string? |
The item prototype name used to destroy this cliff. |
The item prototype name used to destroy this cliff. |
||
rocket_entity_prototype [R] | :: LuaEntityPrototype? |
The rocket entity prototype associated with this rocket silo prototype. |
The rocket entity prototype associated with this rocket silo prototype. |
||
has_belt_immunity [R] | :: boolean? |
Whether this unit, car, or character prototype has belt immunity. |
Whether this unit, car, or character prototype has belt immunity. |
||
vision_distance [R] | :: double? |
The vision distance of this unit prototype. |
The vision distance of this unit prototype. |
||
pollution_to_join_attack [R] | :: float? |
The amount of pollution that has to be absorbed by the unit's spawner before the unit will leave the spawner and attack the source of the pollution. |
The amount of pollution that has to be absorbed by the unit's spawner before the unit will leave the spawner and attack the source of the pollution. |
||
min_pursue_time [R] | :: uint? |
The minimum pursue time of this unit prototype. |
The minimum pursue time of this unit prototype. |
||
max_pursue_distance [R] | :: double? |
The maximum pursue distance of this unit prototype. |
The maximum pursue distance of this unit prototype. |
||
radar_range [R] | :: uint? |
The radar range of this unit prototype. |
The radar range of this unit prototype. |
||
move_while_shooting [R] | :: boolean? |
Whether this unit prototype can move while shooting. |
Whether this unit prototype can move while shooting. |
||
can_open_gates [R] | :: boolean? |
Whether this unit prototype can open gates. |
Whether this unit prototype can open gates. |
||
affected_by_tiles [R] | :: boolean? |
Whether this unit prototype is affected by tile walking speed modifiers. |
Whether this unit prototype is affected by tile walking speed modifiers. |
||
distraction_cooldown [R] | :: uint? |
The distraction cooldown of this unit prototype. |
The distraction cooldown of this unit prototype. |
||
spawning_time_modifier [R] | :: double? |
The spawning time modifier of this unit prototype. |
The spawning time modifier of this unit prototype. |
||
alert_icon_shift [R] | :: Vector |
The alert icon shift of this entity prototype. |
The alert icon shift of this entity prototype. |
||
alert_icon_scale [R] | :: float |
The alert icon scale of this entity prototype. |
The alert icon scale of this entity prototype. |
||
lab_inputs [R] | :: array[string]? |
The item prototype names that are the inputs of this lab prototype. |
The item prototype names that are the inputs of this lab prototype. |
||
researching_speed [R] | :: double? |
The base researching speed of this lab prototype. |
The base researching speed of this lab prototype. |
||
item_slot_count [R] | :: uint? |
The item slot count of this constant combinator prototype. |
The item slot count of this constant combinator prototype. |
||
base_productivity [R] | :: double? |
The base productivity of this crafting machine, lab, or mining drill. |
The base productivity of this crafting machine, lab, or mining drill. |
||
allow_access_to_all_forces [R] | :: boolean? |
Whether this market allows access to all forces or just friendly ones. |
Whether this market allows access to all forces or just friendly ones. |
||
supports_direction [R] | :: boolean |
Whether this entity prototype could possibly ever be rotated. |
Whether this entity prototype could possibly ever be rotated. |
||
terrain_friction_modifier [R] | :: float? |
The terrain friction modifier for this vehicle. |
The terrain friction modifier for this vehicle. |
||
allow_passengers [R] | :: boolean? |
Whether this vehicle allows passengers. |
Whether this vehicle allows passengers. |
||
max_distance_of_sector_revealed [R] | :: uint? |
The radius of the area this radar can chart, in chunks. |
The radius of the area this radar can chart, in chunks. |
||
max_distance_of_nearby_sector_revealed [R] | :: uint? |
The radius of the area constantly revealed by this radar, in chunks. |
The radius of the area constantly revealed by this radar, in chunks. |
||
adjacent_tile_collision_box [R] | :: BoundingBox? |
The bounding box that specifies which tiles adjacent to the offshore pump should be checked. |
The bounding box that specifies which tiles adjacent to the offshore pump should be checked. |
||
adjacent_tile_collision_mask [R] | :: CollisionMask? |
Tiles adjacent to the offshore pump must not collide with this collision mask. |
Tiles adjacent to the offshore pump must not collide with this collision mask. |
||
adjacent_tile_collision_test [R] | :: CollisionMask? |
If this mask is not empty, tiles adjacent to the offshore pump must not collide with this collision mask. |
If this mask is not empty, tiles adjacent to the offshore pump must not collide with this collision mask. |
||
center_collision_mask [R] | :: CollisionMask? |
The collision mask used only for collision test with tile directly at offshore pump position. |
The collision mask used only for collision test with tile directly at offshore pump position. |
||
grid_prototype [R] | :: LuaEquipmentGridPrototype? |
The equipment grid prototype for this entity, if any. |
The equipment grid prototype for this entity, if any. |
||
remove_decoratives [R] | :: string |
|
related_underground_belt [R] | :: LuaEntityPrototype? |
|
inserter_stack_size_bonus [R] | :: double? |
The built-in stack size bonus of this inserter prototype. |
The built-in stack size bonus of this inserter prototype. |
||
protected_from_tile_building [R] | :: boolean |
True if this entity prototype should be included during tile collision checks with LuaTilePrototype::check_collision_with_entities enabled. |
True if this entity prototype should be included during tile collision checks with LuaTilePrototype::check_collision_with_entities enabled. |
||
is_entity_with_owner [R] | :: boolean |
True if this is entity-with-owner |
True if this is entity-with-owner |
||
is_military_target [R] | :: boolean? |
True if this entity-with-owner is military target |
True if this entity-with-owner is military target |
||
allow_run_time_change_of_is_military_target [R] | :: boolean? |
True if this entity-with-owner's is_military_target can be changed run-time (on the entity, not on the prototype itself) |
True if this entity-with-owner's is_military_target can be changed run-time (on the entity, not on the prototype itself) |
||
logistic_parameters [R] | :: table? |
The logistic parameters for this roboport. |
The logistic parameters for this roboport. |
||
height [R] | :: double? |
The height of this spider vehicle prototype. |
The height of this spider vehicle prototype. |
||
torso_rotation_speed [R] | :: double? |
The torso rotation speed of this spider vehicle prototype. |
The torso rotation speed of this spider vehicle prototype. |
||
torso_bob_speed [R] | :: double? |
The torso bob speed of this spider vehicle prototype. |
The torso bob speed of this spider vehicle prototype. |
||
automatic_weapon_cycling [R] | :: boolean? |
Whether this spider vehicle prototype automatically cycles weapons. |
Whether this spider vehicle prototype automatically cycles weapons. |
||
chain_shooting_cooldown_modifier [R] | :: double? |
The chain shooting cooldown modifier of this spider vehicle prototype. |
The chain shooting cooldown modifier of this spider vehicle prototype. |
||
chunk_exploration_radius [R] | :: double? |
The chunk exploration radius of this spider vehicle prototype. |
The chunk exploration radius of this spider vehicle prototype. |
||
animation_speed_coefficient [R] | :: double? |
The animation speed coefficient of this belt connectable prototype. |
The animation speed coefficient of this belt connectable prototype. |
||
manual_range_modifier [R] | :: double? |
The manual range modifier for this artillery turret or wagon prototype. |
The manual range modifier for this artillery turret or wagon prototype. |
||
dying_speed [R] | :: float? |
The dying time of this corpse prototype. |
The dying time of this corpse prototype. |
||
active_energy_usage [R] | :: double? |
The active energy usage of this rocket silo or combinator prototype. |
The active energy usage of this rocket silo or combinator prototype. |
||
idle_energy_usage [R] | :: double? |
The idle energy usage of this rocket silo prototype. |
The idle energy usage of this rocket silo prototype. |
||
lamp_energy_usage [R] | :: double? |
The lamp energy usage of this rocket silo prototype. |
The lamp energy usage of this rocket silo prototype. |
||
use_exact_mode [R] | :: boolean? |
Whether this logistic container prototype uses exact mode |
Whether this logistic container prototype uses exact mode |
||
tile_width [R] | :: uint |
Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension) |
Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension) |
||
tile_height [R] | :: uint |
Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension) |
Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension) |
||
running_speed [R] | :: double? |
The current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting. |
The current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting. |
||
maximum_corner_sliding_distance [R] | :: double? |
|
build_distance [R] | :: uint? |
|
drop_item_distance [R] | :: uint? |
|
reach_distance [R] | :: uint? |
|
reach_resource_distance [R] | :: double? |
|
item_pickup_distance [R] | :: double? |
|
loot_pickup_distance [R] | :: double? |
|
enter_vehicle_distance [R] | :: double? |
|
ticks_to_keep_gun [R] | :: uint? |
|
ticks_to_keep_aiming_direction [R] | :: uint? |
|
ticks_to_stay_in_combat [R] | :: uint? |
|
respawn_time [R] | :: uint? |
|
damage_hit_tint [R] | :: Color? |
|
character_corpse [R] | :: LuaEntityPrototype? |
|
valid [R] | :: boolean |
Is this object valid? |
Is this object valid? |
||
object_name [R] | :: string |
The class name of this object. |
The class name of this object. |
Test whether this entity prototype has a certain flag set.
flag | :: string |
The flag to test. See EntityPrototypeFlags for a list of flags. |
The flag to test. See EntityPrototypeFlags for a list of flags. |
→ boolean |
|
Gets the base size of the given inventory on this entity or nil
if the given inventory doesn't exist.
index | :: defines.inventory |
|
All methods and properties that this object supports.
Type of this prototype.
Name of this prototype.
Max health of this entity. Will be 0
if this is not an entity with health.
Whether this resource is infinite.
Minimum amount of this resource.
The normal amount for this resource.
Every time this infinite resource 'ticks' down, it is reduced by this amount. Meaningless if this isn't an infinite resource.
Name of the category of this resource.
During data stage, this property is named "category".
Whether this entity is minable and what can be obtained by mining it.
minable | :: boolean |
Is this entity mineable at all? |
Is this entity mineable at all? |
||
mining_time | :: double |
Energy required to mine an entity. |
Energy required to mine an entity. |
||
mining_particle | :: string? |
Prototype name of the particle produced when mining this entity. Will only be present if this entity produces any particle during mining. |
Prototype name of the particle produced when mining this entity. Will only be present if this entity produces any particle during mining. |
||
products | :: array[Product]? |
Products obtained by mining this entity. |
Products obtained by mining this entity. |
||
fluid_amount | :: double? |
The required fluid amount if any. |
The required fluid amount if any. |
||
required_fluid | :: string? |
The prototype name of the required fluid if any. |
The prototype name of the required fluid if any. |
||
mining_trigger | :: array[TriggerItem]? |
The mining trigger if any. |
The mining trigger if any. |
Items that when placed will produce this entity, if any. Construction bots will choose the first item in the list to build this entity.
The bounding box used for collision checking.
The secondary bounding box used for collision checking, if any. This is only used in rails and rail remnants.
The bounding box used for map generator collision checking.
The bounding box used for drawing selection.
The bounding box used for drawing the entity icon.
The bounding box used to attach sticker type entities.
The collision masks this entity uses
The hardcoded default collision mask (with flags) for this entity prototype type.
The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
Group of this entity.
Subgroup of this entity.
Amount this entity can heal per tick, if any.
Amount of pollution emissions per second this entity will create.
Corpses used when this entity is destroyed. It is a dictionary indexed by the corpse's prototype name.
Is this entity selectable?
The selection priority of this entity - a value between 0 and 255
The weight of this vehicle prototype.
List of resistances towards each damage type. It is a dictionary indexed by damage type names (see data/base/prototypes/damage-type.lua
).
The group of mutually fast-replaceable entities, if any.
The next upgrade for this entity, if any.
Loot that will be dropped when this entity is killed, if any.
Repair-speed modifier for this entity, if any. Actual repair speed will be tool_repair_speed * entity_repair_speed_modifier
.
The range of this turret.
Autoplace specification for this entity prototype, if any.
The speed of this transport belt.
The result units and spawn points with weight and evolution factor for a biter spawner entity.
The attack result of this entity, if any.
The final attack result for this projectile.
The attack parameters for this entity, if any.
The mining radius of this mining drill prototype.
The mining speed of this mining drill/character prototype.
The logistic mode of this logistic container. One of "requester"
, "active-provider"
, "passive-provider"
, "buffer"
, "storage"
, "none"
.
The max underground distance for underground belts and underground pipes.
The flags for this entity prototype.
The remains left behind when this entity is mined.
Entities this entity can be pasted onto in addition to the normal allowed ones.
When false copy-paste is not allowed for this entity.
The cursor size used when shooting at this entity.
The smoke trigger run when this entity is built, if any.
smoke_name | :: string |
|
offsets | :: array[Vector] |
|
offset_deviation | :: BoundingBox |
|
initial_height | :: float |
|
max_radius | :: float? |
|
speed | :: Vector |
|
speed_multiplier | :: float |
|
speed_multiplier_deviation | :: float |
|
starting_frame | :: float |
|
starting_frame_deviation | :: float |
|
starting_frame_speed | :: float |
|
starting_frame_speed_deviation | :: float |
|
speed_from_center | :: float |
|
speed_from_center_deviation | :: float |
|
The trigger to run when this entity is created, if any.
The map color used when charting this entity if a friendly or enemy color isn't defined, if any.
The friendly map color used when charting this entity.
The enemy map color used when charting this entity.
The evolution requirement to build this entity as a base when expanding enemy bases.
The instruments for this programmable speaker.
The maximum polyphony for this programmable speaker.
The module inventory size. nil
if this entity doesn't support modules.
The max number of ingredients this crafting machine prototype supports.
The crafting speed..
The crafting categories this entity prototype supports.
The value in the dictionary is meaningless and exists just to allow for easy lookup.
The resource categories this character or mining drill supports.
The value in the dictionary is meaningless and exists just to allow for easy lookup.
The supply area of this electric pole or beacon prototype.
The maximum wire distance for this entity. 0 if the entity doesn't support wires.
The maximum circuit wire distance for this entity. 0 if the entity doesn't support circuit wires.
The direct energy usage of this entity, if any.
The theoretical maximum energy usage for this entity.
The theoretical maximum energy production for this this entity.
The effectivity of this car prototype, generator prototype.
The energy consumption of this car prototype.
The friction of this vehicle prototype.
The braking force of this vehicle prototype.
The air resistance of this rolling stock prototype.
If this car prototype uses tank controls to drive.
The rotation speed of this car prototype.
The turret rotation speed of this car prototype.
A mapping of the gun name to the gun prototype this prototype uses. nil
if this entity prototype doesn't use guns.
A vector of the gun prototypes of this car, spider vehicle, artillery wagon, or turret.
The default speed of this flying robot, rolling stock or unit. For rolling stocks, this is their max_speed
.
The speed multiplier when this flying robot is out of energy.
The max payload size of this logistics or construction robot.
Whether this logistics or construction robot renders its cargo when flying.
The energy consumed per tile moved for this flying robot.
The energy consumed per tick for this flying robot.
The max energy for this flying robot.
The minimum energy for this flying robot before it tries to recharge.
The maximum energy for this flying robot above which it won't try to recharge when stationing.
The burner energy source prototype this entity uses, if any.
The electric energy source prototype this entity uses, if any.
The heat energy source prototype this entity uses, if any.
The fluid energy source prototype this entity uses, if any.
The void energy source prototype this entity uses, if any.
The heat buffer prototype this entity uses, if any.
The log2 of grid size of the building
The fluid usage of this generator prototype.
The maximum fluid temperature of this generator prototype.
Whether this generator prototype burns fluid.
Whether this generator prototype scales fluid usage.
Whether this generator prototype destroys non-fuel fluids.
The default maximum power output of this generator prototype.
The target temperature of this boiler prototype.
The fluid this offshore pump produces.
The fluid capacity of this entity or 0 if this entity doesn't support fluids.
Crafting machines will report 0 due to their fluid capacity being whatever a given recipe needs.
The pumping speed of this offshore or normal pump.
Whether this inserter is a stack-type.
Whether this inserter allows custom pickup and drop vectors.
Whether this inserter allows burner leeching.
The extension speed of this inserter.
The rotation speed of this inserter.
The pickup position for this inserter.
The drop position for this inserter.
True if this inserter chases items on belts for pickup.
If this simple-entity is counted as a rock for the deconstruction planner "trees and rocks only" filter.
The filter count of this inserter, loader, or logistic chest. For logistic containers, nil
means no limit.
The time to live for this prototype or 0
if prototype doesn't have time_to_live or time_before_removed.
The distribution effectivity for this beacon prototype.
Whether this explosion has a beam.
Whether this explosion rotates.
If it is a tree, return the number of colors it supports.
Whether this entity raises an alert when damaged.
Whether this turret raises an alert when attacking
The color of the prototype, if any.
Does this prototype collision mask collide with itself?
Does this prototype collision mask collide with tiles only?
Does this prototype collision mask consider tile transitions?
The allowed module effects for this entity, if any.
The rocket parts required for this rocket silo prototype.
The rocket rising delay for this rocket silo prototype.
The rocket launch delay for this rocket silo prototype.
The light blinking speed for this rocket silo prototype.
The door opening speed for this rocket silo prototype.
The rising speed for this rocket silo rocket prototype.
The engine starting speed for this rocket silo rocket prototype.
The flying speed for this rocket silo rocket prototype.
The flying acceleration for this rocket silo rocket prototype.
The fixed recipe name for this assembling machine prototype, if any.
The construction radius for this roboport prototype.
The logistic radius for this roboport prototype.
The energy used per hitpoint taken for this vehicle during collisions.
If this prototype will attempt to create a ghost of itself on death.
If this is false then a ghost will never be made, if it's true a ghost may be made.
Name of the ammo category of this land mine.
The time it takes this land mine to arm.
The collision mask entities must collide with to make this landmine blow up.
The fluidbox prototypes for this entity.
Everything in the following list is considered a building.
The amount of ammo that inserters automatically insert into this ammo-turret or artillery-turret.
The max speed of this projectile or flying robot prototype.
Value between 0 and 1 darkness where all lamps of this lamp prototype are on.
Value between 0 and 1 darkness where all lamps of this lamp prototype are off.
Whether the lamp is always on (except when out of power or turned off by the circuit network).
The minimum darkness at which this unit spawner can spawn entities.
The maximum darkness at which this unit spawner can spawn entities.
Count of enemies this spawner can sustain.
How many friendly units are required within the spawning_radius of this spawner for it to stop producing more units.
How far from the spawner can the units be spawned.
What spaces should be between the spawned units.
The radius of this entity prototype.
The item prototype name used to destroy this cliff.
The rocket entity prototype associated with this rocket silo prototype.
Whether this unit, car, or character prototype has belt immunity.
The vision distance of this unit prototype.
The amount of pollution that has to be absorbed by the unit's spawner before the unit will leave the spawner and attack the source of the pollution.
The minimum pursue time of this unit prototype.
The maximum pursue distance of this unit prototype.
The radar range of this unit prototype.
Whether this unit prototype can move while shooting.
Whether this unit prototype can open gates.
Whether this unit prototype is affected by tile walking speed modifiers.
The distraction cooldown of this unit prototype.
The spawning time modifier of this unit prototype.
The alert icon shift of this entity prototype.
The alert icon scale of this entity prototype.
The item prototype names that are the inputs of this lab prototype.
The base researching speed of this lab prototype.
The item slot count of this constant combinator prototype.
The base productivity of this crafting machine, lab, or mining drill.
Whether this market allows access to all forces or just friendly ones.
Whether this entity prototype could possibly ever be rotated.
The terrain friction modifier for this vehicle.
Whether this vehicle allows passengers.
The radius of the area this radar can chart, in chunks.
The radius of the area constantly revealed by this radar, in chunks.
The bounding box that specifies which tiles adjacent to the offshore pump should be checked.
Tiles adjacent to the offshore pump must not collide with this collision mask.
If this mask is not empty, tiles adjacent to the offshore pump must not collide with this collision mask.
The collision mask used only for collision test with tile directly at offshore pump position.
The equipment grid prototype for this entity, if any.
The built-in stack size bonus of this inserter prototype.
True if this entity prototype should be included during tile collision checks with LuaTilePrototype::check_collision_with_entities enabled.
True if this is entity-with-owner
True if this entity-with-owner is military target
True if this entity-with-owner's is_military_target can be changed run-time (on the entity, not on the prototype itself)
The logistic parameters for this roboport.
spawn_and_station_height | :: float |
|
spawn_and_station_shadow_height_offset | :: float |
|
charge_approach_distance | :: float |
|
logistic_radius | :: float |
|
construction_radius | :: float |
|
charging_station_count | :: uint |
|
charging_distance | :: float |
|
charging_station_shift | :: Vector |
|
charging_energy | :: double |
|
charging_threshold_distance | :: float |
|
robot_vertical_acceleration | :: float |
|
stationing_offset | :: Vector |
|
robot_limit | :: uint |
|
logistics_connection_distance | :: float |
|
robots_shrink_when_entering_and_exiting | :: boolean |
|
Both the charging_station_shift
and stationing_offset
vectors are tables with x
and y
keys instead of an array.
The height of this spider vehicle prototype.
The torso rotation speed of this spider vehicle prototype.
The torso bob speed of this spider vehicle prototype.
Whether this spider vehicle prototype automatically cycles weapons.
The chain shooting cooldown modifier of this spider vehicle prototype.
The chunk exploration radius of this spider vehicle prototype.
The animation speed coefficient of this belt connectable prototype.
The manual range modifier for this artillery turret or wagon prototype.
subclass(ArtilleryWagon, ArtilleryTurret)
The dying time of this corpse prototype.
The active energy usage of this rocket silo or combinator prototype.
The idle energy usage of this rocket silo prototype.
The lamp energy usage of this rocket silo prototype.
Whether this logistic container prototype uses exact mode
Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension)
Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension)
The current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
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.
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.