Prototype/SelectionTool

From Official Factorio Wiki
Revision as of 10:43, 21 September 2023 by BilkaBot (talk | contribs) (Updated styling of prototype doc migration note)
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/SelectionToolPrototype.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.


Template:Prototype parent Used in the base game as a base for the blueprint item and the deconstruction item.

Template:Prototype TOC

Extensions

Mandatory properties

This prototype inherits all the properties from Prototype/ItemWithLabel.

Template:Prototype property The color of the rectangle used when standard selection is done in-game.

Template:Prototype property The color of the rectangle used when alt-selection is done in-game.

Template:Prototype property A list of selection mode flags that define how the selection tool selects things in-game.

Possible values are:

Flag meaning
blueprint Selects entities and tiles as if selecting them for a blueprint.
deconstruct Selects entities and tiles as if selecting them for deconstruction.
cancel-deconstruct Selects entities and tiles as if selecting them for deconstruction cancellation.
items Selects items on the ground.
trees Selects trees.
buildable-type Selects entities which are considered a building, plus landmines.
nothing Selects no entities or tiles, but is useful to select an area.
items-to-place Selects entities and tiles that can be built by an item.
any-entity Selects all entities.
any-tile Selects all tiles.
same-force Selects entities with the same force as the selecting player.
not-same-force Selects entities with a different force as the selecting player.
friend Selects entities from a friendly force.
enemy Selects entities from an enemy force.
upgrade Selects entities as if selecting them for upgrading.
cancel-upgrade Selects entities as if selecting them for upgrade cancellation.
downgrade Selects entities as if selecting them for downgrading.
entity-with-health Selects entities that are an Prototype/EntityWithHealth.
entity-with-force Deprecated. Replaced by "is-military-target".
is-military-target Selects entities which are Prototype/EntityWithOwner#is_military_target.
entity-with-owner Selects entities that are an Prototype/EntityWithOwner.
avoid-rolling-stock Selects entities that are not a Prototype/RollingStock.
entity-ghost Selects entities that are an Prototype/EntityGhost.
tile-ghost Selects entities that are a Prototype/TileGhost.

Template:Prototype property A list of selection mode flags that define how the selection tool alt-selects things in-game. Possible values are identical to normal selection_mode.

Template:Prototype property The type of cursor box used to render selection of entities/tiles when standard selecting.

Template:Prototype property The type of cursor box used to render selection of entities/tiles when alt selecting.

Optional properties

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property A list of selection mode flags that define how the selection tool reverse-selects things in-game. Possible values are identical to normal selection_mode.

Template:Prototype property A list of selection mode flags that define how the selection tool alt-reverse-selects things in-game (using SHIFT + Right mouse button). Possible values are identical to normal selection_mode.

Template:Prototype property The type of cursor box used to render selection of entities/tiles when reverse-selecting.

Template:Prototype property The type of cursor box used to render selection of entities/tiles when alt-reverse-selecting (using SHIFT + Right mouse button).

Template:Prototype property If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.

Template:Prototype property Name of a Prototype/MouseCursor.

Template:Prototype property Array of Prototype/Entity names.

Template:Prototype property Array of Prototype/Entity names.

Template:Prototype property Array of Prototype/Entity names.

Template:Prototype property Array of Prototype/Entity names.

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property

Template:Prototype property Array of Prototype/Tile names.

Template:Prototype property Array of Prototype/Tile names.

Template:Prototype property Array of Prototype/Tile names.

Template:Prototype property Array of Prototype/Tile names.

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".

Template:Prototype property One of "whitelist" and "blacklist".