Factorio Prototype DocsVersion 1.1.107

SelectionToolPrototype - 'selection-tool'

Used in the base game as a base for the blueprint item and the deconstruction item.

Inherits from ItemWithLabelPrototype « ItemPrototype « PrototypeBase
Children

Properties

selection_mode :: SelectionModeFlags

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.

alt_selection_mode :: SelectionModeFlags

A list of selection mode flags that define how the selection tool alt-selects things in-game.

A list of selection mode flags that define how the selection tool alt-selects things in-game.

always_include_tiles optional :: bool

If tiles should be included in the selection regardless of entities also being in the selection. [...]

If tiles should be included in the selection regardless of entities also being in the selection. [...]

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

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

selection_cursor_box_type :: CursorBoxType

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.

alt_selection_cursor_box_type :: CursorBoxType

The type of cursor box used to render selection of entities/tiles when alt selecting.

The type of cursor box used to render selection of entities/tiles when alt selecting.

reverse_selection_color optional :: Color
alt_reverse_selection_color optional :: Color
selection_count_button_color optional :: Color
alt_selection_count_button_color optional :: Color
reverse_selection_count_button_color optional :: Color
alt_reverse_selection_count_button_color optional :: Color
chart_selection_color optional :: Color
chart_alt_selection_color optional :: Color
chart_reverse_selection_color optional :: Color
chart_alt_reverse_selection_color optional :: Color
reverse_selection_mode optional :: SelectionModeFlags

A list of selection mode flags that define how the selection tool reverse-selects things in-game.

A list of selection mode flags that define how the selection tool reverse-selects things in-game.

alt_reverse_selection_mode optional :: SelectionModeFlags

A list of selection mode flags that define how the selection tool alt-reverse-selects things in-game (using SHIFT + Right mouse button).

A list of selection mode flags that define how the selection tool alt-reverse-selects things in-game (using SHIFT + Right mouse button).

reverse_selection_cursor_box_type optional :: CursorBoxType

The type of cursor box used to render selection of entities/tiles when reverse-selecting.

The type of cursor box used to render selection of entities/tiles when reverse-selecting.

alt_reverse_selection_cursor_box_type optional :: CursorBoxType

The type of cursor box used to render selection of entities/tiles when alt-reverse-selecting (using SHIFT + Right mouse button

The type of cursor box used to render selection of entities/tiles when alt-reverse-selecting (using SHIFT + Right mouse button

mouse_cursor optional :: MouseCursorID
entity_filters optional :: array[EntityID]
alt_entity_filters optional :: array[EntityID]
entity_type_filters optional :: array[string]
alt_entity_type_filters optional :: array[string]
tile_filters optional :: array[TileID]
alt_tile_filters optional :: array[TileID]
entity_filter_mode optional :: "whitelist" or "blacklist"
alt_entity_filter_mode optional :: "whitelist" or "blacklist"
tile_filter_mode optional :: "whitelist" or "blacklist"
alt_tile_filter_mode optional :: "whitelist" or "blacklist"
reverse_entity_filters optional :: array[EntityID]
alt_reverse_entity_filters optional :: array[EntityID]
reverse_entity_type_filters optional :: array[string]
alt_reverse_entity_type_filters optional :: array[string]
reverse_tile_filters optional :: array[TileID]
alt_reverse_tile_filters optional :: array[TileID]
reverse_entity_filter_mode optional :: "whitelist" or "blacklist"
alt_reverse_entity_filter_mode optional :: "whitelist" or "blacklist"
reverse_tile_filter_mode optional :: "whitelist" or "blacklist"
alt_reverse_tile_filter_mode optional :: "whitelist" or "blacklist"

Inherited from ItemWithLabelPrototype
default_label_color optional :: Color

The default label color the item will use.

The default label color the item will use.

draw_label_for_cursor_render optional :: bool

If the item will draw its label when held in the cursor in place of the item count.

If the item will draw its label when held in the cursor in place of the item count.

Inherited from ItemPrototype
stack_size :: ItemCountType

Count of items of the same name that can be stored in one inventory slot. [...]

Count of items of the same name that can be stored in one inventory slot. [...]

icons optional :: array[IconData]

Can't be an empty array.

Can't be an empty array.

icon optional :: FileName

Path to the icon file. [...]

Path to the icon file. [...]

icon_size optional :: SpriteSizeType

The size of the square icon, in pixels. [...]

The size of the square icon, in pixels. [...]

icon_mipmaps optional :: IconMipMapType

Icons of reduced size will be used at decreased scale. [...]

Icons of reduced size will be used at decreased scale. [...]

dark_background_icons optional :: array[IconData]

Inside IconData, the property for the file path is dark_background_icon instead of icon. [...]

Inside IconData, the property for the file path is dark_background_icon instead of icon. [...]

dark_background_icon optional :: FileName

If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]

If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]

place_result optional :: EntityID

Name of the EntityPrototype that can be built using this item. [...]

Name of the EntityPrototype that can be built using this item. [...]

placed_as_equipment_result optional :: EquipmentID
subgroup optional :: ItemSubGroupID

The name of the subgroup this item should be sorted into in item selection GUIs like logistic requests. [...]

