Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# BoxSpecification - Prototype Docs

## BoxSpecification :: struct

A cursor box, for use in UtilitySprites.

## Properties

- default
- sorted

sprite | :: Sprite |
is_whole_box optional | :: boolean | 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`.

sprite | :: Sprite |
is_whole_box optional | :: boolean | Whether this is a complete box or just the top left corner. [...]
Whether this is a complete box or just the top left corner. [...]
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`.
side_height optional | :: double | Only loaded, and mandatory if `is_whole_box` is `true`.
Only loaded, and mandatory if `is_whole_box` is `true`.
side_length optional | :: double | Only loaded, and mandatory if `is_whole_box` is `true`.
Only loaded, and mandatory if `is_whole_box` is `true`.

## Properties

### sprite :: Sprite

### is_whole_box :: boolean 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

- CursorBoxSpecification::regular
- CursorBoxSpecification::multiplayer_selection
- CursorBoxSpecification::not_allowed
- CursorBoxSpecification::copy
- CursorBoxSpecification::electricity
- CursorBoxSpecification::logistics
- CursorBoxSpecification::pair
- CursorBoxSpecification::train_visualization
- CursorBoxSpecification::blueprint_snap_rectangle
- CursorBoxSpecification::spidertron_remote_selected
- CursorBoxSpecification::spidertron_remote_to_be_selected