Types/EquipmentShape: Difference between revisions
Jump to navigation
Jump to search
(Created page with "== Basics == The shape and dimensions of an equipment module. == Mandatory properties == === width === '''Type''': Types/uint32 === height === '''Type''': Types/uint32...") |
(→Optional properties: Better description for points) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 12: | Line 12: | ||
'''Type''': [[Types/string]] | '''Type''': [[Types/string]] | ||
The shape. Must be "full". | 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". Each inner array is a "position" inside width×height of the equipment. Each positions that is defined is a 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 20:09, 27 July 2019
Basics
The shape and dimensions of an equipment module.
Mandatory properties
width
Type: Types/uint32
height
Type: Types/uint32
type
Type: Types/string
The shape. Must be "full" or "manual". When using "manual", points must be defined.
Optional properties
points
Type: Types/table (array) of Types/table (array) of Types/uint32
Only used when when using type "manual". Each inner array is a "position" inside width×height of the equipment. Each positions that is defined is a filled squares of the equipment shape. {0, 0} is the upper left corner of the equipment.
-- 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}}