HytaleDocs
Misc

PlacementRule

State

Optional. The ticking block's own state (as defined under State.Definitions) that this rule applies to. If omitted, the rule applies to the block's default (stateless) form.

Type information: (Nullable) String

Block

The single block id to place at the configured offset when this rule's State is matched. Use this for a fixed block; for a randomised choice use Blocks instead. Exactly one of Block or Blocks must be set.

Type information: (Nullable) String

Reference to a BlockType asset

Blocks

A weighted list of candidate blocks to choose from when this rule's State is matched. Each placement randomly selects one entry, with higher Weight values chosen proportionally more often. Exactly one of Block or Blocks must be set.

Type information:

(Nullable) Array of the type:

WeightedBlock with the following properties:

KeyTypeDescription
BlockString

Reference to a BlockType asset

The block id that may be placed when this option is selected.

WeightNumber defaults to: 1.0

Optional. The relative selection weight for this block (default 1.0). A block with weight 2.0 is twice as likely to be chosen as one with weight 1.0.

On this page