HytaleDocs
Misc

CustomConnectedBlockPattern

Type

This field controls the type, it must be set to the constant value "Custom" to function as this type.

Type information: Constant value: Custom

TransformRulesToOrientation

If the rules should be transformed to the current orientation of the block.

Type information: Boolean defaults to: true

YawToApplyAddReplacedBlockType

Apply an additional Yaw to the resulting BlockType represented by this shape. This allows your replacement to be offset from your original placement

Type information:

(Nullable) Any one of the following String:

NameDescription
"None"
"Ninety"
"OneEighty"
"TwoSeventy"

RequireFaceTagsMatchingRoll

Adds Roll comparison to face tag matching in patterns below

Type information: Boolean defaults to: false

AllowedPatternTransformations

Will create additional generated patterns that are variants of this pattern, but rotated/mirrored/flipped to achieve different results. A common example of this is the Fence, which should its resulting shape based on the rotation of its pattern (fence corner rotates depending on which two sides have the corner fence shape)

Type information:

(Nullable)

PatternRotationDefinition with the following properties:

KeyTypeDescription
IsCardinallyRotatableBoolean defaults to: false
MirrorZBoolean defaults to: false
MirrorXBoolean defaults to: false

RulesToMatch

All rules must match in order for the pattern to match

Type information:

(Nullable) Array of the type: Queries the face the block was placed against

ConnectedBlockPatternRule with the following properties:

KeyTypeDescription
Position(Nullable)
Vector3i

Vector3i with the following properties:

KeyTypeDescription
XInteger defaults to: 0
YInteger defaults to: 0
ZInteger defaults to: 0
IncludeOrExclude(Nullable) Any one of the following String:
IncludeOrExclude
NameDescription
"Include"
"Exclude"
PlacementNormals(Nullable) Array of the type: Any one of the following String:
AdjacentSide
NameDescription
"Up"
"Down"
"North"
"East"
"South"
"West"
FaceTags(Nullable)
ConnectedBlockFaceTags

ConnectedBlockFaceTags with the following properties:

KeyTypeDescription
North(Nullable) Array of String
East(Nullable) Array of String
South(Nullable) Array of String
West(Nullable) Array of String
Up(Nullable) Array of String
Down(Nullable) Array of String
Shapes(Nullable) Array of String
BlockTypes(Nullable) Array of String
BlockTypeLists(Nullable) Array of String

OnlyOnPlacement

If true, this pattern will only be checked when the block is first placed.

Type information: Boolean defaults to: false

OnlyOnUpdate

If true, this pattern will only be checked when the block is updated by neighboring block changes.

Type information: Boolean defaults to: false

On this page