Prototype/SelectionTool: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(Removed old prototype docs)
Tag: Replaced
 
Line 2: Line 2:


</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>
</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}}
Used in the base game as a base for the blueprint item and the deconstruction item.
{{Prototype TOC|selection-tool}}
== 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]].
{{Prototype property|selection_color|[[Types/Color|Color]]}}
The color of the rectangle used when standard selection is done in-game.
{{Prototype property|alt_selection_color|[[Types/Color|Color]]}}
The color of the rectangle used when alt-selection is done in-game.
{{Prototype property|selection_mode|[[Types/table|table]] of [[Types/string|string]]}}
A list of selection mode flags that define how the selection tool selects things in-game.
Possible values are:
{| class="wikitable"
|-
! 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 [https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_building 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]].
|}
{{Prototype property|alt_selection_mode|[[Types/table|table]] of [[Types/string|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.
{{Prototype property|selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}}
The type of cursor box used to render selection of entities/tiles when standard selecting.
{{Prototype property|alt_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}}
The type of cursor box used to render selection of entities/tiles when alt selecting.
== Optional properties ==
{{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|alt_selection_count_button_color|[[Types/Color|Color]]|Value of <code>alt_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_alt_selection_color|[[Types/Color|Color]]|Value of <code>alt_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}}
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}}
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}}
If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.
{{Prototype property|mouse_cursor|[[Types/string|string]]|"selection-tool-cursor"|optional=true}}
Name of a [[Prototype/MouseCursor]].
{{Prototype property|entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Entity]] names.
{{Prototype property|alt_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Entity]] names.
{{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.
{{Prototype property|entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
{{Prototype property|alt_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}}
Array of [[Prototype/Tile]] names.
{{Prototype property|alt_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Tile]] names.
{{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.
{{Prototype property|entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".
{{Prototype property|alt_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".
{{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".
{{Prototype property|tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".
{{Prototype property|alt_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
One of "whitelist" and "blacklist".
{{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".

Latest revision as of 14:33, 25 October 2024

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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/SelectionTool&oldid=202986"