Prototype/SelectionTool

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.

Prototype/SelectionTool — `selection-tool`
alt_selection_color	::	Color
alt_selection_cursor_box_type	::	CursorBoxType
alt_selection_mode	::	table of string
selection_color	::	Color
selection_cursor_box_type	::	CursorBoxType
selection_mode	::	table of string
alt_entity_filter_mode	::	string (optional)
alt_entity_filters	::	table of string (optional)
alt_entity_type_filters	::	table of string (optional)
alt_reverse_entity_filter_mode	::	string (optional)
alt_reverse_entity_filters	::	table of string (optional)
alt_reverse_entity_type_filters	::	table of string (optional)
alt_reverse_selection_color	::	Color (optional)
alt_reverse_selection_count_button_color	::	Color (optional)
alt_reverse_selection_cursor_box_type	::	CursorBoxType (optional)
alt_reverse_selection_mode	::	table of string (optional)
alt_reverse_tile_filter_mode	::	string (optional)
alt_reverse_tile_filters	::	table of string (optional)
alt_selection_count_button_color	::	Color (optional)
alt_tile_filter_mode	::	string (optional)
alt_tile_filters	::	table of string (optional)
always_include_tiles	::	bool (optional)
chart_alt_reverse_selection_color	::	Color (optional)
chart_alt_selection_color	::	Color (optional)
chart_reverse_selection_color	::	Color (optional)
chart_selection_color	::	Color (optional)
entity_filter_mode	::	string (optional)
entity_filters	::	table of string (optional)
entity_type_filters	::	table of string (optional)
mouse_cursor	::	string (optional)
reverse_entity_filter_mode	::	string (optional)
reverse_entity_filters	::	table of string (optional)
reverse_entity_type_filters	::	table of string (optional)
reverse_selection_color	::	Color (optional)
reverse_selection_count_button_color	::	Color (optional)
reverse_selection_cursor_box_type	::	CursorBoxType (optional)
reverse_selection_mode	::	table of string (optional)
reverse_tile_filter_mode	::	string (optional)
reverse_tile_filters	::	table of string (optional)
selection_count_button_color	::	Color (optional)
tile_filter_mode	::	string (optional)
tile_filters	::	table of string (optional)
Inherited from Prototype/ItemWithLabel
default_label_color	::	Color (optional)
draw_label_for_cursor_render	::	bool (optional)
Inherited from Prototype/Item
icons, icon, icon_size (IconSpecification)	::	IconSpecification
stack_size	::	ItemCountType
burnt_result	::	string (optional)
close_sound	::	Sound (optional)
dark_background_icons, dark_background_icon, icon_size (IconSpecification)	::	IconSpecification (optional)
default_request_amount	::	ItemCountType (optional)
flags	::	ItemPrototypeFlags (optional)
fuel_acceleration_multiplier	::	double (optional)
fuel_category	::	string (optional)
fuel_emissions_multiplier	::	double (optional)
fuel_glow_color	::	Color (optional)
fuel_top_speed_multiplier	::	double (optional)
fuel_value	::	Energy (optional)
open_sound	::	Sound (optional)
pictures	::	SpriteVariations (optional)
place_as_tile	::	PlaceAsTile (optional)
place_result	::	string (optional)
placed_as_equipment_result	::	string (optional)
rocket_launch_product	::	ItemProductPrototype (optional)
rocket_launch_products	::	table (array) of ItemProductPrototype (optional)
subgroup	::	string (optional)
wire_count	::	ItemCountType (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

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

alt_reverse_selection_color

Type: Color
Default: Value of reverse_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

alt_reverse_selection_count_button_color

Type: Color
Default: Value of alt_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

chart_alt_reverse_selection_color

Type: Color
Default: Value of alt_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.

alt_reverse_selection_mode

Type: table of string
Default: Value of reverse_selection_mode
A list of selection mode flags that define how the selection tool alt-reverse-selects things in-game (using SHIFT + Right mouse button). 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.

alt_reverse_selection_cursor_box_type

Type: CursorBoxType
Default: Value of reverse_selection_cursor_box_type
The type of cursor box used to render selection of entities/tiles when alt-reverse-selecting (using SHIFT + Right mouse button).

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.

alt_reverse_entity_filters

Type: table of string
Array of Prototype/Entity names.

entity_type_filters

Type: table of string

alt_entity_type_filters

Type: table of string

reverse_entity_type_filters

Type: table of string

alt_reverse_entity_type_filters

Type: table of string

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.