Types/EntityPrototypeFlags: Difference between revisions
No edit summary |
(Updated styling of prototype doc migration note) |
||
| (27 intermediate revisions by 6 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/types/EntityPrototypeFlags.html https://lua-api.factorio.com/latest/types/EntityPrototypeFlags.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> | |||
Array ([[Types/table]]) of strings. The possible strings are listed below. | |||
== "not-rotatable" == | |||
Can't be rotated before or after placing. | |||
== "placeable-[force]" == | == "placeable-[force]" == | ||
*"placeable-player" | *"placeable-player" | ||
*"placeable-neutral" | *"placeable-neutral" | ||
*"placeable-enemy" | *"placeable-enemy" | ||
placeable neutral/player/enemy | placeable neutral/player/enemy determine the default force when placing entities in the map editor and using the *AUTO* option for the force. | ||
=="placeable-off-grid"== | == "placeable-off-grid" == | ||
placeable-off-grid refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with the placeable-off-grid flag do not have to line up with this grid (like trees | placeable-off-grid refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with the placeable-off-grid flag do not have to line up with this grid (like trees and land-mines) | ||
==" | == "player-creation" == | ||
Makes it possible for the biter AI to target the entity as a distraction in distraction mode [https://lua-api.factorio.com/latest/defines.html#defines.distraction <code>by_anything</code>]. Makes it possible to blueprint, deconstruct, and repair the entity (can be turned off again using the specific flags). Enables smoke to be created automatically when building the entity. If the entity does not have [[Prototype/Entity#map_color]] set, "player-creation" makes the entity appear on the map/minimap with the default color specified in the [[Prototype/UtilityConstants]]. | |||
Entities that are [https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_building buildings] and have the player-creation flag set are considered for multiple enemy/unit behaviors: | |||
* Autonomous enemy attacks (usually triggered by pollution) can only attack within chunks that contain at least one entity that is both a building and a player-creation. | |||
* Enemy expansion considers entities that are both buildings and player-creations as "enemy" entities that may block expansion. | |||
==" | == "building-direction-8-way" == | ||
Uses 45 degree angle increments when selecting direction. | |||
==" | == "filter-directions" == | ||
Used to | Used to automatically detect the proper direction, if possible. Used by base with the pump, train stop, and train signal. | ||
== "fast-replaceable-no-build-while-moving" == | |||
Fast replace will not apply when building while moving. | |||
==" | == "breaths-air" == | ||
This is used to specify that the entity breathes air, and so is affected by poison (currently [[Poison_capsule|poison capsules]] are the only source). | |||
==" | == "not-repairable" == | ||
Used to | Used to specify that the entity can not be 'healed' by repair-packs (or construction robots with repair packs) | ||
==" | == "not-on-map" == | ||
The entity does not get drawn on the map. | |||
=="not-blueprintable"== | == "not-blueprintable" == | ||
The entity can't be used in blueprints. | The entity can't be used in blueprints. | ||
=="not-deconstructable"== | == "not-deconstructable" == | ||
The entity can't be deconstructed. | The entity can't be deconstructed. | ||
== "hidden" == | |||
Hides the entity from the bonus GUI (button above the map) and from the made in property of recipe tooltips. | |||
== "hide-alt-info" == | |||
Hides the alt-info of an entity in alt-mode, for example the recipe icon. | |||
== "fast-replaceable-no-cross-type-while-moving" == | |||
Do not fast replace over other entity types when building while moving. | |||
== "no-gap-fill-while-building" == | |||
== "not-flammable" == | |||
Do not apply fire stickers to the entity. | |||
== "no-automated-item-removal" == | |||
Prevents inserters and loaders from taking items from this entity. | |||
== "no-automated-item-insertion" == | |||
Prevents inserters and loaders from inserting items into this entity. | |||
== "no-copy-paste" == | |||
This flag does nothing when set in the data stage because it gets overridden by [[Prototype/Entity#allow_copy_paste]]. Thus, it must be set on the entity via [[Prototype/Entity#allow_copy_paste]]. | |||
== "not-selectable-in-game" == | |||
Disallows selection of the entity even when a selection box is specified for other reasons. For example, selection boxes are used to determine the size of outlines to be shown when highlighting entities inside electric pole ranges. | |||
This flag does nothing when set in the data stage because it gets overridden by [[Prototype/Entity#selectable_in_game]]. Thus, it must be set on the entity via [[Prototype/Entity#selectable_in_game]]. | |||
== "not-upgradable" == | |||
The entity can't be selected by the [[upgrade planner]]. | |||
== "not-in-kill-statistics" == | |||
The entity is not shown in the kill statistics. | |||
== "not-in-made-in" == | |||
The entity is not shown in the made in property of recipe tooltips. | |||
== Example == | == Example == | ||
<syntaxhighlight lang="lua"> | |||
flags = {"placeable-neutral", "player-creation"} | |||
</syntaxhighlight> | |||
Latest revision as of 10:42, 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/types/EntityPrototypeFlags.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.
Array (Types/table) of strings. The possible strings are listed below.
"not-rotatable"
Can't be rotated before or after placing.
"placeable-[force]"
- "placeable-player"
- "placeable-neutral"
- "placeable-enemy"
placeable neutral/player/enemy determine the default force when placing entities in the map editor and using the *AUTO* option for the force.
"placeable-off-grid"
placeable-off-grid refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with the placeable-off-grid flag do not have to line up with this grid (like trees and land-mines)
"player-creation"
Makes it possible for the biter AI to target the entity as a distraction in distraction mode by_anything. Makes it possible to blueprint, deconstruct, and repair the entity (can be turned off again using the specific flags). Enables smoke to be created automatically when building the entity. If the entity does not have Prototype/Entity#map_color set, "player-creation" makes the entity appear on the map/minimap with the default color specified in the Prototype/UtilityConstants.
Entities that are buildings and have the player-creation flag set are considered for multiple enemy/unit behaviors:
- Autonomous enemy attacks (usually triggered by pollution) can only attack within chunks that contain at least one entity that is both a building and a player-creation.
- Enemy expansion considers entities that are both buildings and player-creations as "enemy" entities that may block expansion.
"building-direction-8-way"
Uses 45 degree angle increments when selecting direction.
"filter-directions"
Used to automatically detect the proper direction, if possible. Used by base with the pump, train stop, and train signal.
"fast-replaceable-no-build-while-moving"
Fast replace will not apply when building while moving.
"breaths-air"
This is used to specify that the entity breathes air, and so is affected by poison (currently poison capsules are the only source).
"not-repairable"
Used to specify that the entity can not be 'healed' by repair-packs (or construction robots with repair packs)
"not-on-map"
The entity does not get drawn on the map.
"not-blueprintable"
The entity can't be used in blueprints.
"not-deconstructable"
The entity can't be deconstructed.
Hides the entity from the bonus GUI (button above the map) and from the made in property of recipe tooltips.
"hide-alt-info"
Hides the alt-info of an entity in alt-mode, for example the recipe icon.
"fast-replaceable-no-cross-type-while-moving"
Do not fast replace over other entity types when building while moving.
"no-gap-fill-while-building"
"not-flammable"
Do not apply fire stickers to the entity.
"no-automated-item-removal"
Prevents inserters and loaders from taking items from this entity.
"no-automated-item-insertion"
Prevents inserters and loaders from inserting items into this entity.
"no-copy-paste"
This flag does nothing when set in the data stage because it gets overridden by Prototype/Entity#allow_copy_paste. Thus, it must be set on the entity via Prototype/Entity#allow_copy_paste.
"not-selectable-in-game"
Disallows selection of the entity even when a selection box is specified for other reasons. For example, selection boxes are used to determine the size of outlines to be shown when highlighting entities inside electric pole ranges.
This flag does nothing when set in the data stage because it gets overridden by Prototype/Entity#selectable_in_game. Thus, it must be set on the entity via Prototype/Entity#selectable_in_game.
"not-upgradable"
The entity can't be selected by the upgrade planner.
"not-in-kill-statistics"
The entity is not shown in the kill statistics.
"not-in-made-in"
The entity is not shown in the made in property of recipe tooltips.
Example
flags = {"placeable-neutral", "player-creation"}