Types/BoxSpecification: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Created page with "A cursor box, for use in Prototype/UtilitySprites. == Mandatory properties == === sprite === '''Type''': Types/Sprite == Optional properties == === is_whole_box ==...")
 
m (typo)
Line 13: Line 13:
'''Default''': false
'''Default''': false


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


=== side_length ===
=== side_length ===

Revision as of 11:19, 19 July 2019

A cursor box, for use in Prototype/UtilitySprites.

Mandatory properties

sprite

Type: Types/Sprite

Optional properties

is_whole_box

Type: Types/bool

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

Type: Types/double

Only read if is_whole_box is true.

side_height

Type: Types/double

Only read if is_whole_box is true.

max_side_length

Type: Types/double

Only read if is_whole_box is false.