Factorio Prototype DocsVersion 2.0.26

CorpsePrototype 'corpse' changed

Used for corpses, for example the remnants when destroying buildings.

Inherits from EntityPrototype « Prototype « PrototypeBase
Children

Properties

dying_speed optional :: float

Multiplier for time_before_shading_off and time_before_removed. [...]

Multiplier for time_before_shading_off and time_before_removed. [...]

splash_speed optional :: float

Controls the speed of the splash animation: 1 ÷ splash_speed = duration of the splash animation

Controls the speed of the splash animation: 1 ÷ splash_speed = duration of the splash animation

time_before_shading_off optional :: uint32

Controls how long the corpse takes to fade, as in how long it takes to get from no transparency to full transparency/removed. [...]

Controls how long the corpse takes to fade, as in how long it takes to get from no transparency to full transparency/removed. [...]

time_before_removed optional :: uint32

Time in ticks this corpse lasts. [...]

Time in ticks this corpse lasts. [...]

expiresnew optional :: bool
remove_on_entity_placement optional :: bool
remove_on_tile_placement optional :: bool
auto_setup_collision_boxnew optional :: bool

If true, and the collision box is unset, this will take the collision box of the first entity that uses this corpse.

If true, and the collision box is unset, this will take the collision box of the first entity that uses this corpse.

final_render_layer optional :: RenderLayer
ground_patch_render_layer optional :: RenderLayer
animation_render_layer optional :: RenderLayer
splash_render_layer optional :: RenderLayer
animation_overlay_render_layer optional :: RenderLayer
animation_overlay_final_render_layer optional :: RenderLayer
shuffle_directions_at_frame optional :: uint8
use_tile_color_for_ground_patch_tint optional :: bool
use_decay_layernew optional :: bool
underwater_layer_offsetnew optional :: int8
ground_patch_fade_in_delay optional :: float
ground_patch_fade_in_speed optional :: float
ground_patch_fade_out_start optional :: float
decay_frame_transition_durationnew optional :: float
animation optional :: RotatedAnimationVariations

The dying animation.

The dying animation.

animation_overlay optional :: RotatedAnimationVariations

Variation count must be the same as animation variation count. [...]

Variation count must be the same as animation variation count. [...]

decay_animationnew optional :: RotatedAnimationVariations
splash optional :: AnimationVariations
ground_patch optional :: AnimationVariations
ground_patch_higher optional :: AnimationVariations
ground_patch_decaynew optional :: AnimationVariations
underwater_patchnew optional :: RotatedSprite
ground_patch_fade_out_duration optional :: float
direction_shuffle optional :: array[array[uint16]]

An array of arrays of integers. [...]

An array of arrays of integers. [...]

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. [...]

collision_box optional :: BoundingBox

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

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

collision_maskchanged optional :: CollisionMaskConnector

Defaults to the mask from UtilityConstants::default_collision_masks when indexed by the entity type.

Defaults to the mask from UtilityConstants::default_collision_masks when indexed by the entity type.

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_vertical_extensionnew optional :: double

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

Specification of extra vertical 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
tile_buildability_rulesnew optional :: array[TileBuildabilityRule]
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.

surface_conditionsnew optional :: array[SurfaceCondition]
deconstruction_alternativenew optional :: EntityID

Used to merge multiple entities into one entry in the deconstruction planner.

