A new instance of PlanPart

parentIndex The index of the block this one is attached to
directionOrPosition Direction the block is attached in. Can be a vec3 or a direction. A position must be passed as a vec3 and will be clamped so the new block and parent block touch each other. A direction can be passed as a string ("x", "-x", "px", "nx", "+x" etc.), an ivec3, or an int (-x = 0, +x = 1, -y = 2, +y = 3, -z = 4, +z = 5)
blockType The BlockType of the new block
size The size of the new block. If nil, the size of the parent will be used
color The color of the new block. Can be passed as a Color type, a table with HSV values {h=1, s=1, v=1}, a table with RGB values {r=1, g=1, b=1}, a vec4 (will be interpreted as RGBA), a vec3 (will be interpreted as RGB), or as a number (will be interpreted as a hex int). If nil, color of the parent block will be used.
orientation A matrix containing the orientation of the block. If nil, the identity matrix will be used.
secondaryColor The color of the new block. Similar to color. If nil, ColorNone() will be used.

The index of the new block

blockIndex The index of the block the connector is attached to
direction Direction of the connector. A direction can be passed as a string ("x", "-x", "px", "nx", "+x" etc.), an ivec3, or an int (-x = 0, +x = 1, -y = 2, +y = 3, -z = 4, +z = 5)
flags Optional table with flags: {mirror = "x", repeatable = true, featureWhitelist = {...}, featureBlacklist = {...}, out = true, in = true}

flags.mirror: Direction that connector should mirror in. All subsequent parts added to this connector will have the same mirror direction.
flags.out: Counterpart to "inOnly". Mutually exclusive. Connector is only used when the part was already attached to the plan. It cannot be used to attach the part itself to the plan.
flags.inOnly: Counterpart to "out". Mutually exclusive. Connector is only used to attach the part to the plan. It cannot be used to other, subsequent parts to this part.
flags.repeatable: Allows the part to repeat itself at this connector. See PlanGenerationStage docs for more details.
flags.featureWhitelist: An array-style table containing features. Only parts with the herein defined features can be added to this connector.
flags.featureBlacklist: An array-style table containing features. Only parts without the herein defined features can be added to this connector.

nothing

blockIndex The index of the block
direction Optional. If set, tries to erase a connector from the block into the direction. If nil, the block is erased.

nothing

index The index of the block

BlockPlanBlock The block, or nil if not found

types The types of the blocks

A table containing the found blocks.

Returns a table with all connectors of the part

blocks An array-style table containing all block indices that are to be merged

multiple return values: All block indices that remain of the blocks passed into the function

axis Direction around which axis the part should be rotated. A direction can be passed as a string ("x", "-x", "px", "nx", "+x" etc.), an ivec3, or an int (-x = 0, +x = 1, -y = 2, +y = 3, -z = 4, +z = 5)

nothing

blockIndex The index of the modified block
x The x scale factor
y The y scale factor
z The z scale factor

nothing

axis Direction around which axis the part should be rotated. A direction can be passed as a string ("x", "-x", "px", "nx", "+x" etc.), an ivec3, or an int (-x = 0, +x = 1, -y = 2, +y = 3, -z = 4, +z = 5)
times The amount of times the part should be rotated. Can be -2, -1, 1, 2

nothing

factor vec3 containing the scale factors

nothing

blockIndex The index of the block the connector is coming from
direction The direction of the connector
flags The new flags of the connector. See connector() function for details on those

nothing

plan The used plan

nothing

blockIndex The index of the block
flags Flags table containing the changes of the block. If nil, this property of the part isn't changed: {type = BlockType.Hull, lower = vec3(...), upper = vec3(...), position = vec3(...), size = vec3(...), color = ..., orientation = Matrix()}

flags.type: The new type of the part
flags.lower, flags.upper: vec3s containing the new lower, upper dimensions of the block. Do not use together with position, size
flags.position, flags.size: vec3s containing the new position, size dimensions of the block. Do not use together with lower, upper
flags.color: The new color of the block. See block() for details on how to pass colors
flags.orientation: Matrix containing the new orientation of the block

nothing