Prototype/SimpleEntity: Difference between revisions
m (ordering) |
(Updated styling of prototype doc migration note) |
||
(11 intermediate revisions by 3 users not shown) | |||
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. | |||
{{Prototype TOC|simple-entity}} | |||
== Optional properties == | == Optional properties == | ||
This prototype inherits all the properties from [[Prototype/EntityWithHealth]]. | This prototype inherits all the properties from [[Prototype/EntityWithHealth]]. | ||
{{Prototype property|count_as_rock_for_filtered_deconstruction|[[Types/bool|bool]]|false|optional=true}} | |||
Whether this entity should be treated as a rock for the purpose of deconstruction and for [[Prototype/Car#immune_to_rock_impacts]]. | |||
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}} | |||
{{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}} | |||
{{Prototype property|random_variation_on_create|[[Types/bool|bool]]|true|optional=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. | |||
{{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}} | |||
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 <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 <code>picture</code>, <code>pictures</code> or <code>animations</code> defined. | |||
The other two properties take priority over this one. |
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.
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.