HytaleDocs
ItemBlock

Spawners

Asset path: Server/Item/Block/Spawners/*.json

Parent

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

When inheriting from another BlockSpawnerTable 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

Entries

Type information:

(Nullable) Array of the type:

BlockSpawnerEntry with the following properties:

KeyTypeDescription
Name(Nullable) String

Reference to a BlockType asset

RotationMode(Nullable) Any one of the following String (defaults to Inherit):
RotationMode
NameDescription
"None"
"Random"
"Inherit"
WeightNumber defaults to: 0.0
Components(Nullable)
Holder

Holder with the following properties:

KeyTypeDescription
Components(Nullable) Type 0

Notes:

Types referenced by this type

Type 0

(Nullable)

Object with the following properties:

KeyTypeDescription
AugmentBlock
AugmentBlock

AugmentBlock with the following properties:

KeyTypeDescription
Upgrades(Nullable) Array of the type: AugmentBlockUpgradeLevel
CurrentLevelInteger defaults to: 0
GrantsAugmentTags(Nullable) Array of String
RadiusNumber defaults to: 100.0
ProgressionKey(Nullable) String
ProgressionLevelOffsetInteger defaults to: 0
BenchBlock
BenchBlock

BenchBlock with the following properties:

KeyTypeDescription
TierLevelInteger defaults to: 1
UpgradeItems(Nullable) Array of the type: ItemStack
Block
BlockSection

BlockSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
BlockAnimationSection
BlockAnimationSection

BlockAnimationSection with the following properties:

KeyTypeDescription
VersionInteger
RevisionInteger defaults to: 0
Entries(Nullable) Array of the type: SerializedEntry
BlockChunk
BlockChunk

BlockChunk with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
BlockComponent
BlockComponentSection

BlockComponentSection with the following properties:

KeyTypeDescription
Blocks(Nullable) Type 1
BlockComponentChunk
BlockComponentChunk

BlockComponentChunk with the following properties:

KeyTypeDescription
BlockComponents(Nullable) Type 1
BlockExplosive
BlockExplosive

BlockExplosive with the following properties:

KeyTypeDescription
PrimedOnPlaceBoolean defaults to: false

If the fuse will immediately being running down when the block is placed.

FuseDuration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration between being primed and exploding.

BlockHealthChunk
BlockHealthChunk

BlockHealthChunk with the following properties:

KeyTypeDescription
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$

Binary data representing the state of this BlockHealthChunk

LastRepairGameTime(Nullable) String

The last tick of the world this BlockHealthChunk processed.

BlockHealthSection
BlockHealthSection

BlockHealthSection with the following properties:

KeyTypeDescription
VersionInteger
Health(Nullable) Type 2

Damaged blocks by section block index.

Fragility(Nullable) Type 3

Fragile blocks by section block index, with the seconds of fragility left.

BlockMapMarker
BlockMapMarker

BlockMapMarker with the following properties:

KeyTypeDescription
NameString
IconString
DiscoverableBoolean

Whether the marker stays hidden until a gameplay system reveals it to a player.

IconSize(Nullable) MapMarkerIconSize

The size of the marker icon on the world map and the compass. Omit this field or use Default for the standard size. Use Major for a larger icon.

CompassIcon(Nullable) String

Optional icon used on the compass. Omit this field to use Icon.

Alert(Nullable) MapMarkerAlert

Optional compass alert shown for a period after the client adds the marker. Omit this field for no alert.

BlockPhysics
BlockPhysics

BlockPhysics with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
BlockSpawner
BlockSpawner

BlockSpawner with the following properties:

KeyTypeDescription
BlockSpawnerId(Nullable) String
ChunkColumn
ChunkColumn

ChunkColumn with the following properties:

KeyTypeDescription
Sections(Nullable) Array of the type: Holder
ChunkSection
ChunkSection

ChunkSection with the following properties:

KeyTypeDescription
ChunkSpawnedNPCData
ChunkSpawnedNPCData

ChunkSpawnedNPCData with the following properties:

KeyTypeDescription
EnvironmentSpawnCounts(Nullable) Map of string to double
CompanionBlockSpawnerBlock
CompanionBlockSpawnerBlock

CompanionBlockSpawnerBlock with the following properties:

KeyTypeDescription
Marker(Nullable) PersistentRef
ClaimedByBlock(Nullable) Vector3i
Coop
CoopBlock

CoopBlock with the following properties:

KeyTypeDescription
FarmingCoopId(Nullable) String
Residents(Nullable) Array of the type: CoopResident
Storage(Nullable) Either EmptyItemContainer or SimpleItemContainer
Entity
EntitySection

EntitySection with the following properties:

KeyTypeDescription
Entities(Nullable) Array of the type: Holder
EntityChunk
EntityChunk

EntityChunk with the following properties:

KeyTypeDescription
Entities(Nullable) Array of the type: Holder
Environment
EnvironmentSection

EnvironmentSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
EnvironmentChunk
EnvironmentChunk

EnvironmentChunk with the following properties:

KeyTypeDescription
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
EventTrackedBlock
TrackedBlockComponent

TrackedBlockComponent with the following properties:

KeyTypeDescription
UUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
ContextKey(Nullable) String
FarmingBlock
FarmingBlock

FarmingBlock with the following properties:

KeyTypeDescription
CurrentStageSet(Nullable) String
GrowthProgress(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
LastTickGameTime(Nullable) String
GenerationInteger
PreviousBlockType(Nullable) String
SpreadRate(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
ExecutionsInteger
Fluid
FluidSection

FluidSection with the following properties:

KeyTypeDescription
VersionInteger
Data(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$
HeightmapColumn
HeightmapColumn

HeightmapColumn with the following properties:

KeyTypeDescription
HeightmapEither LegacyHeightmap or TreeHeightmap
Instance
InstanceBlock

InstanceBlock with the following properties:

KeyTypeDescription
WorldName(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
CloseOnBlockRemoveBoolean defaults to: true
InstanceConfig
ConfigurableInstanceBlock

ConfigurableInstanceBlock with the following properties:

KeyTypeDescription
WorldName(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
CloseOnBlockRemoveBoolean defaults to: true
InstanceName(Nullable) String
InstanceKey(Nullable) String
PositionOffset(Nullable) Vector3d
Rotation(Nullable) Rotation3f
PersonalReturnPointBoolean defaults to: false
RemoveBlockAfterNumber defaults to: -1.0
ItemContainerBlock
ItemContainerBlock

ItemContainerBlock with the following properties:

KeyTypeDescription
Droplist(Nullable) String

Reference to a ItemDropList asset

ItemContainer(Nullable) SimpleItemContainer
CapacityInteger defaults to: 20
StayOpenWhenEmptyBoolean

If true, the container keeps its OpenWindow block state when the last window closes on an empty container.

LaunchPad
LaunchPad

LaunchPad with the following properties:

KeyTypeDescription
VelocityXNumber defaults to: 0.0

The X velocity of the launch pad.

VelocityYNumber defaults to: 0.0

The Y velocity of the launch pad.

VelocityZNumber defaults to: 0.0

The Z velocity of the launch pad.

PlayersOnlyBoolean defaults to: false

Determines whether only players can use this launch pad.

MusicEmitterBlock
MusicEmitterBlock

MusicEmitterBlock with the following properties:

KeyTypeDescription
MusicContainer(Nullable) String

Reference to a MusicContainer asset

MusicContainer asset id this emitter plays.

AudioCategoryOverride(Nullable) String

Reference to a AudioCategory asset

Optional AudioCategory asset id overriding the container's routing.

ReferenceDistance(Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance at which the emitter plays at full volume.

MaxDistance(Nullable) Either Number defaults to: 25.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance beyond which the emitter is inaudible.

SpatialBlend(Nullable) Either Number defaults to: 0.6000000238418579 or String that matches the pattern: ^(-?Infinity|NaN)$

0 = fully 2D, 1 = fully 3D positioned.

ReverbSend(Nullable) Either Number defaults to: 0.3499999940395355 or String that matches the pattern: ^(-?Infinity|NaN)$

Fraction routed to environment reverb. 0 = dry, 1 = full. Lower keeps sustained music from washing in reverberant spaces.

Volume(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Volume adjustment in decibels, usually to compensate for a quiet mono downmix. 0 = unchanged.

LoopBoolean defaults to: true

Loop the container indefinitely, overriding its authored LoopCount.

OriginInteger defaults to: 0

Persisted epoch-milli the emitter first started. 0 = unstamped.

MusicPlayerBlock
MusicPlayerBlock

MusicPlayerBlock with the following properties:

KeyTypeDescription
InsertSound(Nullable) String

Reference to a SoundEvent asset

SoundEvent played at the block when a music item is inserted, before the start delay.

RemoveSound(Nullable) String

Reference to a SoundEvent asset

SoundEvent played at the block after a music item is removed and the track has stopped, after the stop delay.

StartDelaySeconds(Nullable) Either Number defaults to: 2.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Seconds between the insert sound and the track starting.

StopDelaySeconds(Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$

Seconds between the track stopping on item removal and the remove sound playing.

ReferenceDistance(Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance at which the track plays at full volume.

MaxDistance(Nullable) Either Number defaults to: 25.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Distance beyond which the track is inaudible.

SpatialBlend(Nullable) Either Number defaults to: 0.6000000238418579 or String that matches the pattern: ^(-?Infinity|NaN)$

0 = fully 2D, 1 = fully 3D positioned.

ReverbSend(Nullable) Either Number defaults to: 0.3499999940395355 or String that matches the pattern: ^(-?Infinity|NaN)$

Fraction routed to environment reverb. 0 = dry, 1 = full. Lower keeps sustained music from washing in reverberant spaces.

Volume(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Volume adjustment in decibels.

LoopBoolean defaults to: true

Loop the inserted item's container indefinitely, overriding its authored LoopCount.

PlacedByInteraction
PlacedByInteractionComponent

PlacedByInteractionComponent with the following properties:

KeyTypeDescription
WhoPlacedUuid(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
Portal
PortalDevice

PortalDevice with the following properties:

KeyTypeDescription
Config(Nullable) PortalDeviceConfig
BaseBlockType(Nullable) String
DestinationWorld(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
PrefabSpawner
PrefabSpawnerBlock

PrefabSpawnerBlock with the following properties:

KeyTypeDescription
PrefabPath(Nullable) String

The prefab path where the prefab is located. This uses the dot-notation. 'folder.folder.folder.filename'

FitHeightmapBoolean defaults to: false

Determines if the child prefab should follow the heightmap during generation in worldgen.

InheritSeedBoolean defaults to: true

Determines if the child prefab should inherit the worldgen-id from the parent. This allows child prefabs to have independent markers.

InheritHeightConditionBoolean defaults to: true

Determines if the child prefab should inherit the HeightCondition from the parent. Setting to false allows child prefabs to bypass the height condition check.

PrefabWeights(Nullable) PrefabWeights

Determines the probability of each individual prefab file being selected to generate when the PrefabPath points to a folder containing multiple prefabs.

ProcessingBenchBlock
ProcessingBenchBlock

ProcessingBenchBlock with the following properties:

KeyTypeDescription
InputContainer(Nullable) Either EmptyItemContainer or SimpleItemContainer
FuelContainer(Nullable) Either EmptyItemContainer or SimpleItemContainer
OutputContainer(Nullable) Either EmptyItemContainer or SimpleItemContainer
ProgressNumber defaults to: 0.0
FuelTimeNumber defaults to: 0.0
ActiveBoolean defaults to: false
NextExtraInteger defaults to: -1
RecipeId(Nullable) String
LastTickGameTime(Nullable) String
RespawnBlock
RespawnBlock

RespawnBlock with the following properties:

KeyTypeDescription
OwnerUUID(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
SpawnMarkerBlock
SpawnMarkerBlock

SpawnMarkerBlock with the following properties:

KeyTypeDescription
MarkerReference(Nullable) PersistentRef
Config(Nullable) Data
Teleporter
Teleporter

Teleporter with the following properties:

KeyTypeDescription
World(Nullable) String that matches the pattern: ^[0-9a-zA-Z+/]+$ and is at least 24 characters long and is at most 24 characters long
Transform(Nullable) Transform
RelativeInteger defaults to: 0
Warp(Nullable) String
OwnedWarp(Nullable) String
IsCustomNameBoolean defaults to: false
WarpNameWordList(Nullable) String

The ID of the Word list to select default warp names from

TilledSoil
TilledSoilBlock

TilledSoilBlock with the following properties:

KeyTypeDescription
VersionInteger
PlantedBoolean
ModifierTimes(Nullable) Map
Flags(Nullable) Array of String
FertilizedBoolean
ExternalWaterBoolean
WateredUntil(Nullable) String
DecayTime(Nullable) String
TrackedPlacement
TrackedPlacement

TrackedPlacement with the following properties:

KeyTypeDescription
BlockName(Nullable) String
Unknown
UnknownComponents

UnknownComponents with the following properties:

KeyTypeDescription
Components(Nullable) Map (1)
WorldChunk
WorldChunk

WorldChunk with the following properties:

KeyTypeDescription

Type 1

(Nullable) Map of the following:

KeyType

A string that contains any integer

Holder

Holder with the following properties:

KeyTypeDescription
Components(Nullable) Type 0

Type 2

(Nullable) Map of the following:

KeyType

A string that contains any integer

BlockHealth

BlockHealth with the following properties:

KeyTypeDescription
Health(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Remaining health from 0.0 (destroyed) to 1.0 (undamaged).

LastDamage(Nullable) Integer

The game time of the last hit, as epoch milliseconds.

Type 3

(Nullable) Map of the following:

KeyType

A string that contains any integer

Number

MapMarkerIconSize

(Nullable) Any one of the following String:

NameDescription
"Default"

The standard marker icon size.

"Major"

A larger marker icon size.

Map of string to double

(Nullable) Map of the following:

KeyType
StringNumber

Map

(Nullable) Map of the following:

KeyType
any StringString

Map (1)

(Nullable) Map of the following:

KeyType
any StringMap of the following:
Map
KeyType
any Stringanything

On this page