HytaleDocs
Item

ConnectedBlockRuleSets

Asset path: Server/Item/ConnectedBlockRuleSets/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another PatternedConnectedBlockRuleSetAsset most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Patterns

Type information:

Array of the type:

ConnectedBlockPatternConfig with the following properties:

KeyTypeDescription
Rule(Nullable) Type Selector
Output(Nullable)
ConnectedBlockPatternOutput

ConnectedBlockPatternOutput with the following properties:

KeyTypeDescription
ShapeId(Nullable) String

Key of a shape entry in this rule set's Shapes map

TransformRulesWithOrientationBoolean defaults to: false
RotationTransforms(Nullable) Array of the type:
RotationGroup

RotationGroup with the following properties:

KeyTypeDescription
Yaw(Nullable) AllowedRotation
Pitch(Nullable) AllowedRotation
Roll(Nullable) AllowedRotation

Shapes

Type information:

Map of the following:

KeyType
any StringType Selector (1)

UpdateMode

Type information:

(Nullable) Any one of the following String (defaults to PlaceUpdate):

NameDescription
"PlaceUpdate"
"UpdatePlaceUpdate"
"IgnoreUpdates"

Notes:

Types referenced by this type

Type Selector

Any of these:

Key: TypeType
And
ConnectedBlockAndRule

ConnectedBlockAndRule with the following properties:

KeyTypeDescription
TypeConstant value: And

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

RulesArray of the type: Type Selector
FaceTag

A connected block rule that checks if there are face tags present from adjacent blocks

ConnectedBlockFaceTagRule

ConnectedBlockFaceTagRule with the following properties:

KeyTypeDescription
TypeConstant value: FaceTag

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

PositionOffset(Nullable) Vector3i
FaceTagsConnectedBlockFaceTags
MatchTypeMatchType
Not
ConnectedBlockNotRule

ConnectedBlockNotRule with the following properties:

KeyTypeDescription
TypeConstant value: Not

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

RuleType Selector
Or
ConnectedBlockOrRule

ConnectedBlockOrRule with the following properties:

KeyTypeDescription
TypeConstant value: Or

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

RulesArray of the type: Type Selector
Shape

A connected block rule that checks if the neighbor at a position offset resolves to a specific shape

ConnectedBlockShapeRule

ConnectedBlockShapeRule with the following properties:

KeyTypeDescription
TypeConstant value: Shape

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

PositionOffset(Nullable) Vector3i

The block offset from the origin to check

ShapeIdString

Key of a shape entry in the rule set's Shapes map that the neighbor must resolve to

AllowedRotations(Nullable) RotationGroup

Rotations the neighbor's shape may have. When omitted, any rotation matches.

MatchType

Any one of the following String:

NameDescription
"Any"
"All"

AllowedRotation

(Nullable) Any one of the following String (defaults to None):

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

Type Selector (1)

Any of these:

Key: TypeType
Block
ConnectedBlockBlockTypeShape

ConnectedBlockBlockTypeShape with the following properties:

KeyTypeDescription
TypeConstant value: Block

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

FaceTags(Nullable) ConnectedBlockFaceTags
RelativeRotation(Nullable) BlockRotationConfig
BlockString

Reference to a BlockType asset

The block id this shape matches

TagPattern
ConnectedBlockTagShape

ConnectedBlockTagShape with the following properties:

KeyTypeDescription
TypeConstant value: TagPattern

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

FaceTags(Nullable) ConnectedBlockFaceTags
RelativeRotation(Nullable) BlockRotationConfig
TagPatternEither String or TagPattern

Reference to a TagPattern asset

A tag pattern to match blocks

Templated
ConnectedBlockTemplatedShape

ConnectedBlockTemplatedShape with the following properties:

KeyTypeDescription
TypeConstant value: Templated

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

FaceTags(Nullable) ConnectedBlockFaceTags
RelativeRotation(Nullable) BlockRotationConfig
TemplateIdString

Key in the block type's TemplatedShapes map

Animations

Previous Page

CustomConnectedBlockTemplates

Next Page

On this page

ParentTagsPatternsShapesUpdateModeNotes:Type SelectorMatchTypeAllowedRotationType Selector (1)