BoxSpecification - Prototype Docs

Home / Types / BoxSpecification <>

BoxSpecification :: struct

A cursor box, for use in UtilitySprites.

Properties

default

sorted

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	:: double	Only read if `is_whole_box` is true.
Only read if `is_whole_box` is true.
side_height	:: double	Only read if `is_whole_box` is true.
Only read if `is_whole_box` is true.
max_side_length	:: double	Only read if `is_whole_box` is false.
Only read if `is_whole_box` is false.

max_side_length	:: double	Only read if `is_whole_box` is false.
Only read if `is_whole_box` is false.
side_height	:: double	Only read if `is_whole_box` is true.
Only read if `is_whole_box` is true.
side_length	:: double	Only read if `is_whole_box` is true.
Only read if `is_whole_box` is true.
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.

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

Only read if is_whole_box is true.

side_height :: double

Only read if is_whole_box is true.

max_side_length :: double

Only read if is_whole_box is false.

Type used in

Prototypes - Types

Factorio Prototype Docs Version 1.1.91

BoxSpecification :: struct

Properties

Properties

sprite :: Sprite

is_whole_box :: bool optional

side_length :: double

side_height :: double

max_side_length :: double

Prototypes

Types