Prototype/SelectionTool: Difference between revisions
No edit summary |
(0.16) |
||
| Line 1: | Line 1: | ||
==Basics== | ==Basics== | ||
Used in the base game as a base for the blueprint item and the deconstruction item. Extends [[Prototype/ItemWithLabel]]. | |||
== Mandatory properties == | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/ItemWithLabel]]. | |||
=== selection_color === | === selection_color === | ||
'''Type''': [[Types/Color]] | |||
The color of the rectangle used when standard selection is done in-game. | The color of the rectangle used when standard selection is done in-game. | ||
=== alt_selection_color === | === alt_selection_color === | ||
'''Type''': [[Types/Color]] | |||
The color of the rectangle used when alt-selection is done in-game. | The color of the rectangle used when alt-selection is done in-game. | ||
=== selection_mode === | === selection_mode === | ||
'''Type''': [[Types/table]] of [[Types/string]] | |||
A list of selection mode flags that define how the selection tool selects things in-game. | A list of selection mode flags that define how the selection tool selects things in-game. | ||
Possible values are: | Possible values are: | ||
| Line 45: | Line 49: | ||
=== alt_selection_mode === | === alt_selection_mode === | ||
A list of selection mode flags that define how the selection tool alt-selects things in-game. | '''Type''': [[Types/table]] of [[Types/string]] | ||
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. | ||
=== selection_cursor_box_type === | === selection_cursor_box_type === | ||
'''Type''': [[Types/string]] | |||
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. | ||
Possible values are: | Possible values are: | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 70: | Line 76: | ||
|} | |} | ||
=== alt_selection_cursor_box_type === | |||
'''Type''': [[Types/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 == | == Optional properties == | ||
=== always_include_tiles === | === always_include_tiles === | ||
If tiles should be included in the selection regardless of entities also being in the selection | '''Type''': [[Types/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''': [[Types/bool]] | |||
'''Default''': false | |||
Whether this is shown in the blueprint library. | |||
Revision as of 09:43, 22 May 2018
Basics
Used in the base game as a base for the blueprint item and the deconstruction item. Extends Prototype/ItemWithLabel.
Mandatory properties
This prototype inherits all the properties from Prototype/ItemWithLabel.
selection_color
Type: Types/Color
The color of the rectangle used when standard selection is done in-game.
alt_selection_color
Type: Types/Color
The color of the rectangle used when alt-selection is done in-game.
selection_mode
Type: Types/table of Types/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 |
| tiles | Any tiles |
| items-to-place | The entity has an item that builds the entity |
| any-entity | Any entity |
| any-tile | Any tile |
| matches-force | The entity force matches that of the player doing the selection |
alt_selection_mode
Type: Types/table of Types/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: Types/string
The type of cursor box used to render selection of entities/tiles when standard selecting.
Possible values are:
| 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 |
alt_selection_cursor_box_type
Type: Types/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
always_include_tiles
Type: Types/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: Types/bool
Default: false
Whether this is shown in the blueprint library.