Types/BoxSpecification: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Migrated prototype doc to separate website)
(Removed old prototype docs)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''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]
<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]


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><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]].
 
== 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, <code>side_length</code> and <code>side_height</code> must be present. Otherwise <code>max_side_length</code> must be present.
 
=== side_length ===
'''Type''': [[Types/double]]
 
Only read if <code>is_whole_box</code> is true.
 
=== side_height ===
'''Type''': [[Types/double]]
 
Only read if <code>is_whole_box</code> is true.
 
=== max_side_length ===
'''Type''': [[Types/double]]
 
Only read if <code>is_whole_box</code> is false.

Latest revision as of 14:32, 25 October 2024

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.

Retrieved from "https://wiki.factorio.com/index.php?title=Types/BoxSpecification&oldid=202626"