Types/BoxSpecification: Difference between revisions
m (typo) |
(Updated styling of prototype doc migration note) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/BoxSpecification.html https://lua-api.factorio.com/latest/types/BoxSpecification.html] | |||
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
A cursor box, for use in [[Prototype/UtilitySprites]]. | A cursor box, for use in [[Prototype/UtilitySprites]]. | ||
Latest revision as of 10:42, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/BoxSpecification.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
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.