Types/EquipmentShape: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.17.51)
(Removed old prototype docs)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Basics ==
<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/EquipmentShape.html https://lua-api.factorio.com/latest/types/EquipmentShape.html]
The shape and dimensions of an equipment module.


== Mandatory properties ==
</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>
=== width ===
'''Type''': [[Types/uint32]]
 
=== height ===
'''Type''': [[Types/uint32]]
 
=== type ===
'''Type''': [[Types/string]]
 
The shape. Must be "full" or "manual". When using "manual", <code>points</code> must be defined.
 
== Optional properties ==
=== points ===
'''Type''': [[Types/table]] (array) of [[Types/table]] (array) of [[Types/uint32]]
 
Only used when when using <code>type</code> "manual". Defines the filled squares of the equipment shape. {0, 0} is the upper left corner of the equipment.
 
<syntaxhighlight lang="lua">-- A set of points which fall within the width/height - can't be empty
points = {{0, 0}, {1, 0}, {2, 0}, {3, 0},
          {0, 1},                {3, 1},
          {0, 2},                {3, 2},
          {0, 3}, {1, 3}, {2, 3}, {3, 3}}
</syntaxhighlight>

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/EquipmentShape.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.