Used to merge multiple entities into one entry in the deconstruction planner.

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_decorativeschanged 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_secondchanged optional :: dictionary[AirbornePollutantID → 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_sizechanged optional :: double

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
impact_categorynew optional :: string

Name of a ImpactCategory.

Name of a ImpactCategory.

open_sound optional :: Sound
close_sound optional :: Sound
placeable_position_visualizationnew optional :: Sprite
radius_visualisation_specification optional :: RadiusVisualisationSpecification
stateless_visualisationnew optional :: StatelessVisualisations
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.

heating_energynew optional :: Energy
allow_copy_paste optional :: bool
selectable_in_game optional :: bool
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_widthchanged optional :: int32

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_heightchanged optional :: int32
diagonal_tile_grid_sizenew optional :: TilePosition
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. [...]

ambient_sounds_groupnew optional :: EntityID
ambient_soundsnew optional :: WorldAmbientSoundDefinition or array[WorldAmbientSoundDefinition]
icon_draw_specificationnew optional :: IconDrawSpecification

Used to specify where and how should be the alt-mode icons of entities should be drawn.

Used to specify where and how should be the alt-mode icons of entities should be drawn.

icons_positioningnew optional :: array[IconSequencePositioning]

Inherited from Prototype
factoriopedia_alternative optional :: string

The ID type corresponding to the prototype that inherits from this. [...]

The ID type corresponding to the prototype that inherits from this. [...]

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. [...]

factoriopedia_descriptionnew optional :: LocalisedString

Provides additional description used in factoriopedia.

Provides additional description used in factoriopedia.

subgroupnew optional :: ItemSubGroupID

The name of an ItemSubGroup.

The name of an ItemSubGroup.

hiddennew optional :: bool
hidden_in_factoriopedianew optional :: bool
parameternew optional :: bool

Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.

Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.

factoriopedia_simulationnew optional :: SimulationDefinition

The simulation shown when looking at this prototype in the Factoriopedia GUI.

The simulation shown when looking at this prototype in the Factoriopedia GUI.

Properties

dying_speed :: float optional

Default: 1

Multiplier for time_before_shading_off and time_before_removed. Must be positive.

Controls the speed of the animation: 1 ÷ dying_speed = duration of the animation

splash_speed :: float optional

Default: 1

Controls the speed of the splash animation: 1 ÷ splash_speed = duration of the splash animation

time_before_shading_off :: uint32 optional

Default: 60 * 15 (15 seconds)

Controls how long the corpse takes to fade, as in how long it takes to get from no transparency to full transparency/removed. This time is not added to time_before_removed, it is instead subtracted from it. So by default, the corpse starts fading about 15 seconds before it gets removed.

time_before_removed :: uint32 optional

Default: 60 * 120 (120 seconds)

Time in ticks this corpse lasts. May not be 0.

expires :: bool optional new

Default: true

remove_on_entity_placement :: bool optional

Default: true

remove_on_tile_placement :: bool optional

Default: true

auto_setup_collision_box :: bool optional new

Default: true

If true, and the collision box is unset, this will take the collision box of the first entity that uses this corpse.

final_render_layer :: RenderLayer optional

Default: "corpse"

ground_patch_render_layer :: RenderLayer optional

Default: "ground-patch"

animation_render_layer :: RenderLayer optional

Default: "object"

splash_render_layer :: RenderLayer optional

Default: "object"

animation_overlay_render_layer :: RenderLayer optional

Default: "object"

animation_overlay_final_render_layer :: RenderLayer optional

Default: "corpse"

shuffle_directions_at_frame :: uint8 optional

Default: 1

use_tile_color_for_ground_patch_tint :: bool optional

Default: false

use_decay_layer :: bool optional new

Default: false

underwater_layer_offset :: int8 optional new

Default: 1

ground_patch_fade_in_delay :: float optional

Default: 0

ground_patch_fade_in_speed :: float optional

Default: 0

ground_patch_fade_out_start :: float optional

Default: 0

decay_frame_transition_duration :: float optional new

Default: 0

animation :: RotatedAnimationVariations optional

The dying animation.

animation_overlay :: RotatedAnimationVariations optional

Variation count must be the same as animation variation count. Direction count must be the same as animation direction count. Frame count must be the same as animation frame count.

decay_animation :: RotatedAnimationVariations optional new

splash :: AnimationVariations optional

ground_patch :: AnimationVariations optional

ground_patch_higher :: AnimationVariations optional

ground_patch_decay :: AnimationVariations optional new

underwater_patch :: RotatedSprite optional new

ground_patch_fade_out_duration :: float optional

Default: 0

direction_shuffle :: array[array[uint16]] optional

An array of arrays of integers. The inner arrays are called "groups" and must all have the same size.

Prototypes

Types

Defines