Prototype/Corpse

From Official Factorio Wiki
Jump to navigation Jump to search

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/CorpsePrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.


Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/Corpse


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


Prototype/Corpse — corpse
animation::RotatedAnimationVariations (optional)
animation_overlay::RotatedAnimationVariations (optional)
animation_overlay_final_render_layer::RenderLayer (optional)
animation_overlay_render_layer::RenderLayer (optional)
animation_render_layer::RenderLayer (optional)
direction_shuffle::table of tables of uint16 (optional)
dying_speed::float (optional)
final_render_layer::RenderLayer (optional)
ground_patch::AnimationVariations (optional)
ground_patch_fade_in_delay::float (optional)
ground_patch_fade_in_speed::float (optional)
ground_patch_fade_out_duration::float (optional)
ground_patch_fade_out_start::float (optional)
ground_patch_higher::AnimationVariations (optional)
ground_patch_render_layer::RenderLayer (optional)
remove_on_entity_placement::bool (optional)
remove_on_tile_placement::bool (optional)
shuffle_directions_at_frame::uint8 (optional)
splash::AnimationVariations (optional)
splash_render_layer::RenderLayer (optional)
splash_speed::float (optional)
time_before_removed::int32 (optional)
time_before_shading_off::int32 (optional)
use_tile_color_for_ground_patch_tint::bool (optional)
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)::IconSpecification
additional_pastable_entities::table of string (optional)
alert_icon_scale::float (optional)
alert_icon_shift::vector (optional)
allow_copy_paste::bool (optional)
autoplace::AutoplaceSpecification (optional)
build_base_evolution_requirement::double (optional)
build_grid_size::uint8 (optional)
build_sound::Sound (optional)
close_sound::Sound (optional)
collision_box::BoundingBox (optional)
collision_mask::CollisionMask (optional)
created_effect::Trigger (optional)
created_smoke::CreateTrivialSmokeEffectItem (optional)
drawing_box::BoundingBox (optional)
emissions_per_second::double (optional)
enemy_map_color::Color (optional)
fast_replaceable_group::string (optional)
flags::EntityPrototypeFlags (optional)
friendly_map_color::Color (optional)
hit_visualization_box::BoundingBox (optional)
map_color::Color (optional)
map_generator_bounding_box::BoundingBox (optional)
minable::MinableProperties (optional)
mined_sound::Sound (optional)
mining_sound::Sound (optional)
next_upgrade::string (optional)
open_sound::Sound (optional)
placeable_by::ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building::bool (optional)
radius_visualisation_specification::RadiusVisualisationSpecification (optional)
remains_when_mined::string or table of string (optional)
remove_decoratives::string (optional)
rotated_sound::Sound (optional)
selectable_in_game::bool (optional)
selection_box::BoundingBox (optional)
selection_priority::uint8 (optional)
shooting_cursor_size::double (optional)
sticker_box::BoundingBox (optional)
subgroup::string (optional)
tile_height::uint32 (optional)
tile_width::uint32 (optional)
trigger_target_mask::TriggerTargetMask (optional)
vehicle_impact_sound::Sound (optional)
water_reflection::WaterReflectionDefinition (optional)
working_sound::WorkingSound (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

Extensions

Optional properties

dying_speed

Type: float
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

Type: float
Default: 1

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

time_before_shading_off

Type: int32
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 tranparency/removed. This time is not added to #time_before_removed, it is instead substracted from it. So by default, the corpse starts fading about 15 seconds before it gets removed.

time_before_removed

Type: int32
Default: 60 * 120 (120 seconds)
Time in ticks this corpse lasts. May not be 0.

remove_on_entity_placement

Type: bool
Default: true

remove_on_tile_placement

Type: bool
Default: true

final_render_layer

Type: RenderLayer
Default: "corpse"

ground_patch_render_layer

Type: RenderLayer
Default: "ground-patch"

animation_render_layer

Type: RenderLayer
Default: "object"

splash_render_layer

Type: RenderLayer
Default: "object"

animation_overlay_render_layer

Type: RenderLayer
Default: "object"

animation_overlay_final_render_layer

Type: RenderLayer
Default: "corpse"

shuffle_directions_at_frame

Type: uint8
Default: 1

use_tile_color_for_ground_patch_tint

Type: bool
Default: false

ground_patch_fade_in_delay

Type: float
Default: 0

ground_patch_fade_in_speed

Type: float
Default: 0

ground_patch_fade_out_start

Type: float
Default: 0

animation

Type: RotatedAnimationVariations
The dying animation.

animation_overlay

Type: RotatedAnimationVariations
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.

splash

Type: AnimationVariations

ground_patch

Type: AnimationVariations

ground_patch_higher

Type: AnimationVariations

ground_patch_fade_out_duration

Type: float
Default: 0

direction_shuffle

Type: table of tables of uint16
An array of arrays of integers. Arrays are called "groups" and must all have the same size.