Prototype/SelectionTool: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(show_in_library is unused as of 0.18.13)
(Removed old prototype docs)
Tag: Replaced
 
(14 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/ItemWithLabel}}
<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]
Used in the base game as a base for the blueprint item and the deconstruction item.


{{Prototype TOC|selection-tool}}
</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>
 
== 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  || The normal rules for acceptable entities in blueprints
|-
| deconstruct || The normal rules for acceptable entities for deconstruction
|-
| cancel-deconstruct || The normal rules for acceptable entities for cancel deconstruction
|-
| items || Item entities
|-
| trees || Trees
|-
| buildable-type || Buildable entities as defined by the game
|-
| nothing || Nothing
|-
| items-to-place || The entity has an item that builds the entity
|-
| any-entity || Any entity
|-
| any-tile || Any tile
|-
| same-force || The entity force matches that of the player doing the selection
|-
| not-same-force || The entity force does not match that of the player doing the selection
|-
| friend || The entity force is friend to that of the player doing the selection
|-
| enemy || The entity force is enemy to that of the player doing the selection
|-
| upgrade || The normal rules for acceptable entities in upgrade planners
|-
| cancel-upgrade || The normal rules for acceptable entities for cancel upgrade
|-
| entity-with-health ||
|-
| entity-with-force ||
|-
| entity-with-owner ||
|}
 
{{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/string|string]]}}
The type of cursor box used to render selection of entities/tiles when standard selecting.
 
Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| entity  || The normal entity selection box. Yellow by default.
|-
| electricity || The selection box used to specify electric poles an entity is connected to. Light blue by default.
|-
| copy || The selection box used when doing entity copy-paste. Green by default.
|-
| not-allowed || The selection box used when specifying colliding entities. Red by default.
|-
| pair ||
|-
| logistics ||
|-
| train-visualization ||
|}
 
{{Prototype property|alt_selection_cursor_box_type|[[Types/string|string]]}}
The type of cursor box used to render selection of entities/tiles when alt selecting. Possible values are identical to normal selection_cursor_box_type.
 
== Optional properties ==
 
{{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|show_in_library|[[Types/bool|bool]]|false|optional=true}}
Whether this is shown in the blueprint library. Unused as of 0.18.13 as the ability to show any selection tools in the blueprint library was removed.
 
{{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|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|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|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|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".

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"