Prototype/SelectionTool: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Fixed typo)
(6 intermediate revisions by 2 users not shown)
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.


== Basics ==
{{Prototype TOC|selection-tool}}
Prototype type: '''selection-tool'''
 
Used in the base game as a base for the blueprint item and the deconstruction item. Extends [[Prototype/ItemWithLabel]].


== Extensions ==
== Extensions ==
Line 15: Line 13:
This prototype inherits all the properties from [[Prototype/ItemWithLabel]].
This prototype inherits all the properties from [[Prototype/ItemWithLabel]].


=== selection_color ===
{{Prototype property|selection_color|[[Types/Color|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 ===
{{Prototype property|alt_selection_color|[[Types/Color|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 ===
{{Prototype property|selection_mode|[[Types/table|table]] of [[Types/string|string]]}}
'''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.


Line 66: Line 58:
|-
|-
| cancel-upgrade || The normal rules for acceptable entities for cancel upgrade
| cancel-upgrade || The normal rules for acceptable entities for cancel upgrade
|-
| downgrade || The normal rules for acceptable entities for downgrade
|-
|-
| entity-with-health ||
| entity-with-health ||
Line 72: Line 66:
|-
|-
| entity-with-owner ||
| entity-with-owner ||
|-
| avoid-rolling-stock || The entity is not a [[Prototype/RollingStock]]
|}
|}


=== alt_selection_mode ===
{{Prototype property|alt_selection_mode|[[Types/table|table]] of [[Types/string|string]]}}
'''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.
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 ===
{{Prototype property|selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}}
'''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:
{{Prototype property|alt_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]}}
{| class="wikitable"
The type of cursor box used to render selection of entities/tiles when alt selecting.
|-
! 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 ||
|}


=== alt_selection_cursor_box_type ===
== Optional properties ==
'''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.
{{Prototype property|reverse_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}}


== Optional properties ==
{{Prototype property|selection_count_button_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}}


=== always_include_tiles ===
{{Prototype property|alt_selection_count_button_color|[[Types/Color|Color]]|Value of <code>alt_selection_color</code>|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': false
{{Prototype property|reverse_selection_count_button_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}}


If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.
{{Prototype property|chart_selection_color|[[Types/Color|Color]]|Value of <code>selection_color</code>|optional=true}}


=== show_in_library ===
{{Prototype property|chart_alt_selection_color|[[Types/Color|Color]]|Value of <code>alt_selection_color</code>|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': false
{{Prototype property|chart_reverse_selection_color|[[Types/Color|Color]]|Value of <code>reverse_selection_color</code>|optional=true}}


Whether this is shown in the blueprint library.
{{Prototype property|reverse_selection_mode|[[Types/table|table]] of [[Types/string|string]]|Value of <code>selection_mode</code>|optional=true}}
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.


=== mouse_cursor ===
{{Prototype property|reverse_selection_cursor_box_type|[[Types/CursorBoxType|CursorBoxType]]|Value of <code>selection_cursor_box_type</code>|optional=true}}
'''Type''': [[Types/string]]
The type of cursor box used to render selection of entities/tiles when reverse-selecting.


'''Default''': "selection-tool-cursor"
{{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.


{{Prototype property|mouse_cursor|[[Types/string|string]]|"selection-tool-cursor"|optional=true}}
Name of a [[Prototype/MouseCursor]].
Name of a [[Prototype/MouseCursor]].


=== entity_filters ===
{{Prototype property|entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/string]]
 
Array of [[Prototype/Entity]] names.
Array of [[Prototype/Entity]] names.


=== alt_entity_filters ===
{{Prototype property|alt_entity_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/string]]
 
Array of [[Prototype/Entity]] names.
Array of [[Prototype/Entity]] names.


=== entity_type_filters ===
{{Prototype property|entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/string]]
 
=== alt_entity_type_filters ===
'''Type''': [[Types/table]] of [[Types/string]]


=== tile_filters ===
{{Prototype property|alt_entity_type_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/string]]


{{Prototype property|tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of [[Prototype/Tile]] names.
Array of [[Prototype/Tile]] names.


=== alt_tile_filters ===
{{Prototype property|alt_tile_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/string]]
 
Array of [[Prototype/Tile]] names.
Array of [[Prototype/Tile]] names.


=== entity_filter_mode ===
{{Prototype property|entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': "whitelist"
 
One of "whitelist" and "blacklist".
One of "whitelist" and "blacklist".


=== alt_entity_filter_mode ===
{{Prototype property|alt_entity_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': "whitelist"
 
One of "whitelist" and "blacklist".
One of "whitelist" and "blacklist".


=== tile_filter_mode ===
{{Prototype property|tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': "whitelist"
 
One of "whitelist" and "blacklist".
One of "whitelist" and "blacklist".


=== alt_tile_filter_mode ===
{{Prototype property|alt_tile_filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': "whitelist"
 
One of "whitelist" and "blacklist".
One of "whitelist" and "blacklist".

Revision as of 12:58, 22 September 2021

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

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
downgrade The normal rules for acceptable entities for downgrade
entity-with-health
entity-with-force
entity-with-owner
avoid-rolling-stock The entity is 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.

entity_type_filters

Type: table of string

alt_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.

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".

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/SelectionTool&oldid=186944"