The name of the subgroup this item should be sorted into in item selection GUIs like logistic requests. [...]

fuel_category optional :: FuelCategoryID

Must exist when a nonzero fuel_value is defined.

Must exist when a nonzero fuel_value is defined.

burnt_result optional :: ItemID

The item that is the result when this item gets burned as fuel.

The item that is the result when this item gets burned as fuel.

place_as_tile optional :: PlaceAsTile
pictures optional :: SpriteVariations

Used to give the item multiple different icons so that they look less uniform on belts. [...]

Used to give the item multiple different icons so that they look less uniform on belts. [...]

flags optional :: ItemPrototypeFlags

Specifies some properties of the item.

Specifies some properties of the item.

default_request_amount optional :: ItemCountType
wire_count optional :: ItemCountType

The number of items needed to connect 2 entities with this as wire. [...]

The number of items needed to connect 2 entities with this as wire. [...]

fuel_value optional :: Energy

Amount of energy the item gives when used as fuel. [...]

Amount of energy the item gives when used as fuel. [...]

fuel_acceleration_multiplier optional :: double
fuel_top_speed_multiplier optional :: double
fuel_emissions_multiplier optional :: double
fuel_glow_color optional :: Color

Colors the glow of the burner energy source when this fuel is burned. [...]

Colors the glow of the burner energy source when this fuel is burned. [...]

open_sound optional :: Sound
close_sound optional :: Sound
rocket_launch_products optional :: array[ItemProductPrototype]
rocket_launch_product optional :: ItemProductPrototype

Only loaded if rocket_launch_products is not defined.

Only loaded if rocket_launch_products is not defined.

Inherited from PrototypeBase
type :: string

Specifies the kind of prototype this is. [...]

Specifies the kind of prototype this is. [...]

name :: string

Unique textual identification of the prototype. [...]

Unique textual identification of the prototype. [...]

order optional :: Order

Used to order prototypes in inventory, recipes and GUIs. [...]

Used to order prototypes in inventory, recipes and GUIs. [...]

localised_name optional :: LocalisedString

Overwrites the name set in the locale file. [...]

Overwrites the name set in the locale file. [...]

localised_description optional :: LocalisedString

Overwrites the description set in the locale file. [...]

Overwrites the description set in the locale file. [...]

Properties

selection_mode :: SelectionModeFlags

A list of selection mode flags that define how the selection tool selects things in-game.

alt_selection_mode :: SelectionModeFlags

A list of selection mode flags that define how the selection tool alt-selects things in-game.

always_include_tiles :: bool optional

Default: false

If tiles should be included in the selection regardless of entities also being in the selection. This is a visual only setting.

selection_color :: Color

The color of the rectangle used when standard selection is done in-game.

alt_selection_color :: Color

The color of the rectangle used when alt-selection is done in-game.

selection_cursor_box_type :: CursorBoxType

The type of cursor box used to render selection of entities/tiles when standard selecting.

alt_selection_cursor_box_type :: CursorBoxType

The type of cursor box used to render selection of entities/tiles when alt selecting.

reverse_selection_color :: Color optional

Default: Value of selection_color

alt_reverse_selection_color :: Color optional

Default: Value of reverse_selection_color

selection_count_button_color :: Color optional

Default: Value of selection_color

alt_selection_count_button_color :: Color optional

Default: Value of alt_selection_color

reverse_selection_count_button_color :: Color optional

Default: Value of reverse_selection_color

alt_reverse_selection_count_button_color :: Color optional

Default: Value of alt_reverse_selection_color

chart_selection_color :: Color optional

Default: Value of selection_color

chart_alt_selection_color :: Color optional

Default: Value of alt_selection_color

chart_reverse_selection_color :: Color optional

Default: Value of reverse_selection_color

chart_alt_reverse_selection_color :: Color optional

Default: Value of alt_reverse_selection_color

reverse_selection_mode :: SelectionModeFlags optional

Default: Value of selection_mode

A list of selection mode flags that define how the selection tool reverse-selects things in-game.

alt_reverse_selection_mode :: SelectionModeFlags optional

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

reverse_selection_cursor_box_type :: CursorBoxType optional

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 :: CursorBoxType optional

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

mouse_cursor :: MouseCursorID optional

Default: "selection-tool-cursor"

entity_filters :: array[EntityID] optional

alt_entity_filters :: array[EntityID] optional

entity_type_filters :: array[string] optional

alt_entity_type_filters :: array[string] optional

tile_filters :: array[TileID] optional

alt_tile_filters :: array[TileID] optional

entity_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

alt_entity_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

tile_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

alt_tile_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

reverse_entity_filters :: array[EntityID] optional

alt_reverse_entity_filters :: array[EntityID] optional

reverse_entity_type_filters :: array[string] optional

alt_reverse_entity_type_filters :: array[string] optional

reverse_tile_filters :: array[TileID] optional

alt_reverse_tile_filters :: array[TileID] optional

reverse_entity_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

alt_reverse_entity_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

reverse_tile_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

alt_reverse_tile_filter_mode :: "whitelist" or "blacklist" optional

Default: "whitelist"

Prototypes

Types