Factorio Prototype DocsVersion 1.1.107

FireFlamePrototype - 'fire'

A fire.

Inherits from EntityPrototype « PrototypeBase

Properties

damage_per_tick :: DamagePrototype
spread_delay :: uint32
spread_delay_deviation :: uint32
render_layer optional :: RenderLayer
initial_render_layer optional :: RenderLayer
secondary_render_layer optional :: RenderLayer
small_tree_fire_pictures optional :: AnimationVariations
pictures optional :: AnimationVariations
smoke_source_pictures optional :: AnimationVariations
secondary_pictures optional :: AnimationVariations
burnt_patch_pictures optional :: SpriteVariations
secondary_picture_fade_out_start optional :: uint32
secondary_picture_fade_out_duration optional :: uint32
spawn_entity optional :: EntityID
smoke optional :: array[SmokeSource]
maximum_spread_count optional :: uint16
initial_flame_count optional :: uint8

Spawns this many secondary_pictures around the entity when it first spawns. [...]

Spawns this many secondary_pictures around the entity when it first spawns. [...]

uses_alternative_behavior optional :: bool

If false, then all animations loop. [...]

If false, then all animations loop. [...]

limit_overlapping_particles optional :: bool
tree_dying_factor optional :: float
fade_in_duration optional :: uint32
fade_out_duration optional :: uint32
initial_lifetime optional :: uint32
damage_multiplier_decrease_per_tick optional :: float
damage_multiplier_increase_per_added_fuel optional :: float
maximum_damage_multiplier optional :: float
lifetime_increase_by optional :: uint32
lifetime_increase_cooldown optional :: uint32
maximum_lifetime optional :: uint32
add_fuel_cooldown optional :: uint32
delay_between_initial_flames optional :: uint32
smoke_fade_in_duration optional :: uint32
smoke_fade_out_duration optional :: uint32
on_fuel_added_action optional :: Trigger
on_damage_tick_effect optional :: Trigger
light optional :: LightDefinition
particle_alpha_blend_duration optional :: uint16
burnt_patch_lifetime optional :: uint32
burnt_patch_alpha_default optional :: float
particle_alpha optional :: float

Only loaded if uses_alternative_behavior is true.

Only loaded if uses_alternative_behavior is true.

particle_alpha_deviation optional :: float

Only loaded if uses_alternative_behavior is true.

Only loaded if uses_alternative_behavior is true.

flame_alpha optional :: float

Only loaded if uses_alternative_behavior is false.

Only loaded if uses_alternative_behavior is false.

flame_alpha_deviation optional :: float

Only loaded if uses_alternative_behavior is false.

Only loaded if uses_alternative_behavior is false.

burnt_patch_alpha_variations optional :: array[TileAndAlpha]

Inherited from EntityPrototype
icons optional :: array[IconData]

This will be used in the electric network statistics, editor building selection, and the bonus gui. [...]

This will be used in the electric network statistics, editor building selection, and the bonus gui. [...]

icon optional :: FileName

Path to the icon file. [...]

Path to the icon file. [...]

icon_size optional :: SpriteSizeType

The size of the square icon, in pixels. [...]

The size of the square icon, in pixels. [...]

icon_mipmaps optional :: IconMipMapType

Icons of reduced size will be used at decreased scale.

Icons of reduced size will be used at decreased scale.

collision_box optional :: BoundingBox

Specification of the entity collision boundaries. [...]

Specification of the entity collision boundaries. [...]

collision_mask[overridden] optional :: CollisionMask

Two entities can collide only if they share a layer from the collision mask.

Two entities can collide only if they share a layer from the collision mask.

map_generator_bounding_box optional :: BoundingBox

Used instead of the collision box during map generation. [...]

Used instead of the collision box during map generation. [...]

selection_box optional :: BoundingBox

Specification of the entity selection area. [...]

Specification of the entity selection area. [...]

drawing_box optional :: BoundingBox

Specification of space needed to see the whole entity in GUIs. [...]

Specification of space needed to see the whole entity in GUIs. [...]

sticker_box optional :: BoundingBox

Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.

Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.

hit_visualization_box optional :: BoundingBox

Where beams should hit the entity. [...]

Where beams should hit the entity. [...]

