Prototype/SelectionTool: Difference between revisions
Muppet9010 (talk | contribs) (→Mandatory properties: selection_cursor_box_type - add default colors to values list) |
(Moved CursorBoxType to type page) |
||
| Line 69: | Line 69: | ||
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. | 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/ | {{Prototype property|selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}} | ||
The type of cursor box used to render selection of entities/tiles when standard selecting. | 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]]}} | |||
{{Prototype property|alt_selection_cursor_box_type|[[Types/ | |||
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. | 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. | ||
Revision as of 12:56, 8 September 2020
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 | 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 |
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. Possible values are identical to normal selection_cursor_box_type.
Optional properties
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.
show_in_library
Type: bool
Default: false
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.
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.
entity_type_filters
alt_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.
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".
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".