Items

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

Parent

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

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

Key	Type
any `String`	Array of `String`

Icon

Type information: (Nullable) String

Reference to a common asset in the folders:

Common/Icons/ItemsGenerated/
Common/Icons/Items/

with the extension: *.png

SubCategory

Optional sub-category for grouping items with a label header in the creative library menu.

Type information: (Nullable) String

IconProperties

Type information:

(Nullable)

AssetIconProperties with the following properties:

Key Type Description

Scale Number defaults to: 0.0

Translation

(Nullable) Fixed size array of the following:

Type
`Number`
`Number`

Rotation

(Nullable) Fixed size array of the following:

Type
`Number`
`Number`
`Number`

TranslationProperties

The translation properties for this item asset.

Type information:

(Nullable)

ItemTranslationProperties with the following properties:

Key Type Description

Name

(Nullable) String

The translation key for the name of this item.

NameArguments

(Nullable) Map of the following:

Map

Key	Type
any `String`	`String`

The map of arguments used in the item name loc key, if any.

Description

(Nullable) String

The translation key for the description of this item.

DescriptionArguments

(Nullable) Map of the following:

Map

Key	Type
any `String`	`String`

The map of arguments used in the item description loc key, if any.

ItemLevel

Type information: Integer defaults to: 0

Reticle

Type information:

(Nullable) Either String or ItemReticleConfig

Reference to a ItemReticleConfig asset

MaxStack

The maximum amount this item can be stacked in the inventory

Type information: Integer defaults to: -1

Quality

Type information: (Nullable) String

Reference to a ItemQuality asset

ItemEntity

Type information:

ItemEntityConfig with the following properties:

Key Type Description

Physics

(Nullable)

PhysicsValues

PhysicsValues with the following properties:

Key	Type	Description
Mass	`Number` defaults to: `1.0`
DragCoefficient	`Number` defaults to: `0.5`
InvertedGravity	`Boolean` defaults to: `false`

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

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