trigger_target_mask optional :: TriggerTargetMask
flags optional :: EntityPrototypeFlags
minable optional :: MinableProperties

The item given to the player when they mine the entity and other properties relevant to mining this entity.

The item given to the player when they mine the entity and other properties relevant to mining this entity.

subgroup optional :: ItemSubGroupID

The name of the subgroup this entity should be sorted into in the map editor building selection.

The name of the subgroup this entity should be sorted into in the map editor building selection.

allow_copy_paste optional :: bool
selectable_in_game optional :: bool
selection_priority optional :: uint8

The entity with the higher number is selectable before the entity with the lower number. [...]

The entity with the higher number is selectable before the entity with the lower number. [...]

build_grid_size optional :: uint8

Supported values are 1 (for 1x1 grid) and 2 (for 2x2 grid, like rails). [...]

Supported values are 1 (for 1x1 grid) and 2 (for 2x2 grid, like rails). [...]

remove_decoratives optional :: "automatic" or "true" or "false"

Whether this entity should remove decoratives that collide with it when this entity is built. [...]

Whether this entity should remove decoratives that collide with it when this entity is built. [...]

emissions_per_second optional :: double

Amount of emissions created (positive number) or cleaned (negative number) every second by the entity. [...]

Amount of emissions created (positive number) or cleaned (negative number) every second by the entity. [...]

shooting_cursor_size optional :: float

The cursor size used when shooting at this entity.

The cursor size used when shooting at this entity.

created_smoke optional :: CreateTrivialSmokeEffectItem

The smoke that is shown when the entity is placed.

The smoke that is shown when the entity is placed.

working_sound optional :: WorkingSound

Will also work on entities that don't actually do work.

Will also work on entities that don't actually do work.

created_effect optional :: Trigger

The effect/trigger that happens when the entity is placed.

The effect/trigger that happens when the entity is placed.

build_sound optional :: Sound
mined_sound optional :: Sound
mining_sound optional :: Sound
rotated_sound optional :: Sound
vehicle_impact_sound optional :: Sound

When playing this sound, the volume is scaled by the speed of the vehicle when colliding with this entity.

When playing this sound, the volume is scaled by the speed of the vehicle when colliding with this entity.

open_sound optional :: Sound
close_sound optional :: Sound
radius_visualisation_specification optional :: RadiusVisualisationSpecification
build_base_evolution_requirement optional :: double
alert_icon_shift optional :: Vector
alert_icon_scale optional :: float
fast_replaceable_group optional :: string

This allows you to replace an entity that's already placed, with a different one in your inventory. [...]

This allows you to replace an entity that's already placed, with a different one in your inventory. [...]

next_upgrade optional :: EntityID

Name of the entity that will be automatically selected as the upgrade of this entity when using the upgrade planner without configuration. [...]

Name of the entity that will be automatically selected as the upgrade of this entity when using the upgrade planner without configuration. [...]

protected_from_tile_building optional :: bool

When this is true, this entity prototype should be included during tile collision checks with tiles that have TilePrototype::check_collision_with_entities set to true.

When this is true, this entity prototype should be included during tile collision checks with tiles that have TilePrototype::check_collision_with_entities set to true.

placeable_by optional :: ItemToPlace or array[ItemToPlace]

Item that when placed creates this entity. [...]

Item that when placed creates this entity. [...]

remains_when_mined optional :: EntityID or array[EntityID]

The entity that remains when this one is mined, deconstructed or fast-replaced. [...]

The entity that remains when this one is mined, deconstructed or fast-replaced. [...]

additional_pastable_entities optional :: array[EntityID]

Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types. [...]

Names of the entity prototypes this entity prototype can be pasted on to in addition to the standard supported types. [...]

tile_width optional :: uint32

Used to determine how the center of the entity should be positioned when building (unless the off-grid flag is specified). [...]

Used to determine how the center of the entity should be positioned when building (unless the off-grid flag is specified). [...]

tile_height optional :: uint32
autoplace optional :: AutoplaceSpecification

Used to specify the rules for placing this entity during map generation.

Used to specify the rules for placing this entity during map generation.

map_color optional :: Color
friendly_map_color optional :: Color
enemy_map_color optional :: Color
water_reflection optional :: WaterReflectionDefinition

