Prototype/SelectionTool: Difference between revisions
(Update selection_mode flags to equal runtime docs) |
m (link to LuaEntityPrototype for info what a building is (will be there with 1.1.70)) |
||
| Line 37: | Line 37: | ||
| trees || Selects trees. | | trees || Selects trees. | ||
|- | |- | ||
| buildable-type || Selects entities which are considered a building, plus landmines. | | 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. | | nothing || Selects no entities or tiles, but is useful to select an area. | ||
Revision as of 09:58, 21 September 2022
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 | 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 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 | Selecty 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. |
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.
Optional properties
reverse_selection_color
Type: Color
Default: Value of selection_color
selection_count_button_color
Type: Color
Default: Value of selection_color
alt_selection_count_button_color
Type: Color
Default: Value of alt_selection_color
reverse_selection_count_button_color
Type: Color
Default: Value of reverse_selection_color
chart_selection_color
Type: Color
Default: Value of selection_color
chart_alt_selection_color
Type: Color
Default: Value of alt_selection_color
chart_reverse_selection_color
Type: Color
Default: Value of reverse_selection_color
reverse_selection_mode
Type: table of string
Default: Value of selection_mode
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.
reverse_selection_cursor_box_type
Type: CursorBoxType
Default: Value of selection_cursor_box_type
The type of cursor box used to render selection of entities/tiles when reverse-selecting.
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.
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.
reverse_entity_filters
Type: table of string
Array of Prototype/Entity names.
entity_type_filters
alt_entity_type_filters
reverse_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.
reverse_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".
reverse_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".
reverse_tile_filter_mode
Type: string
Default: "whitelist"
One of "whitelist" and "blacklist".