Prototype/SelectionTool: Difference between revisions
(1.1.61: Reverse filters) |
(Updated styling of prototype doc migration note) |
||
(7 intermediate revisions by 4 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/SelectionToolPrototype.html https://lua-api.factorio.com/latest/prototypes/SelectionToolPrototype.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/ItemWithLabel}} | {{Prototype parent|Prototype/ItemWithLabel}} | ||
Used in the base game as a base for the blueprint item and the deconstruction item. | Used in the base game as a base for the blueprint item and the deconstruction item. | ||
Line 27: | Line 33: | ||
! Flag !! meaning | ! Flag !! meaning | ||
|- | |- | ||
| blueprint || | | blueprint || Selects entities and tiles as if selecting them for a blueprint. | ||
|- | |- | ||
| deconstruct || | | deconstruct || Selects entities and tiles as if selecting them for deconstruction. | ||
|- | |- | ||
| cancel-deconstruct || | | cancel-deconstruct || Selects entities and tiles as if selecting them for deconstruction cancellation. | ||
|- | |- | ||
| items || | | items || Selects items on the ground. | ||
|- | |- | ||
| trees || | | trees || Selects trees. | ||
|- | |- | ||
| buildable-type || | | buildable-type || Selects entities which are considered [https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_building a building], plus landmines. | ||
|- | |- | ||
| nothing || | | nothing || Selects no entities or tiles, but is useful to select an area. | ||
|- | |- | ||
| items-to-place || | | items-to-place || Selects entities and tiles that can be built by an item. | ||
|- | |- | ||
| any-entity || | | any-entity || Selects all entities. | ||
|- | |- | ||
| any-tile || | | any-tile || Selects all tiles. | ||
|- | |- | ||
| same-force || | | same-force || Selects entities with the same force as the selecting player. | ||
|- | |- | ||
| not-same-force || | | not-same-force || Selects entities with a different force as the selecting player. | ||
|- | |- | ||
| friend || | | friend || Selects entities from a friendly force. | ||
|- | |- | ||
| enemy || | | enemy || Selects entities from an enemy force. | ||
|- | |- | ||
| upgrade || | | upgrade || Selects entities as if selecting them for upgrading. | ||
|- | |- | ||
| cancel-upgrade || | | cancel-upgrade || Selects entities as if selecting them for upgrade cancellation. | ||
|- | |- | ||
| downgrade || | | downgrade || Selects entities as if selecting them for downgrading. | ||
|- | |- | ||
| entity-with-health || | | entity-with-health || Selects entities that are an [[Prototype/EntityWithHealth]]. | ||
|- | |- | ||
| entity-with-force || | | entity-with-force || Deprecated. Replaced by "is-military-target". | ||
|- | |- | ||
| | | is-military-target || Selects entities which are [[Prototype/EntityWithOwner#is_military_target]]. | ||
|- | |- | ||
| avoid-rolling-stock || | | 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]]. | |||
|} | |} | ||
Line 82: | Line 94: | ||
{{Prototype property|reverse_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}} | {{Prototype property|reverse_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}} | ||
{{Prototype property|alt_reverse_selection_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}} | |||
{{Prototype property|selection_count_button_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}} | {{Prototype property|selection_count_button_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}} | ||
Line 88: | Line 102: | ||
{{Prototype property|reverse_selection_count_button_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}} | {{Prototype property|reverse_selection_count_button_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}} | ||
{{Prototype property|alt_reverse_selection_count_button_color|[[Types/Color|Color]]|Value of <code>alt_reverse_selection_color</code>|optional=true}} | |||
{{Prototype property|chart_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}} | {{Prototype property|chart_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}} | ||
Line 94: | Line 110: | ||
{{Prototype property|chart_reverse_selection_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}} | {{Prototype property|chart_reverse_selection_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}} | ||
{{Prototype property|chart_alt_reverse_selection_color|[[Types/Color|Color]]|Value of <code>alt_reverse_selection_color</code>|optional=true}} | |||
{{Prototype property|reverse_selection_mode|[[Types/table|table]] of [[Types/string|string]]|Value of <code>selection_mode</code>|optional=true}} | {{Prototype property|reverse_selection_mode|[[Types/table|table]] of [[Types/string|string]]|Value of <code>selection_mode</code>|optional=true}} | ||
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. | 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. | ||
{{Prototype property|alt_reverse_selection_mode|[[Types/table|table]] of [[Types/string|string]]|Value of <code>reverse_selection_mode</code>|optional=true}} | |||
A list of selection mode flags that define how the selection tool alt-reverse-selects things in-game (using {{Keybinding|shift|rmb}}). Possible values are identical to normal selection_mode. | |||
{{Prototype property|reverse_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]|Value of <code>selection_cursor_box_type</code>|optional=true}} | {{Prototype property|reverse_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]|Value of <code>selection_cursor_box_type</code>|optional=true}} | ||
The type of cursor box used to render selection of entities/tiles when reverse-selecting. | The type of cursor box used to render selection of entities/tiles when reverse-selecting. | ||
{{Prototype property|alt_reverse_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]|Value of <code>reverse_selection_cursor_box_type</code>|optional=true}} | |||
The type of cursor box used to render selection of entities/tiles when alt-reverse-selecting (using {{Keybinding|shift|rmb}}). | |||
{{Prototype property|always_include_tiles|[[Types/bool|bool]]|false|optional=true}} | {{Prototype property|always_include_tiles|[[Types/bool|bool]]|false|optional=true}} | ||
Line 114: | Line 138: | ||
{{Prototype property|reverse_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | {{Prototype property|reverse_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | ||
Array of [[Prototype/Entity]] names. | |||
{{Prototype property|alt_reverse_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | |||
Array of [[Prototype/Entity]] names. | Array of [[Prototype/Entity]] names. | ||
Line 121: | Line 148: | ||
{{Prototype property|reverse_entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | {{Prototype property|reverse_entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | ||
{{Prototype property|alt_reverse_entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | |||
{{Prototype property|tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | {{Prototype property|tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | ||
Line 129: | Line 158: | ||
{{Prototype property|reverse_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | {{Prototype property|reverse_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | ||
Array of [[Prototype/Tile]] names. | |||
{{Prototype property|alt_reverse_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | |||
Array of [[Prototype/Tile]] names. | Array of [[Prototype/Tile]] names. | ||
Line 138: | Line 170: | ||
{{Prototype property|reverse_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | {{Prototype property|reverse_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | ||
One of "whitelist" and "blacklist". | |||
{{Prototype property|alt_reverse_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | |||
One of "whitelist" and "blacklist". | One of "whitelist" and "blacklist". | ||
Line 147: | Line 182: | ||
{{Prototype property|reverse_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | {{Prototype property|reverse_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | ||
One of "whitelist" and "blacklist". | |||
{{Prototype property|alt_reverse_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | |||
One of "whitelist" and "blacklist". | One of "whitelist" and "blacklist". |
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/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.
Prototype definitions » PrototypeBase » Prototype/Item » Prototype/ItemWithLabel » Prototype/SelectionTool
Used in the base game as a base for the blueprint item and the deconstruction item.
Extensions
- Prototype/BlueprintItem blueprint
- Prototype/CopyPasteTool copy-paste-tool
- Prototype/DeconstructionItem deconstruction-item
- Prototype/UpgradeItem upgrade-item
Mandatory properties
This prototype inherits all the properties from Prototype/ItemWithLabel.
selection_color
Type: Color
The color of the rectangle used when standard selection is done in-game.
alt_selection_color
Type: Color
The color of the rectangle used when alt-selection is done in-game.
selection_mode
Type: table of string
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. |
alt_selection_mode
Type: table of string
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.
selection_cursor_box_type
Type: CursorBoxType
The type of cursor box used to render selection of entities/tiles when standard selecting.
alt_selection_cursor_box_type
Type: CursorBoxType
The type of cursor box used to render selection of entities/tiles when alt selecting.
Optional properties
reverse_selection_color
Type: Color
Default: Value of selection_color
alt_reverse_selection_color
Type: Color
Default: Value of reverse_selection_color
selection_count_button_color
Type: Color
Default: Value of selection_color
alt_selection_count_button_color
Type: Color
Default: Value of alt_selection_color
reverse_selection_count_button_color
Type: Color
Default: Value of reverse_selection_color
alt_reverse_selection_count_button_color
Type: Color
Default: Value of alt_reverse_selection_color
chart_selection_color
Type: Color
Default: Value of selection_color
chart_alt_selection_color
Type: Color
Default: Value of alt_selection_color
chart_reverse_selection_color
Type: Color
Default: Value of reverse_selection_color
chart_alt_reverse_selection_color
Type: Color
Default: Value of alt_reverse_selection_color
reverse_selection_mode
Type: table of string
Default: Value of selection_mode
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.
alt_reverse_selection_mode
Type: table of string
Default: Value of reverse_selection_mode
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.
reverse_selection_cursor_box_type
Type: CursorBoxType
Default: Value of selection_cursor_box_type
The type of cursor box used to render selection of entities/tiles when reverse-selecting.
alt_reverse_selection_cursor_box_type
Type: CursorBoxType
Default: Value of reverse_selection_cursor_box_type
The type of cursor box used to render selection of entities/tiles when alt-reverse-selecting (using SHIFT + Right mouse button).
always_include_tiles
Type: bool
Default: false
If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.
mouse_cursor
Type: string
Default: "selection-tool-cursor"
Name of a Prototype/MouseCursor.
entity_filters
Type: table of string
Array of Prototype/Entity names.
alt_entity_filters
Type: table of string
Array of Prototype/Entity names.
reverse_entity_filters
Type: table of string
Array of Prototype/Entity names.
alt_reverse_entity_filters
Type: table of string
Array of Prototype/Entity names.
entity_type_filters
alt_entity_type_filters
reverse_entity_type_filters
alt_reverse_entity_type_filters
tile_filters
Type: table of string
Array of Prototype/Tile names.
alt_tile_filters
Type: table of string
Array of Prototype/Tile names.
reverse_tile_filters
Type: table of string
Array of Prototype/Tile names.
alt_reverse_tile_filters
Type: table of string
Array of Prototype/Tile names.
entity_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
alt_entity_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
reverse_entity_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
alt_reverse_entity_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
tile_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
alt_tile_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
reverse_tile_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".
alt_reverse_tile_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".