May also be defined inside graphics_set instead of directly in the entity prototype. [...]

May also be defined inside graphics_set instead of directly in the entity prototype. [...]

Inherited from PrototypeBase
type :: string

Specifies the kind of prototype this is. [...]

Specifies the kind of prototype this is. [...]

name :: string

Unique textual identification of the prototype. [...]

Unique textual identification of the prototype. [...]

order optional :: Order

Used to order prototypes in inventory, recipes and GUIs. [...]

Used to order prototypes in inventory, recipes and GUIs. [...]

localised_name optional :: LocalisedString

Overwrites the name set in the locale file. [...]

Overwrites the name set in the locale file. [...]

localised_description optional :: LocalisedString

Overwrites the description set in the locale file. [...]

Overwrites the description set in the locale file. [...]

Properties

damage_per_tick :: DamagePrototype

spread_delay :: uint32

spread_delay_deviation :: uint32

render_layer :: RenderLayer optional

Default: "object"

initial_render_layer :: RenderLayer optional

Default: "object"

secondary_render_layer :: RenderLayer optional

Default: "object"

small_tree_fire_pictures :: AnimationVariations optional

pictures :: AnimationVariations optional

smoke_source_pictures :: AnimationVariations optional

secondary_pictures :: AnimationVariations optional

burnt_patch_pictures :: SpriteVariations optional

secondary_picture_fade_out_start :: uint32 optional

Default: 0

secondary_picture_fade_out_duration :: uint32 optional

Default: 30

spawn_entity :: EntityID optional

smoke :: array[SmokeSource] optional

maximum_spread_count :: uint16 optional

Default: 200

initial_flame_count :: uint8 optional

Default: 0

Spawns this many secondary_pictures around the entity when it first spawns. It waits delay_between_initial_flames between each spawned secondary_pictures. This can be used to make fires look less repetitive.

For example, spitters use this to make several smaller splashes around the main one.

uses_alternative_behavior :: bool optional

Default: false

If false, then all animations loop. If true, they run once and stay on the final frame. Also changes the behavior of several other fire properties as mentioned in their descriptions.

For example, spitters use alternate behavior, flamethrower flames don't.

limit_overlapping_particles :: bool optional

Default: false

tree_dying_factor :: float optional

Default: 0

fade_in_duration :: uint32 optional

Default: 30

fade_out_duration :: uint32 optional

Default: 30

initial_lifetime :: uint32 optional

Default: 300

damage_multiplier_decrease_per_tick :: float optional

Default: 0.0

damage_multiplier_increase_per_added_fuel :: float optional

Default: 0.0

maximum_damage_multiplier :: float optional

Default: 1.0

lifetime_increase_by :: uint32 optional

Default: 20

lifetime_increase_cooldown :: uint32 optional

Default: 10

maximum_lifetime :: uint32 optional

Default: Max uint32

add_fuel_cooldown :: uint32 optional

Default: 10

delay_between_initial_flames :: uint32 optional

Default: 10

smoke_fade_in_duration :: uint32 optional

Default: 30

smoke_fade_out_duration :: uint32 optional

Default: 30

on_fuel_added_action :: Trigger optional

on_damage_tick_effect :: Trigger optional

light :: LightDefinition optional

particle_alpha_blend_duration :: uint16 optional

Default: 0

burnt_patch_lifetime :: uint32 optional

Default: 1800

burnt_patch_alpha_default :: float optional

Default: 1

particle_alpha :: float optional

Default: 1

Only loaded if uses_alternative_behavior is true.

particle_alpha_deviation :: float optional

Default: 0

Only loaded if uses_alternative_behavior is true.

flame_alpha :: float optional

Default: 1

Only loaded if uses_alternative_behavior is false.

flame_alpha_deviation :: float optional

Default: 0

Only loaded if uses_alternative_behavior is false.

burnt_patch_alpha_variations :: array[TileAndAlpha] optional

TileAndAlpha :: struct

Properties

tile :: TileID

alpha :: float

Overridden Properties

collision_mask :: CollisionMask optional

Default: no masks

Two entities can collide only if they share a layer from the collision mask.

Prototypes

Types