Prototype/SelectionTool: Difference between revisions
Jump to navigation
Jump to search
(Set prototype parent) |
(Converted to SMW format) |
||
| Line 1: | Line 1: | ||
{{Prototype parent|Prototype/ItemWithLabel}} | {{Prototype parent|Prototype/ItemWithLabel}} | ||
Used in the base game as a base for the blueprint item and the deconstruction item. | |||
{{Prototype TOC|selection-tool}} | |||
Prototype | |||
== Extensions == | == Extensions == | ||
| Line 15: | Line 13: | ||
This prototype inherits all the properties from [[Prototype/ItemWithLabel]]. | 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. | 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. | 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. | A list of selection mode flags that define how the selection tool selects things in-game. | ||
| Line 74: | Line 66: | ||
|} | |} | ||
{{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. | 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. | The type of cursor box used to render selection of entities/tiles when standard selecting. | ||
| Line 104: | Line 92: | ||
|} | |} | ||
{{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. | 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 == | ||
{{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. | 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. | Whether this is shown in the blueprint library. | ||
{{Prototype property|mouse_cursor|[[Types/string|string]]|"selection-tool-cursor"|optional=true}} | |||
Name of a [[Prototype/MouseCursor]]. | Name of a [[Prototype/MouseCursor]]. | ||
{{Prototype property|entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | |||
Array of [[Prototype/Entity]] names. | Array of [[Prototype/Entity]] names. | ||
{{Prototype property|alt_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | |||
Array of [[Prototype/Entity]] names. | 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. | Array of [[Prototype/Tile]] names. | ||
{{Prototype property|alt_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}} | |||
Array of [[Prototype/Tile]] names. | Array of [[Prototype/Tile]] names. | ||
{{Prototype property|entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | |||
One of "whitelist" and "blacklist". | One of "whitelist" and "blacklist". | ||
{{Prototype property|alt_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | |||
One of "whitelist" and "blacklist". | One of "whitelist" and "blacklist". | ||
{{Prototype property|tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | |||
One of "whitelist" and "blacklist". | One of "whitelist" and "blacklist". | ||
{{Prototype property|alt_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}} | |||
One of "whitelist" and "blacklist". | One of "whitelist" and "blacklist". | ||
Revision as of 15:52, 26 July 2019
Template:Prototype parent 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.
Template:Prototype property The color of the rectangle used when standard selection is done in-game.
Template:Prototype property The color of the rectangle used when alt-selection is done in-game.
Template:Prototype property 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 |
Template:Prototype property 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.
Template:Prototype property 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 | |
| train-visualization |
Template:Prototype property 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
Template:Prototype property If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.
Template:Prototype property Whether this is shown in the blueprint library.
Template:Prototype property Name of a Prototype/MouseCursor.
Template:Prototype property Array of Prototype/Entity names.
Template:Prototype property Array of Prototype/Entity names.
Template:Prototype property Array of Prototype/Tile names.
Template:Prototype property Array of Prototype/Tile names.
Template:Prototype property One of "whitelist" and "blacklist".
Template:Prototype property One of "whitelist" and "blacklist".
Template:Prototype property One of "whitelist" and "blacklist".
Template:Prototype property One of "whitelist" and "blacklist".