Prototype/SimpleEntity: Difference between revisions

Latest revision as of 10:43, 21 September 2023

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/SimpleEntityPrototype.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/EntityWithHealth » Prototype/SimpleEntity

An extremely basic entity with no special functionality. Used for minable rocks.

Prototype/SimpleEntity — `simple-entity`
animations	::	AnimationVariations (optional)
count_as_rock_for_filtered_deconstruction	::	bool (optional)
picture	::	Sprite (optional)
pictures	::	SpriteVariations (optional)
random_animation_offset	::	bool (optional)
random_variation_on_create	::	bool (optional)
render_layer	::	RenderLayer (optional)
secondary_draw_order	::	int8 (optional)
Inherited from Prototype/EntityWithHealth
alert_when_damaged	::	bool (optional)
attack_reaction	::	AttackReaction (optional)
corpse	::	string or table of strings (optional)
create_ghost_on_death	::	bool (optional)
damaged_trigger_effect	::	TriggerEffect (optional)
dying_explosion	::	ExplosionDefinition or table of ExplosionDefinition (optional)
dying_trigger_effect	::	TriggerEffect (optional)
healing_per_tick	::	float (optional)
hide_resistances	::	bool (optional)
integration_patch	::	Sprite4Way (optional)
integration_patch_render_layer	::	RenderLayer (optional)
loot	::	Loot (optional)
max_health	::	float (optional)
random_corpse_variation	::	bool (optional)
repair_sound	::	Sound (optional)
repair_speed_modifier	::	float (optional)
resistances	::	Resistances (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)

Optional properties

This prototype inherits all the properties from Prototype/EntityWithHealth.

count_as_rock_for_filtered_deconstruction

Type: bool
Default: false
Whether this entity should be treated as a rock for the purpose of deconstruction and for Prototype/Car#immune_to_rock_impacts.

render_layer

Type: RenderLayer
Default: "object"

secondary_draw_order

Type: int8
Default: 0
Used to determine render order for entities with the same render_layer in the same position. Entities with a higher secondary_draw_order are drawn on top.

random_animation_offset

Type: bool
Default: false

random_variation_on_create

Type: bool
Default: true
Whether a random graphics variation is chosen when placing the entity/creating it via script/creating it via map generation. If this is false, the entity will use the first variation instead of a random one.

pictures

Type: SpriteVariations
Simple entity must have one of picture, pictures or animations defined.

This property takes priority over the other two.

picture

Type: Sprite
Simple entity must have one of picture, pictures or animations defined.

This property takes priority over animations.

animations

Type: AnimationVariations
Simple entity must have one of picture, pictures or animations defined.

The other two properties take priority over this one.

@@ Line 1: / Line 1: @@
+<div class="stub"><p>'''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/SimpleEntityPrototype.html https://lua-api.factorio.com/latest/prototypes/SimpleEntityPrototype.html]
+</p><p>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 [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 {{Prototype parent|Prototype/EntityWithHealth}}
 An extremely basic entity with no special functionality. Used for minable rocks.
@@ Line 13: / Line 19: @@
 {{Prototype property|secondary_draw_order|[[Types/int8|int8]]|0|optional=true}}
+Used to determine render order for entities with the same <code>render_layer</code> in the same position. Entities with a higher <code>secondary_draw_order</code> are drawn on top.
 {{Prototype property|random_animation_offset|[[Types/bool|bool]]|false|optional=true}}
@@ Line 20: / Line 27: @@
 {{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}
-Simple entity must have one of 'picture', 'pictures' or 'animations' defined.
+Simple entity must have one of <code>picture</code>, <code>pictures</code> or <code>animations</code> defined.
+This property takes priority over the other two.
 {{Prototype property|picture|[[Types/Sprite|Sprite]]|optional=true}}
-Simple entity must have one of 'picture', 'pictures' or 'animations' defined.
+Simple entity must have one of <code>picture</code>, <code>pictures</code> or <code>animations</code> defined.
+This property takes priority over <code>animations</code>.
 {{Prototype property|animations|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}
-Simple entity must have one of 'picture', 'pictures' or 'animations' defined.
+Simple entity must have one of <code>picture</code>, <code>pictures</code> or <code>animations</code> defined.
+The other two properties take priority over this one.