BoxSpecification - Prototype Docs

BoxSpecification :: struct

A cursor box, for use in UtilitySprites.

Properties

sprite	:: Sprite
is_whole_box optional	:: bool	Whether this is a complete box or just the top left corner. [...]
Whether this is a complete box or just the top left corner. [...]
side_length optional	:: double	Only loaded, and mandatory if `is_whole_box` is `true`.
Only loaded, and mandatory if `is_whole_box` is `true`.
side_height optional	:: double	Only loaded, and mandatory if `is_whole_box` is `true`.
Only loaded, and mandatory if `is_whole_box` is `true`.
max_side_length optional	:: double	Only loaded, and mandatory if `is_whole_box` is `false`.
Only loaded, and mandatory if `is_whole_box` is `false`.

Properties

sprite :: Sprite

is_whole_box :: bool optional

Default: false

Whether this is a complete box or just the top left corner. If this is true, side_length and side_height must be present. Otherwise max_side_length must be present.

side_length :: double optional

Only loaded, and mandatory if is_whole_box is true.

side_height :: double optional

Only loaded, and mandatory if is_whole_box is true.

max_side_length :: double optional

Only loaded, and mandatory if is_whole_box is false.

Type used in

Prototypes - Types - Defines - Inheritance

Factorio Prototype DocsVersion 2.0.26

BoxSpecification :: struct

Properties

Properties

sprite :: Sprite

is_whole_box :: bool optional

side_length :: double optional

side_height :: double optional

max_side_length :: double optional

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.26