Lifetime (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$

ParticleSystemId

(Nullable) String defaults to: Item

Reference to a ParticleSystem asset

ParticleColor

(Nullable) A color in the form:

#RRGGBB
rgb(rrr, ggg, bbb)

ShowItemParticles Boolean defaults to: true

SoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

ItemSoundSetId

Type information: String defaults to: ISS_Default

Reference to a ItemSoundSet asset

Set

Type information: (Nullable) String

Model

The model used for rendering this item when held, in inventory, or attached. If set, takes priority over BlockType.CustomModel. Block entities always use BlockType.CustomModel.

Type information: (Nullable) String

Reference to a common asset in the folders:

Common/Blocks/
Common/Items/
Common/Resources/
Common/NPC/
Common/VFX/
Common/Consumable/

with the extension: *.blockymodel

Scale

Type information: Number defaults to: 1.0

Texture

The texture used for rendering this item when held, in inventory, or attached. Paired with Item.Model when set; otherwise block-specific texture properties are used.

Type information: (Nullable) String defaults to: Items/Unknown.png

Reference to a common asset in the folders:

Common/Blocks/
Common/BlockTextures/
Common/Items/
Common/NPC/
Common/Resources/
Common/VFX/

with the extension: *.png

Animation

The animation used for rendering this item. Used only when Item.Model is set; otherwise the block's animation is used.

Type information: (Nullable) String

Reference to a common asset in the folders:

Common/Blocks/
Common/Items/
Common/Resources/
Common/NPC/
Common/VFX/
Common/Consumable/

with the extension: *.blockyanim

UsePlayerAnimations

Type information: Boolean defaults to: false

PlayerAnimationsId

Type information:

Either String or ItemPlayerAnimations

Reference to a ItemPlayerAnimations asset

DroppedItemAnimation

Type information: (Nullable) String

Reference to a common asset in the folders:

Common/Blocks/
Common/Items/
Common/Resources/
Common/NPC/
Common/VFX/
Common/Consumable/

with the extension: *.blockyanim

Particles

The particles played for this item. Used only when Item.Model is set; otherwise the block's particles are used.

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

Key Type Description

SystemId

String

Reference to a ParticleSystem asset

TargetEntityPart

Any one of the following String (defaults to Self):

EntityPart

Name	Description
`"Self"`
`"Entity"`
`"PrimaryItem"`
`"SecondaryItem"`

TargetNodeName (Nullable) String

Color

(Nullable) A color in the form:

#RRGGBB
rgb(rrr, ggg, bbb)

Scale Number defaults to: 1.0

PositionOffset

(Nullable)

Vector3f

Vector3f with the following properties:

Key	Type	Description
X	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Y	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Z	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

RotationOffset

(Nullable)

Direction

Direction with the following properties:

Key	Type	Description
Yaw	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Pitch	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Roll	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

DetachedFromModel

Boolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemove

Boolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

FirstPersonParticles

The particles played for this item when in first person. Used only when Item.Model is set; otherwise the block's particles are used.

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

Key Type Description

SystemId

String

Reference to a ParticleSystem asset

TargetEntityPart

Any one of the following String (defaults to Self):

EntityPart

Name	Description
`"Self"`
`"Entity"`
`"PrimaryItem"`
`"SecondaryItem"`

TargetNodeName (Nullable) String

Color

(Nullable) A color in the form:

#RRGGBB
rgb(rrr, ggg, bbb)

Scale Number defaults to: 1.0

PositionOffset

(Nullable)

Vector3f

Vector3f with the following properties:

Key	Type	Description
X	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Y	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Z	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

RotationOffset

(Nullable)

Direction

Direction with the following properties:

Key	Type	Description
Yaw	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Pitch	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Roll	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

DetachedFromModel

Boolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemove

Boolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

Trails

The trail attached to this item

Type information:

(Nullable) Array of the type:

ModelTrail with the following properties:

Key Type Description

TrailId

(Nullable) Either String or Trail

Reference to a Trail asset

TargetEntityPart

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

EntityPart

Name	Description
`"Self"`
`"Entity"`
`"PrimaryItem"`
`"SecondaryItem"`

TargetNodeName (Nullable) String

PositionOffset

(Nullable)

Vector3f

Vector3f with the following properties:

Key	Type	Description
X	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Y	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Z	Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

RotationOffset

(Nullable)

Direction

Direction with the following properties:

Key	Type	Description
Yaw	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Pitch	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Roll	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

FixedRotation Boolean defaults to: false

Light

The light this item is emitting when being held or dropped. Used only when Item.Model is set; otherwise the block's emitted light is used.

Type information:

(Nullable)

ColorLight with the following properties:

Key Type Description

Color

Key	Type	Description
Color	(Nullable) A color the form: `#RGB`
Radius	`Integer` defaults to: `0`

(Nullable) A color the form:

#RGB

Radius Integer defaults to: 0

Recipe

Type information:

(Nullable) CraftingRecipe

ResourceTypes

Type information:

(Nullable) Array of the type:

ItemResourceType with the following properties:

Key	Type	Description
Id	`String` Reference to a ResourceType asset
Quantity	`Integer` defaults to: `1`

Tool

Type information:

(Nullable)

ItemTool with the following properties:

Key Type Description

Specs (Nullable) Array of the type: ItemToolSpec

Speed Number defaults to: 0.0

DurabilityLossBlockTypes

(Nullable) Array of the type:

DurabilityLossBlockTypes

DurabilityLossBlockTypes with the following properties:

Key	Type	Description
BlockTypes	(Nullable) Array of `String`
BlockSets	(Nullable) Array of `String`
DurabilityLossOnHit	`Number` defaults to: `0.0`

BreakShape

(Nullable) Either

BoxBreakShape

BoxBreakShape with the following properties:

Key	Type	Description
Id	Constant value: `Box`	This field controls the type, it must be set to the constant value "Box" to function as this type.
Width	`Integer` defaults to: `1`	The size of the shape along the user's horizontal view axis (right).
Height	`Integer` defaults to: `1`	The size of the shape along the user's vertical view axis (up).
Depth	`Integer` defaults to: `1`	How many blocks deep the shape extends into the targeted surface. Defaults to 1.
Centered	`Boolean` defaults to: `true`	Whether the shape's width/height are centered on the targeted block. Defaults to true.
Offset	Vector3d	Shifts the shape's center off the targeted block, in the view basis (x = right, y = up, z = into the surface). Rounded to whole blocks.
Orientation	BreakShapeOrientation	How the shape is oriented: 'View' (the dominant axis of the look direction, the default) or 'Surface' (into the targeted block face that the look ray hits).

CylinderBreakShape

CylinderBreakShape with the following properties:

Key	Type	Description
Id	Constant value: `Cylinder`	This field controls the type, it must be set to the constant value "Cylinder" to function as this type.
Width	`Integer` defaults to: `1`	The size of the shape along the user's horizontal view axis (right).
Height	`Integer` defaults to: `1`	The size of the shape along the user's vertical view axis (up).
Depth	`Integer` defaults to: `1`	How many blocks deep the shape extends into the targeted surface. Defaults to 1.
Centered	`Boolean` defaults to: `true`	Whether the shape's width/height are centered on the targeted block. Defaults to true.
Offset	Vector3d	Shifts the shape's center off the targeted block, in the view basis (x = right, y = up, z = into the surface). Rounded to whole blocks.
Orientation	BreakShapeOrientation	How the shape is oriented: 'View' (the dominant axis of the look direction, the default) or 'Surface' (into the targeted block face that the look ray hits).

Optional break shape. When set, breaking with this tool affects the set of blocks the shape covers (oriented to the user's view) instead of only the targeted block.

BreakShapeDurabilityMode

Any one of the following String (defaults to PerSwing):

BreakShapeDurabilityMode

Name	Description
`"PerSwing"`
`"PerBlock"`

How durability is consumed when a break shape affects multiple blocks: once per swing, or once per block broken.

HitSoundLayer

(Nullable) String

Reference to a SoundEvent asset

Sound to play in addition to the block breaking sound when hitting a block this tool is designed to break.

IncorrectMaterialSoundLayer

(Nullable) String

Reference to a SoundEvent asset

Sound to play in addition to the block breaking sound when hitting a block this tool cannot break.

BlockSelectorTool

Type information:

(Nullable)

BlockSelectorToolData with the following properties:

Key	Type	Description
DurabilityLossOnUse	`Number` defaults to: `0.0`

BuilderTool

Type information:

(Nullable)

BuilderTool with the following properties:

Key	Type	Description
Id	(Nullable) `String`
IsBrush	`Boolean` defaults to: `false`
SurvivalAllowed	`Boolean` defaults to: `false`
BrushConfigurationCommand	(Nullable) `String`
Args	(Nullable) Array of the type: Type Selector

Weapon

Type information:

(Nullable)

ItemWeapon with the following properties:

Key Type Description

StatModifiers

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a EntityStatType asset	Array of the type: StaticModifier

EntityStatsToClear (Nullable) Array of String

RenderDualWielded Boolean defaults to: false

Armor

Type information:

(Nullable)

ItemArmor with the following properties:

Key Type Description

ArmorSlot

Any one of the following String (defaults to Head):

ItemArmorSlot

Name	Description
`"Head"`
`"Chest"`
`"Hands"`
`"Legs"`

DamageResistance

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a DamageCause asset	Array of the type: ResistanceModifier

DamageEnhancement

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a DamageCause asset	Array of the type: StaticModifier

DamageClassEnhancement

Map of the following:

Map of DamageClass

Key	Type	Description
Unknown	Array of the type: StaticModifier
Light	Array of the type: StaticModifier
Charged	Array of the type: StaticModifier
Signature	Array of the type: StaticModifier

KnockbackResistances

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a DamageCause asset	Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

KnockbackEnhancements

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a DamageCause asset	Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

Regenerating

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a EntityStatType asset	Array of the type: Regenerating

BaseDamageResistance Number defaults to: 0.0

StatModifiers

(Nullable) Map of the following:

Map

Key	Type
any `String`	Array of the type: StaticModifier

InteractionModifiers

(Nullable) Map of the following:

Map

Key	Type
any `String`	Map

CosmeticsToHide

(Nullable) Array of the type: Any one of the following String:

Cosmetic

Name	Description
`"Haircut"`
`"FacialHair"`
`"Undertop"`
`"Overtop"`
`"Pants"`
`"Overpants"`
`"Shoes"`
`"Gloves"`
`"Cape"`
`"HeadAccessory"`
`"FaceAccessory"`
`"EarAccessory"`
`"Ear"`

MovementSettings

(Nullable)

ItemMovementSettings

ItemMovementSettings with the following properties:

Key	Type	Description
ExtraJumpCount	`Integer` defaults to: `0`
ExtraJumpParticleSystem	(Nullable) `String`
ExtraJumpSoundEvent	(Nullable) `String` Reference to a SoundEvent asset	Sound event to play each time an extra jump is performed.
ExtraJumpLocalSoundEvent	(Nullable) `String` Reference to a SoundEvent asset	Local sound event played to the jumping player.

Glider

Type information:

(Nullable)

ItemGlider with the following properties:

Key	Type	Description
TerminalVelocity	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The maximum speed the player can fall while gliding.
Speed	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The horizontal movement speed of the glider.
FallSpeedMultiplier	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The rate at which the fall speed is incremented.
HorizontalSpeedMultiplier	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The rate at which the horizontal move speed is incremented.
DiveTerminalVelocity	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The terminal velocity of the glider while the player dives.
DiveSpeed	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The horizontal movement speed of the glider while the player dives.
DiveFallSpeedMultiplier	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The rate at which the fall speed is incremented when diving.
DiveHorizontalSpeedMultiplier	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The rate at which the horizontal move speed is incremented when diving.
EnergyClimbRate	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The rate per second at which the energy from a dive converts into upward speed. A higher rate gives a stronger and shorter climb.
DiveSpeedToEnergyRatio	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	Multiplier used to compute the amount of energy earned based on the dive speed reached by the player.

Music

Music this item plays when placed in a music player block.

Type information:

(Nullable)

ItemMusic with the following properties:

Key	Type	Description
MusicContainer	(Nullable) `String` Reference to a MusicContainer asset	MusicContainer asset id this item plays when placed in a music player block.
AudioCategoryOverride	(Nullable) `String` Reference to a AudioCategory asset	Optional AudioCategory asset id overriding the container's routing.

Utility

Type information:

ItemUtility with the following properties:

Key Type Description

Usable Boolean defaults to: false

Compatible Boolean defaults to: false

StatModifiers

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a EntityStatType asset	Array of the type: StaticModifier

EntityStatsToClear (Nullable) Array of String

Ability

Type information:

(Nullable) Either

CoreItemAbility with the following properties:

Key Type Description

Slot

Constant value: Core

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

Cooldown

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

Cooldown in seconds between casts. The single source: the cast chain arms it with TriggerCooldown { UseAbilityCooldown: true }. A support rune modifier on the Cooldown attribute scales it (multiplier, base 1).

Cost

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

Resource cost per cast. The single source: the cast chain gates and spends it with StatsCondition/ChangeStat { UseAbilityCost: true }. A support rune modifier on the Cost attribute scales it (multiplier, base 1).

CostType

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

AbilityCostType

Name	Description
`"None"`
`"Mana"`
`"Stamina"`
`"Health"`

Weapons

(Nullable) Array of String

Weapon families (Family item tags, e.g. Staff, Sword) the caster must hold to cast this ability. Empty or absent means no restriction.

AbilityKeywords

(Nullable) Array of String

Reference to a AbilityKeyword asset

The AbilityKeyword ids this ability carries, e.g. Damage, Elemental, Fire, Projectile, Aoe. Keywords are flat, so list every keyword the ability counts as. Support runes gate on them and the tooltip lists them in this order.

Attributes

(Nullable) Map of the following:

Map

Key	Type
any `String`	Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

Named tunable values (e.g. AoeScale, Duration) that the ability's interactions bind to and support runes modify.

Cast

(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

The root interaction cast when the ability fires from its bench slot (Ability2/Ability3). Abilities cast only from the bench; an ability item held in the hand exposes no interactions.

SupportItemAbility with the following properties:

Key Type Description

Slot

Constant value: Support

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

RequiresAnyAbilityKeyword

(Nullable) Array of String

Reference to a AbilityKeyword asset

The core ability must carry at least one of these AbilityKeyword ids. Empty or absent means no constraint.

RequiresAllAbilityKeywords

(Nullable) Array of String

Reference to a AbilityKeyword asset

The core ability must carry every one of these AbilityKeyword ids.

ExcludesAnyAbilityKeyword

(Nullable) Array of String

Reference to a AbilityKeyword asset

The core ability must carry none of these AbilityKeyword ids.

AttributeModifiers

(Nullable) Map of the following:

Map

Key	Type
any `String`	Array of the type: StaticModifier

Modifiers applied to the supported ability's attributes by name, left to right across the line.

OnHitEffects

(Nullable) Array of String

Reference to a EntityEffect asset

EntityEffect ids applied to every entity damaged by the supported ability's impact.

ConvertElement

(Nullable) String

Reference to a DamageCause asset

The elemental DamageCause the supported ability's elemental damage converts to (e.g. Wind). Damage numbers and ability visuals recolor to match. The rightmost conversion in the line wins.

PortalKey

Type information:

(Nullable)

PortalKey with the following properties:

Key	Type	Description
PortalType	`String` Reference to a PortalType asset	The ID of of the PortalType that this key opens.
TimeLimitSeconds	`Integer`	Overrides the PortalType's TimeLimitSeconds for worlds opened with this key. 0 or less means no time limit.
AllowedEntryCount	`Integer`	Overrides the PortalType's AllowedEntryCount for worlds opened with this key. 0 allows unlimited entries.

Container

Type information:

ItemStackContainerConfig with the following properties:

Key Type Description

Capacity Integer defaults to: 0

GlobalFilter

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

FilterType

Name	Description
`"AllowInputOnly"`
`"AllowOutputOnly"`
`"AllowAll"`
`"DenyAll"`

ItemTag (Nullable) String

Consumable

Type information: Boolean defaults to: false

Variant

Whether this item is a variant of another. Typically this is only the case for connected blocks. If this item is marked as a variant, then we filter it out of the item library menu by default, unless the player chooses to display variants.

Type information: Boolean defaults to: false

MaxDurability

Type information: Number defaults to: 0.0

FuelQuality

Type information: Number defaults to: 1.0

DurabilityLossOnHit

Type information: Number defaults to: 0.0

DurabilityLossOnDeath

Whether this item should loose durability on death, if so configured in DeathConfig.

Type information: Boolean defaults to: true

Repairable

Whether this item can be repaired with a repair kit. Defaults to true. Set to false for items that use durability as a consumable resource (e.g. watering cans, fertilizer).

Type information: Boolean defaults to: true

BlockType

Type information:

(Nullable) Either String or BlockType

Reference to a BlockType asset

Interactions

Type information:

(Nullable) Map of the following:

Key	Type	Description
Primary	Either `String` or RootInteraction Reference to a RootInteraction asset
Secondary	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability1	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability2	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability3	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability4	Either `String` or RootInteraction Reference to a RootInteraction asset
Use	Either `String` or RootInteraction Reference to a RootInteraction asset
Pick	Either `String` or RootInteraction Reference to a RootInteraction asset
Pickup	Either `String` or RootInteraction Reference to a RootInteraction asset
CollisionEnter	Either `String` or RootInteraction Reference to a RootInteraction asset
CollisionLeave	Either `String` or RootInteraction Reference to a RootInteraction asset
Collision	Either `String` or RootInteraction Reference to a RootInteraction asset
EntityStatEffect	Either `String` or RootInteraction Reference to a RootInteraction asset
SwapTo	Either `String` or RootInteraction Reference to a RootInteraction asset
SwapFrom	Either `String` or RootInteraction Reference to a RootInteraction asset
Death	Either `String` or RootInteraction Reference to a RootInteraction asset
Wielding	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileSpawn	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileHit	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileMiss	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileBounce	Either `String` or RootInteraction Reference to a RootInteraction asset
Held	Either `String` or RootInteraction Reference to a RootInteraction asset
HeldOffhand	Either `String` or RootInteraction Reference to a RootInteraction asset
Equipped	Either `String` or RootInteraction Reference to a RootInteraction asset
Dodge	Either `String` or RootInteraction Reference to a RootInteraction asset
GameModeSwap	Either `String` or RootInteraction Reference to a RootInteraction asset
OnBreak	Either `String` or RootInteraction Reference to a RootInteraction asset
OnBreakImpact	Either `String` or RootInteraction Reference to a RootInteraction asset

CarryInteractions

The map interactions available when carrying the item.

Type information:

(Nullable) Map of the following:

Key	Type	Description
Primary	Either `String` or RootInteraction Reference to a RootInteraction asset
Secondary	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability1	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability2	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability3	Either `String` or RootInteraction Reference to a RootInteraction asset
Ability4	Either `String` or RootInteraction Reference to a RootInteraction asset
Use	Either `String` or RootInteraction Reference to a RootInteraction asset
Pick	Either `String` or RootInteraction Reference to a RootInteraction asset
Pickup	Either `String` or RootInteraction Reference to a RootInteraction asset
CollisionEnter	Either `String` or RootInteraction Reference to a RootInteraction asset
CollisionLeave	Either `String` or RootInteraction Reference to a RootInteraction asset
Collision	Either `String` or RootInteraction Reference to a RootInteraction asset
EntityStatEffect	Either `String` or RootInteraction Reference to a RootInteraction asset
SwapTo	Either `String` or RootInteraction Reference to a RootInteraction asset
SwapFrom	Either `String` or RootInteraction Reference to a RootInteraction asset
Death	Either `String` or RootInteraction Reference to a RootInteraction asset
Wielding	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileSpawn	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileHit	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileMiss	Either `String` or RootInteraction Reference to a RootInteraction asset
ProjectileBounce	Either `String` or RootInteraction Reference to a RootInteraction asset
Held	Either `String` or RootInteraction Reference to a RootInteraction asset
HeldOffhand	Either `String` or RootInteraction Reference to a RootInteraction asset
Equipped	Either `String` or RootInteraction Reference to a RootInteraction asset
Dodge	Either `String` or RootInteraction Reference to a RootInteraction asset
GameModeSwap	Either `String` or RootInteraction Reference to a RootInteraction asset
OnBreak	Either `String` or RootInteraction Reference to a RootInteraction asset
OnBreakImpact	Either `String` or RootInteraction Reference to a RootInteraction asset

CarryHudInputBindings

Per carry interaction, the localization key the client shows as an input binding hint on the HUD while the item is carried.

Type information:

(Nullable) Map of the following:

Key	Type	Description
Primary	`String`
Secondary	`String`
Ability1	`String`
Ability2	`String`
Ability3	`String`
Ability4	`String`
Use	`String`
Pick	`String`
Pickup	`String`
CollisionEnter	`String`
CollisionLeave	`String`
Collision	`String`
EntityStatEffect	`String`
SwapTo	`String`
SwapFrom	`String`
Death	`String`
Wielding	`String`
ProjectileSpawn	`String`
ProjectileHit	`String`
ProjectileMiss	`String`
ProjectileBounce	`String`
Held	`String`
HeldOffhand	`String`
Equipped	`String`
Dodge	`String`
GameModeSwap	`String`
OnBreak	`String`
OnBreakImpact	`String`

InteractionConfig

Type information:

InteractionConfiguration with the following properties:

Key Type Description

DisplayOutlines Boolean defaults to: true

DebugOutlines Boolean defaults to: false

UseDistance

Map of the following:

Map of GameMode

Key	Type	Description
Adventure	Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Creative	Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

AllEntities Boolean defaults to: false

Priorities

(Nullable) Map of the following:

Map of InteractionType

Key	Type	Description
Primary	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Secondary	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Ability1	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Ability2	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Ability3	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Ability4	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Use	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Pick	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Pickup	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
CollisionEnter	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
CollisionLeave	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Collision	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
EntityStatEffect	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
SwapTo	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
SwapFrom	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Death	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Wielding	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
ProjectileSpawn	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
ProjectileHit	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
ProjectileMiss	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
ProjectileBounce	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Held	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
HeldOffhand	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Equipped	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
Dodge	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
GameModeSwap	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
OnBreak	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').
OnBreakImpact	InteractionPriority	Either an integer (default for all types) or an object with named priorities (e.g., 'MainHand', 'OffHand', 'Default').

Configures the priority values for given interaction types on this item when two or more items are equipped.

InteractionVars

Type information:

(Nullable) Map of the following:

Key	Type
any `String`	Either `String` or RootInteraction Reference to a RootInteraction asset

ItemAppearanceConditions

Define per EntityStat an array of ItemAppearanceCondition. Only a single condition will be applied to the item at the same time.

Type information:

(Nullable) Map of the following:

Key Type

String

Reference to a EntityStatType asset

Array of the type:

ItemAppearanceCondition

ItemAppearanceCondition with the following properties:

Key	Type	Description
Particles	(Nullable) Array of the type: ModelParticle
FirstPersonParticles	(Nullable) Array of the type: ModelParticle
Model	(Nullable) `String` Reference to a common asset in the folders: `Common/Characters/` `Common/NPC/` `Common/Items/` `Common/VFX/` with the extension: `*.blockymodel`
Texture	(Nullable) `String` Reference to a common asset in the folders: `Common/Characters/` `Common/NPC/` `Common/Items/` `Common/VFX/` with the extension: `*.png`
ModelVFXId	(Nullable) `String` Reference to a ModelVFX asset
WorldSoundEventId	(Nullable) `String` Reference to a SoundEvent asset	3D sound to play in the world when applying this condition.
LocalSoundEventId	(Nullable) `String` Reference to a SoundEvent asset	Local sound to play for the owner of this condition.
Condition	FloatRange	An array of 2 floats to define when the condition is active. 'Infinite' and '-Infinite' can be used to define bounds.
ConditionValueType	ValueType	Enum to specify if the condition range must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.

DisplayEntityStatsHUD

Used to indicate to the client whether an EntityStat HUD UI needs to be displayed

Type information: (Nullable) Array of String

PullbackConfig

Overrides the offset of first person arms when close to obstacles

Type information:

(Nullable)

ItemPullbackConfig with the following properties:

Key Type Description

LeftOffsetOverride

(Nullable) Fixed size array of the following:

Type
`Number`
`Number`
`Number`

LeftRotationOverride

(Nullable) Fixed size array of the following:

Type
`Number`
`Number`
`Number`

RightOffsetOverride

(Nullable) Fixed size array of the following:

Type
`Number`
`Number`
`Number`

RightRotationOverride

(Nullable) Fixed size array of the following:

Type
`Number`
`Number`
`Number`

ItemHudUI with the following properties:

Key Type Description

Path (Nullable) String

Type

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

ItemHudUIType

Name	Description
`"Hud"`
`"Legend"`

DropOnDeath

Type information: Boolean defaults to: false

State

Type information:

(Nullable) Map of the following:

Key	Type
any `String`	Either `String` or Item Reference to a Item asset

Notes:

Types referenced by this type

BreakShapeOrientation

Any one of the following String (defaults to View):

Name	Description
`"View"`
`"Surface"`

Type Selector

Any of these:

Key: Type Type

Block

BlockArg

BlockArg with the following properties:

Key	Type	Description
Type	Constant value: `Block`	This field controls the type, it must be set to the constant value "Block" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	(Nullable) `String`
AllowPattern	`Boolean` defaults to: `false`

Bool

BoolArg

BoolArg with the following properties:

Key	Type	Description
Type	Constant value: `Bool`	This field controls the type, it must be set to the constant value "Bool" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	`Boolean`

BrushOrigin

BrushOriginArg

BrushOriginArg with the following properties:

Key	Type	Description
Type	Constant value: `BrushOrigin`	This field controls the type, it must be set to the constant value "BrushOrigin" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	(Nullable) BrushOrigin

BrushShape

BrushShapeArg

BrushShapeArg with the following properties:

Key	Type	Description
Type	Constant value: `BrushShape`	This field controls the type, it must be set to the constant value "BrushShape" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	(Nullable) BrushShape

Float

FloatArg

FloatArg with the following properties:

Key	Type	Description
Type	Constant value: `Float`	This field controls the type, it must be set to the constant value "Float" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	`Number` defaults to: `0.0`
Min	`Number` defaults to: `0.0`
Max	`Number` defaults to: `0.0`

Int

IntArg

IntArg with the following properties:

Key	Type	Description
Type	Constant value: `Int`	This field controls the type, it must be set to the constant value "Int" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	`Integer`
Min	`Integer` defaults to: `0`
Max	`Integer` defaults to: `0`

Mask

MaskArg

MaskArg with the following properties:

Key	Type	Description
Type	Constant value: `Mask`	This field controls the type, it must be set to the constant value "Mask" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	(Nullable) `String`

Option

OptionArg

OptionArg with the following properties:

Key	Type	Description
Type	Constant value: `Option`	This field controls the type, it must be set to the constant value "Option" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	(Nullable) `String`
Options	Array of `String`

String

StringArg

StringArg with the following properties:

Key	Type	Description
Type	Constant value: `String`	This field controls the type, it must be set to the constant value "String" to function as this type.
Required	`Boolean` defaults to: `true`
Id	`String`
Default	(Nullable) `String`

BrushOrigin

(Nullable) Any one of the following String:

Name	Description
`"Center"`
`"Bottom"`
`"Top"`
`"Lowest"`
`"Highest"`

BrushShape

(Nullable) Any one of the following String:

Name	Description
`"Cube"`
`"Sphere"`
`"Cylinder"`
`"Cone"`
`"InvertedCone"`
`"Pyramid"`
`"InvertedPyramid"`
`"Dome"`
`"InvertedDome"`
`"Diamond"`
`"Torus"`

Map

Map of the following:

Key Type

any String

StaticModifier

StaticModifier with the following properties:

Key	Type	Description
Id	Constant value: `Static`	This field controls the type, it must be set to the constant value "Static" to function as this type.
Target	(Nullable) ModifierTarget
CalculationType	CalculationType
Amount	(Nullable) Either `Number` defaults to: `0.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

ModifierTarget

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

Name	Description
`"Min"`
`"Max"`

CalculationType

Any one of the following String:

Name	Description
`"Additive"`
`"Multiplicative"`

InteractionPriority

Map of the following:

Key	Type	Description
Default	`Integer`
MainHand	`Integer`
OffHand	`Integer`

FloatRange

Fixed size array of the following:

Type
Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`
Either `Number` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`

ValueType

Any one of the following String (defaults to Absolute):

Name	Description
`"Percent"`
`"Absolute"`

On this page