HytaleDocs
Item

Interactions

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

This object has different properties depending on the value of the Type property.

All possible options are listed below:

AddItem

Adds an item to the users inventory.

AddItemInteraction with the following properties:

KeyTypeDescription
TypeConstant value: AddItem

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

ItemIdString

Reference to a Item asset

The id of the item to add.

QuantityInteger defaults to: 0

The amount of the item to add.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ApplyAbilityEffects

Applies the ability's own effects to the target entity: one of Effects per application (the first the target does not carry, else the one closest to expiring, so several entries act as stacks). Rune on-hit effects apply automatically with the ability's damage; set RuneEffects only on a hit that deals no damage.

ApplyAbilityEffectsInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ApplyAbilityEffects

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) Array of String

Reference to a EntityEffect asset

Optional EntityEffect ids, one per stack. Each entry is an independent stack with its own duration; author as many entries as the debuff has stacks.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

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

Duration in seconds of the applied stack. When absent or 0 the effect's own duration applies. Rune effects always use their own duration.

DurationAttribute(Nullable) String

Name of an ability attribute (e.g. Duration) that replaces Duration when the ability's resolved attributes are in context.

RuneEffectsBoolean defaults to: false

Also apply the on-hit effects support runes injected into the ability. Only for a hit that deals no damage: damaging hits apply them automatically, and setting this there applies them twice.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ApplyEffect

Applies the given entity effect to the entity.

ApplyEffectInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ApplyEffect

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EffectIdEither String or EntityEffect

Reference to a EntityEffect asset

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

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

Overrides the effect asset's duration, in seconds. 0 or absent keeps the asset's duration.

DurationAttribute(Nullable) String

Name of the impact attribute (e.g. Duration) that provides this effect's duration when the acting entity carries resolved attributes, e.g. from ability support runes.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ApplyForce

ApplyForceInteraction

AttachBeam

AttachBeamInteraction with the following properties:

KeyTypeDescription
TypeConstant value: AttachBeam

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

TargetEntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

BeamConfigEither String or Beam

Reference to a Beam asset

The beam configuration asset to use.

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

The name of the model node the beam should attach to on the source entity.

TargetNodeName(Nullable) String

The name of the model node the beam should attach to on the target entity.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

AugmentCondition

An interaction that is successful while every required tag is granted by augment blocks around the target block.

AugmentConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: AugmentCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

RequiredAugmentTagsArray of String
RadiusNumber defaults to: 100.0
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Bed

Interact with a bed block, ostensibly to sleep in it.

BedInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Bed

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

BlockCondition

Tests the target block and executes Next if it matches all the conditions, otherwise Failed is run.

BlockConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: BlockCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Matchers(Nullable) Array of the type:
BlockMatcher

BlockMatcher with the following properties:

KeyTypeDescription
Block(Nullable) BlockIdMatcher

Match against block values

Face(Nullable) BlockFace

Match against a specific block face.

StaticFaceBoolean defaults to: false

Whether the face matching is unaffected by the block rotation or not.

The matchers to test the block against.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

BreakBlock

Attempts to break the target block.

BreakBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: BreakBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

HarvestBoolean defaults to: false

Whether this should trigger as a harvest gather vs a break gather.

SoftOnlyBoolean defaults to: false

Whether this can only break soft blocks, whatever the breaking entity holds.

Tool(Nullable) String

Tool to break as.

MatchToolBoolean defaults to: false

Whether to require an match to Tool to work.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

BuilderTool

Runs a builder tool

BuilderToolInteraction with the following properties:

KeyTypeDescription
TypeConstant value: BuilderTool

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Camera

Adjusts the camera of the user.

CameraInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Camera

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

PersistCameraStateBoolean defaults to: false

Should the camera state from this interaction persist to the next camera interaction. If the next interaction is null or not a camera interaction then this field does nothing.

Action(Nullable) Any one of the following String:
CameraActionType
NameDescription
"ForcePerspective"
"Orbit"
"Transition"

What kind of camera action should we take

Perspective(Nullable) Any one of the following String:
CameraPerspectiveType
NameDescription
"First"
"Third"

What camera perspective we want this interaction to take place in

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

How long this camera action lasts for

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CameraShake

Triggers a camera shake effect on use.

CameraShakeInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CameraShake

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

CameraEffectEither String or CameraEffect

Reference to a CameraEffect asset

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CanBreakRespawnPoint

CanBreakRespawnPointInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CanBreakRespawnPoint

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CancelChain

Cancels an active chaining state for the given chain id.

CancelChainInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CancelChain

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ChainIdString

The ID of the chain to cancel.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CarryBlock

Carry the block being interacted with.

CarryBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CarryBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

EntityEffectId(Nullable) Either String or EntityEffect

Reference to a EntityEffect asset

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CarryDroppedBlock

Carry the dropped block entity being interacted with.

CarryDroppedBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CarryDroppedBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CarryPlaceBlock

Places the block currently being carried, restoring its block entity data.

CarryPlaceBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CarryPlaceBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChainFlag

Sets a flag on the given chain id that a Chaining interaction can optionally use to adjust what it'll execute.

ChainFlagInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChainFlag

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ChainIdString
FlagString
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Chaining

Runs one of the entries in Next based on how many times this interaction was run before the ChainingAllowance timer was reset.

ChainingInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Chaining

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

ChainingAllowanceNumber defaults to: 0.0

Time in seconds that the user has to run this interaction again in order to hit the next chain entry. Resets the timer each time the interaction is reached.

NextArray of the type: Either String or Interaction

Reference to a Interaction asset

ChainId(Nullable) String
Flags(Nullable) Map of the following:
Map
KeyType
any StringEither String or Interaction

Reference to a Interaction asset

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChangeActiveSlot

Changes the active hotbar slot for the user of the interaction.

ChangeActiveSlotInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChangeActiveSlot

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

TargetSlotInteger
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChangeBlock

Changes the target block to another block based on the block types provided.

ChangeBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChangeBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Changes(Nullable) Map of the following:
Map

A map of the target block to the new block.

When the interaction runs it will look for the block that was interacted with in this map and if found it will replace it with specified block

WorldSoundEventId(Nullable) String

Reference to a SoundEvent asset

Sound event to play at the block location on block change.

RequireNotBrokenBoolean defaults to: false

If true, the interaction will fail if the held item is broken (durability = 0).

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChangeFarmingStage

Changes the farming stage of the target block.

ChangeFarmingStageInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChangeFarmingStage

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

StageInteger defaults to: -1

The stage index to set (0, 1, 2, etc.). Use -1 for the final stage. Ignored if Increase is set.

IncreaseInteger

Add this amount to the current stage (e.g., 1 = advance one stage, 2 = advance two stages). Takes priority over Decrease and Stage.

DecreaseInteger

Subtract this amount from the current stage (e.g., 1 = go back one stage). Takes priority over Stage.

StageSet(Nullable) String

Optional. The stage set to switch to (e.g., 'Default', 'Harvested'). If not provided, uses current stage set.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChangeStat

Changes the given stats.

ChangeStatInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChangeStat

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

StatModifiers(Nullable) Map of the following:
Map of string to float

Modifiers to apply to EntityStats. Omittable only when the interaction resolves its modifiers elsewhere (e.g. UseAbilityCost); without either the interaction does nothing.

ValueType(Nullable) Any one of the following String (defaults to Absolute):
ValueType
NameDescription
"Percent"
"Absolute"

Enum to specify if the StatModifiers must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.

Behaviour(Nullable) Any one of the following String (defaults to Add):
ChangeStatBehaviour
NameDescription
"Add"

Adds the value to the stat

"Set"

Changes the stat to the given value

"Min"

Lowers the stat to the given value, leaving it unchanged if already at or below it

"Max"

Raises the stat to the given value, leaving it unchanged if already at or above it

Specifies how StatModifiers should be applied to the stats.

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

UseAbilityCostBoolean defaults to: false

Spend the casting ability's declared Cost/CostType (negated) instead of an authored StatModifiers map, so the ability item stays the single source. An ability without a cost spends nothing. Only meaningful in ability cast chains.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChangeStatWithModifier

Changes the given stats.

ChangeStatWithModifierInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChangeStatWithModifier

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

StatModifiers(Nullable) Map of the following:
Map of string to float

Modifiers to apply to EntityStats. Omittable only when the interaction resolves its modifiers elsewhere (e.g. UseAbilityCost); without either the interaction does nothing.

ValueType(Nullable) Any one of the following String (defaults to Absolute):
ValueType
NameDescription
"Percent"
"Absolute"

Enum to specify if the StatModifiers must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.

Behaviour(Nullable) Any one of the following String (defaults to Add):
ChangeStatBehaviour
NameDescription
"Add"

Adds the value to the stat

"Set"

Changes the stat to the given value

"Min"

Lowers the stat to the given value, leaving it unchanged if already at or below it

"Max"

Raises the stat to the given value, leaving it unchanged if already at or above it

Specifies how StatModifiers should be applied to the stats.

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

InteractionModifierIdAny one of the following String:
InteractionModifierId
NameDescription
"Dodge"
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ChangeState

Changes the state of the target block to another state based on the mapping provided.

ChangeStateInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ChangeState

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Changes(Nullable) Map of the following:
Map
KeyType
any StringString

The map of state changes to execute. "default" can be used for the initial state of a block.

UpdateBlockStateBoolean defaults to: false
RequireBlockPlacementBoolean defaults to: false

When set, the state change is treated as a block placement and only runs in worlds where block placement is allowed.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Charging

An interaction that holds until the key is released (or a time limit is reached) and executes different interactions based on how long the key was pressed.

ChargingInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Charging

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

FailOnDamageBoolean defaults to: false

Whether the interaction will be cancelled and the item removed when the entity takes damage

CancelOnOtherClickBoolean defaults to: true
Forks(Nullable) Map of the following:
Map of InteractionType
KeyTypeDescription
PrimaryEither String or RootInteraction

Reference to a RootInteraction asset

SecondaryEither String or RootInteraction

Reference to a RootInteraction asset

Ability1Either String or RootInteraction

Reference to a RootInteraction asset

Ability2Either String or RootInteraction

Reference to a RootInteraction asset

Ability3Either String or RootInteraction

Reference to a RootInteraction asset

Ability4Either String or RootInteraction

Reference to a RootInteraction asset

UseEither String or RootInteraction

Reference to a RootInteraction asset

PickEither String or RootInteraction

Reference to a RootInteraction asset

PickupEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEnterEither String or RootInteraction

Reference to a RootInteraction asset

CollisionLeaveEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEither String or RootInteraction

Reference to a RootInteraction asset

EntityStatEffectEither String or RootInteraction

Reference to a RootInteraction asset

SwapToEither String or RootInteraction

Reference to a RootInteraction asset

SwapFromEither String or RootInteraction

Reference to a RootInteraction asset

DeathEither String or RootInteraction

Reference to a RootInteraction asset

WieldingEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileSpawnEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileHitEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileMissEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileBounceEither String or RootInteraction

Reference to a RootInteraction asset

HeldEither String or RootInteraction

Reference to a RootInteraction asset

HeldOffhandEither String or RootInteraction

Reference to a RootInteraction asset

EquippedEither String or RootInteraction

Reference to a RootInteraction asset

DodgeEither String or RootInteraction

Reference to a RootInteraction asset

GameModeSwapEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakImpactEither String or RootInteraction

Reference to a RootInteraction asset

A collection of interactions to fork into when the input associated with the interaction type is used.

For example listing a Primary interaction type here with interactions will allow the user to press the input tied to the Primary interaction type whilst holding the input used to run the current interaction to run the specified interactions. e.g. Having a shield that you can hold Secondary to block and whilst blocking press Primary to shield bash.

This does not cancel the current interaction when triggered but the CancelOnOtherClick check will still run and may cancel the interaction.

The existing forks will continue to run even if this interaction ends.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

IgnoreForFlaggedConditionsBoolean defaults to: false

An override flag that can be used by Conditions to determine whether to ignore this interaction.

AllowIndefiniteHoldBoolean defaults to: false
DisplayProgressBoolean defaults to: true
Next(Nullable) Map of the following:
Map
KeyType

A string that contains any floating point number

Either String or Interaction

Reference to a Interaction asset

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

What is the target modifier to apply to mouse sensitivity while this interaction is active.

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

Override the global linear modifier adjustment with this as the time to go from 1.0 to 0.0.

Delay(Nullable)
ChargingDelay

ChargingDelay with the following properties:

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

The smallest amount of delay that can be applied.

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

The largest amount of delay that can be applied.

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

The max amount of delay applied during this interaction before any additional delay is ignored.

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

The amount of health (as a percentage between 1.0 and 0.0) where if the user's health is below the value then the delay wont be applied.

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

The amount of health (as a percentage between 1.0 and 0.0) where if the user's health is above the value then the delay will be capped.

Settings that allow for delaying the charging interaction on damage.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CheckUniqueItemUsage

CheckUniqueItemUsageInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CheckUniqueItemUsage

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ClearCarriedBlock

Clears the block currently being carried, discarding it without placing or dropping it.

ClearCarriedBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ClearCarriedBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ClearEntityEffect

Removes the given entity effect from the given entity.

ClearEntityEffectInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ClearEntityEffect

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EntityEffectIdString

Reference to a EntityEffect asset

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Condition

An interaction that is successful if the given conditions are met.

ConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Condition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

RequiredGameMode(Nullable) Any one of the following String:
GameMode
NameDescription
"Adventure"

The normal gamemode for players playing the game.

"Creative"

Makes the player invulnerable and grants them the ability to fly.

JumpingBoolean
SwimmingBoolean
CrouchingBoolean
RunningBoolean
FlyingBoolean

Whether the entity can be flying.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ContextualUseNPC

Interacts with the target NPC passing in context for it to use.

ContextualUseNPCInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ContextualUseNPC

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ContextString

The provided context for the use action.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CooldownCondition

Checks if a given cooldown is complete.

CooldownConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CooldownCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

IdString

The ID of the cooldown to check for in this condition.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

CycleBlockGroup

Attempts to cycle the target block through its block set.

CycleBlockGroupInteraction with the following properties:

KeyTypeDescription
TypeConstant value: CycleBlockGroup

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

DamageEntity

Damages the target entity.

DamageEntityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: DamageEntity

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

DamageCalculator(Nullable)
DamageCalculator

DamageCalculator with the following properties:

KeyTypeDescription
Type(Nullable) Type
ClassDamageClass

The class of the damage being created, used by the damage system to apply modifiers based on equipment of the source.

BaseDamage(Nullable) Map of string to float
SequentialModifierStep(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
SequentialModifierMinimum(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RandomPercentageModifier(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DamageEffects(Nullable)
DamageEffects

DamageEffects with the following properties:

KeyTypeDescription
ModelParticles(Nullable) Array of the type: ModelParticle
WorldParticles(Nullable) Array of the type: WorldParticle
LocalSoundEventId(Nullable) String

Reference to a SoundEvent asset

WorldSoundEventId(Nullable) String

Reference to a SoundEvent asset

PlayerSoundEventId(Nullable) String

Reference to a SoundEvent asset

The sound to play to a player receiving the damage.

ViewDistanceNumber defaults to: 75.0
Knockback(Nullable) Type Selector
CameraEffect(Nullable) Either String or CameraEffect

Reference to a CameraEffect asset

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

A multiplier to apply to any stamina drain caused by this damage.

DamageAttribute(Nullable) String

Name of an ability attribute (e.g. Damage) that uniformly scales the calculated damage when the acting entity carries resolved attributes (e.g. a damage support rune). Leave absent to keep authored damage.

AngledDamage(Nullable) Array of the type:
AngledDamage

AngledDamage with the following properties:

KeyTypeDescription
DamageCalculator(Nullable) DamageCalculator
TargetEntityEffects(Nullable) Map
DamageEffects(Nullable) DamageEffects
Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Angle(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
AngleDistance(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
TargetedDamageMap of the following:
Map
KeyType
any StringTargetedDamage
EntityStatsOnHit(Nullable) Array of the type:
EntityStatOnHit

EntityStatOnHit with the following properties:

KeyTypeDescription
EntityStatIdString

Reference to a EntityStatType asset

The id of the EntityStat that will be affected by the interaction.

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

The base amount for a single entity hit.

MultipliersPerEntitiesHit(Nullable) Array of Number

An array of multipliers corresponding to how much the amount should be multiplied by for each entity hit.

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

When the number of entity hit is higher than the number of multipliers defined, the amount will be multiplied by this multiplier for each extra entity hit.

EntityStats to apply based on the hits resulting from this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Blocked(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

DestroyBlock

Destroys the target block.

DestroyBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: DestroyBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

DestroyTaggedVolumes

Destroys all trigger volumes with a given tag within a radius of the target point.

DestroyTaggedVolumesInteraction with the following properties:

KeyTypeDescription
TypeConstant value: DestroyTaggedVolumes

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

MatchKey(Nullable) String
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Door

Opens/Closes a door

DoorInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Door

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

HorizontalBoolean defaults to: false

Whether the door is horizontal (e.g. gates) or vertical (e.g. regular doors).

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

DragEraseBlock

Erases the targeted block while the click is held, speeding up the longer the input is held.

DragEraseBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: DragEraseBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ForkInteractionsEither String or RootInteraction

Reference to a RootInteraction asset

The interactions to run for each committed block.

MaxBlocksPerTickInteger defaults to: 4

The maximum number of block forks started per tick. Demand beyond this queues and drains at this rate.

MaxBlocksPerGestureInteger defaults to: 512

The maximum number of blocks a single gesture may commit. The chain fails when a client exceeds it.

ValidateForkPositionsBoolean defaults to: true

Validates that each committed block position is plausible for the gesture's geometry, rejecting the placement otherwise.

MaxForkPositionViolationsInteger defaults to: 8

The number of rejected block positions a single gesture tolerates before the chain fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

DragPlaceBlock

Places a sequence of blocks while the click is held, forking the given interactions once per committed block. Each fork carries its own block position and is validated independently at the tick it runs.

DragPlaceBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: DragPlaceBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ForkInteractionsEither String or RootInteraction

Reference to a RootInteraction asset

The interactions to run for each committed block.

MaxBlocksPerTickInteger defaults to: 4

The maximum number of block forks started per tick. Demand beyond this queues and drains at this rate.

MaxBlocksPerGestureInteger defaults to: 512

The maximum number of blocks a single gesture may commit. The chain fails when a client exceeds it.

ValidateForkPositionsBoolean defaults to: true

Validates that each committed block position is plausible for the gesture's geometry, rejecting the placement otherwise.

MaxForkPositionViolationsInteger defaults to: 8

The number of rejected block positions a single gesture tolerates before the chain fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

DurabilityCondition

Gates the interaction chain on the held item's durability.

DurabilityConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: DurabilityCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

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

Durability value to compare against. Interpreted as Absolute (raw durability) or Percent (durability/maxDurability * 100) per ValueType.

ValueType(Nullable) Any one of the following String (defaults to Absolute):
ValueType
NameDescription
"Percent"
"Absolute"

Whether Threshold is interpreted as an Absolute durability value or a Percent of MaxDurability. Default: Absolute.

Operator(Nullable) Any one of the following String (defaults to LessOrEqual):
ComparisonOperator
NameDescription
"LessThan"
"LessOrEqual"
"GreaterThan"
"GreaterOrEqual"
"Equal"
"NotEqual"

How to compare the item's durability to Threshold. Default: LessOrEqual (succeeds when durability <= Threshold). Choices: LessThan, LessOrEqual, GreaterThan, GreaterOrEqual, Equal, NotEqual.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

EffectCondition

An interaction that is successful if the given effects exist (or don't) on the target entity.

EffectConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: EffectCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EntityEffectIdsArray of String

Reference to a EntityEffect asset

Match(Nullable) Any one of the following String (defaults to All):
Match
NameDescription
"All"
"None"

Field to specify whether the entity must have the specified effects (All), or must not have the specified effects (None). Default value is: All.

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

EquipItem

Equips the item being held.

EquipItemInteraction with the following properties:

KeyTypeDescription
TypeConstant value: EquipItem

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

EventStartInteraction

An interaction that starts a world-event in the current world.

EventStartInteraction with the following properties:

KeyTypeDescription
TypeConstant value: EventStartInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Event(Nullable)
WorldEventRecord

WorldEventRecord with the following properties:

KeyTypeDescription
Id(Nullable) String

The UUID to assign to the world-event. Can be omitted if the event is transient and not intended to be unique.

EventEither String or WorldEventAsset

Reference to a WorldEventAsset asset

The asset to create the world-event from.

TransientBoolean defaults to: false

The event is not recorded after completion, allowing it to run again in future.

The world-event to start.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

EventStopInteraction

An interaction that stops a world-event in the current world.

EventStopInteraction with the following properties:

KeyTypeDescription
TypeConstant value: EventStopInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

EventString

The UUID of the world-event to stop.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ExitInstance

Teleports the Entity out of the current Instance and places them at their set return point.

ExitInstanceInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ExitInstance

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Explode

Performs an explosion using the provided config.

ExplodeInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Explode

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ConfigExplosionConfig

The explosion config associated with this projectile.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ExtrudePlaceBlock

Extrudes the targeted block face while the click is held, placing one layer per depth step. Pulling back erases the streamed layers again.

ExtrudePlaceBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ExtrudePlaceBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ForkInteractionsEither String or RootInteraction

Reference to a RootInteraction asset

The interactions to run for each committed block.

MaxBlocksPerTickInteger defaults to: 4

The maximum number of block forks started per tick. Demand beyond this queues and drains at this rate.

MaxBlocksPerGestureInteger defaults to: 512

The maximum number of blocks a single gesture may commit. The chain fails when a client exceeds it.

ValidateForkPositionsBoolean defaults to: true

Validates that each committed block position is plausible for the gesture's geometry, rejecting the placement otherwise.

MaxForkPositionViolationsInteger defaults to: 8

The number of rejected block positions a single gesture tolerates before the chain fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

FertilizeSoil

If the target block is farmable then set it to fertilized.

FertilizeSoilInteraction with the following properties:

KeyTypeDescription
TypeConstant value: FertilizeSoil

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

RefreshModifiers(Nullable) Array of String
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

FirstClick

An interaction that runs a different interaction based on if this chain was from a click or due to the key being held down.

FirstClickInteraction with the following properties:

KeyTypeDescription
TypeConstant value: FirstClick

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Click(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if this chain was initiated by a click.

Held(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if this chain was initiated by holding down the key.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

GameFlagCondition

An interaction that is successful while the given game flag is at least (or exactly) the given level.

GameFlagConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: GameFlagCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

KeyString
LevelInteger defaults to: 1
ExactBoolean defaults to: false

Whether the flag must equal the level instead of being at least the level.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

GlobalEventStartInteraction

An interaction that starts a global world-event in all worlds that are configured to run it.

GlobalEventStartInteraction with the following properties:

KeyTypeDescription
TypeConstant value: GlobalEventStartInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

IdString

The UUID of the world-event to start, as defined in the world's GameplayConfig.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

GlobalEventStopInteraction

An interaction that stops a global world-event in all worlds that are configured to run it.

GlobalEventStopInteraction with the following properties:

KeyTypeDescription
TypeConstant value: GlobalEventStopInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

IdString

The UUID of the world-event to stop, as defined in the world's GameplayConfig.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

GrantAbilityCharges

Applies a buff effect to the caster and arms ability charges: while the effect is active, each firing of Trigger spends a charge and runs PerActivationInteraction on the caster with the cast's rune values in context.

GrantAbilityChargesInteraction with the following properties:

KeyTypeDescription
TypeConstant value: GrantAbilityCharges

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EffectString

The EntityEffect applied to the caster; the charges live and die with it.

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

Buff duration in seconds. When absent or 0 the effect's own duration applies.

DurationAttribute(Nullable) String

Name of an ability attribute (e.g. Duration) that replaces Duration when the cast carries resolved attributes.

Trigger(Nullable) Any one of the following String (defaults to OnPrimaryActivation):
AbilityChargeTrigger
NameDescription
"OnPrimaryActivation"
"OnHit"

What spends a charge. OnPrimaryActivation: a weapon attack is released (a melee attack starts, a bow or crossbow shot leaves), hit or miss, the interaction runs with no target. OnHit: a weapon attack lands (melee hit, bow or crossbow arrow), the interaction runs with the victim as target entity.

MaxChargesInteger defaults to: 0

How many activations before the buff ends. Absent or 0 means unlimited: the buff lasts its full duration.

PerActivationInteractionEither String or RootInteraction

Reference to a RootInteraction asset

Root interaction run on the caster at each activation, server-simulated: a single node or several (delays, sounds, particles, LaunchAbilityProjectile, ApplyAbilityEffects). Its nodes resolve the cast's attributes, and an OnHit activation exposes the victim as target entity. Author inline ({ "Interactions": [...] }) or point at a Root_ asset.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

GroundedCondition

Fails the chain unless the caster stands on ground (or within Tolerance blocks above it). Author the fail feedback on Failed. Swimming, climbing and falling all fail.

GroundedConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: GroundedCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

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

Also pass when solid ground is within this many blocks below the caster's feet. 0 = strict on-ground only.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

HarvestCrop

Harvests the resources from the target farmable block.

HarvestCropInteraction with the following properties:

KeyTypeDescription
TypeConstant value: HarvestCrop

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

RequireNotBrokenBoolean defaults to: false

If true, the interaction will fail if the held item is broken (durability = 0).

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

HubPortal

Teleports the Player to a permanent world, creating it if required.

HubPortalInteraction with the following properties:

KeyTypeDescription
TypeConstant value: HubPortal

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

WorldNameString

The name of the permanent world to teleport to.

WorldGenType(Nullable) String

The world generator type to use when creating the world (e.g., 'Flat', 'Hytale'). Mutually exclusive with InstanceTemplate.

InstanceTemplate(Nullable) String

Instance asset to use as template for creating the permanent world. Mutually exclusive with WorldGenType.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

IncreaseBackpackCapacity

Set the player's backpack capacity to a target value, gated on the player's current capacity matching the configured "From" value (so upgrades must be used in order).

IncreaseBackpackCapacityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: IncreaseBackpackCapacity

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

FromInteger defaults to: 0

Required current backpack capacity for this upgrade to apply. Enforces strict upgrade ordering — the upgrade is rejected when the player's current capacity does not equal this value.

CapacityInteger defaults to: 1

Target backpack capacity to set when the upgrade applies. Must be greater than "From".

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

IncrementCooldown

Increase the given cooldown.

IncrementCooldownInteraction with the following properties:

KeyTypeDescription
TypeConstant value: IncrementCooldown

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Id(Nullable) String

The ID of the cooldown to increment

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

The amount of time to increase the current cooldown time by

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

The amount of time to increase the current charge time by

ChargeInteger defaults to: 0

The amount of empty charges to recharge

InterruptRechargeBoolean defaults to: false

Determines whether the recharge of this cooldown should be interrupted

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Interrupt

Interrupts interactions on the target entity.

InterruptInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Interrupt

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

InterruptTypes(Nullable) Array of the type: Any one of the following String:
InteractionType
NameDescription
"Primary"
"Secondary"
"Ability1"
"Ability2"
"Ability3"
"Ability4"
"Use"
"Pick"
"Pickup"
"CollisionEnter"
"CollisionLeave"
"Collision"
"EntityStatEffect"
"SwapTo"
"SwapFrom"
"Death"
"Wielding"
"ProjectileSpawn"
"ProjectileHit"
"ProjectileMiss"
"ProjectileBounce"
"Held"
"HeldOffhand"
"Equipped"
"Dodge"
"GameModeSwap"
"OnBreak"
"OnBreakImpact"

A set of interaction types that this interrupt will cancel

RequiredTag(Nullable) String

The tag that the root interaction of an active interaction chain must have to be interrupted. If not set then no tag is required.

ExcludedTag(Nullable) String

The tag that if the root interaction of an active interaction chain has then it will not be interrupted.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

LaunchAbilityProjectile

Launches a server-side projectile along the caster's look. Its hit chain runs where it lands; with Pierce it flies through entities (hit chain per entity crossed) and its miss chain runs once where its course ends.

LaunchAbilityProjectileInteraction with the following properties:

KeyTypeDescription
TypeConstant value: LaunchAbilityProjectile

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ProjectileString

The ProjectileConfig to launch.

IgnorePitchBoolean defaults to: false

Whether to ignore the caster's look pitch and fire level with the ground (e.g. a ground wave).

PierceBoolean defaults to: false

Whether the projectile flies through entities, running its hit chain once per entity crossed. Distance applies only when set.

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

Piercing only: how far the projectile travels before ending its course.

SizeAttribute(Nullable) String

Name of an ability attribute that scales Distance when the cast carries resolved attributes. Rarely wanted: AoE means the ability's size, not its travel.

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

Maximum flight time in seconds. A piercing projectile ends its course (and runs its miss chain) there; any other projectile silently despawns, bounding its range.

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

Base uniform scale of the projectile's model and hit volume (default 1).

ScaleAttribute(Nullable) String

Name of an ability attribute (e.g. AoeScale) that multiplies Scale when the cast carries resolved attributes.

SpeedAttribute(Nullable) String

Name of an ability attribute (e.g. Speed) that multiplies the ProjectileConfig's LaunchForce when the cast carries resolved attributes.

SpectralBoolean defaults to: false

Whether the projectile flies through blocks. When false, an obstacle stops the flight: a piercing projectile ends its course there (and runs the miss chain), any other projectile impacts it.

TrailParticles(Nullable) String

Optional one-shot particle system burst at the projectile's position while it travels, painting its path (e.g. a ground crack). Bursts tint by the cast's element conversion when one applies.

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

Seconds between trail particle bursts.

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

Base scale of the trail particle bursts, multiplied by the projectile's resolved scale (e.g. an AoE rune).

TrailColor(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

Base tint of the trail bursts, for greyscale (_GS) particle textures. An element conversion overrides it with the element's color.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

LaunchPad

Applies the launchpad forces.

LaunchPadInteraction with the following properties:

KeyTypeDescription
TypeConstant value: LaunchPad

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

LaunchProjectile

Launches a projectile.

LaunchProjectileInteraction with the following properties:

KeyTypeDescription
TypeConstant value: LaunchProjectile

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ProjectileIdString

Reference to a Projectile asset

IgnorePitchBoolean defaults to: false

If true, the shooter's pitch is set to 0 before the launch direction is computed, so the projectile's pitch is fixed by RotationOffset.

IgnoreYawBoolean defaults to: false

If true, the shooter's yaw is set to 0 before the launch direction is computed, so the projectile's yaw is fixed by RotationOffset.

IgnoreRollBoolean defaults to: false

If true, the shooter's roll is set to 0 before the launch direction is computed, so the projectile's roll is fixed by RotationOffset.

RotationOffset
Direction

Direction with the following properties:

KeyTypeDescription
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)$

A fixed rotation offset (in degrees) added to the launch rotation after any ignored axes are zeroed.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

LearnRecipe

Causes the user to learn the given recipe.

LearnRecipeInteraction with the following properties:

KeyTypeDescription
TypeConstant value: LearnRecipe

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ItemId(Nullable) String
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

MemoriesCondition

MemoriesConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: MemoriesCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

NextMap of the following:
Map
KeyType

A string that contains any integer

Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player's memories level matches the key.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player's memories level does not match any key.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ModifyIntervalConditionInteraction

An interaction that can be used to modify the interval timer on a world-event. Does nothing if the interval time has already elapsed.

ModifyIntervalConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ModifyIntervalConditionInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Event(Nullable) String

The UUID of the world-event to modify the interval on. May be omitted if the world-event can be derived from any of the entities involved in the interaction context.

IntervalKeyString

The variable name of the interval that this interaction should modify.

ModifierEither
StaticModifier

StaticModifier with the following properties:

KeyTypeDescription
IdConstant value: Static

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

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

StaticModifier with the following properties:

KeyTypeDescription
IdConstant value: Static

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

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

The modifier to apply to the target interval's timer, in seconds. Does nothing if the interval time has already elapsed.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ModifyInventory

Modifies an item in the inventory.

ModifyInventoryInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ModifyInventory

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

RequiredGameMode(Nullable) Any one of the following String:
GameMode
NameDescription
"Adventure"

The normal gamemode for players playing the game.

"Creative"

Makes the player invulnerable and grants them the ability to fly.

ItemToRemove(Nullable)
ItemStack

ItemStack with the following properties:

KeyTypeDescription
IdString

Reference to a Item asset

QuantityInteger defaults to: 1
DurabilityNumber defaults to: 0.0
MaxDurabilityNumber defaults to: 0.0
QualityOverrideInteger
Metadata(Nullable) Type 0
OverrideDroppedItemAnimationBoolean defaults to: false
AdjustHeldItemQuantityInteger defaults to: 0
ItemToAdd(Nullable)
ItemStack

ItemStack with the following properties:

KeyTypeDescription
IdString

Reference to a Item asset

QuantityInteger defaults to: 1
DurabilityNumber defaults to: 0.0
MaxDurabilityNumber defaults to: 0.0
QualityOverrideInteger
Metadata(Nullable) Type 0
OverrideDroppedItemAnimationBoolean defaults to: false
AdjustHeldItemDurabilityNumber defaults to: 0.0
BrokenItem(Nullable) String
NotifyOnBreakBoolean

If true, shows the 'item broken' message and plays the break sound when durability reaches 0. Defaults to true for tools (no BrokenItem or same item), false for transformations (different BrokenItem).

NotifyOnBreakMessage(Nullable) String

Custom translation key for the break notification message. Supports {itemName} parameter. Defaults to 'server.general.repair.itemBroken' if not specified.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Mount

MountInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Mount

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

AttachmentOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ControllerAny one of the following String:
MountController
NameDescription
"Minecart"
"BlockMount"
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

MovementCondition

An interaction that runs different interactions based on the movement the user is current performing.

MovementConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: MovementCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Forward(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving forward.

Back(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving backwards.

Left(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving left.

Right(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving right.

ForwardLeft(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving forward and left.

ForwardRight(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving forward and right.

BackLeft(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving backwards and left.

BackRight(Nullable) Either String or Interaction

Reference to a Interaction asset

The interaction to run if the player is moving backwards and right.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenAbilityBench

Opens the ability bench for the using player, over their own ability slots. Author as any block's Use interaction to make that block the bench.

OpenAbilityBenchInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenAbilityBench

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenBenchPage

Opens the given crafting bench page.

OpenBenchPageInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenBenchPage

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

PageAny one of the following String (defaults to SimpleCrafting):
PageType
NameDescription
"SimpleCrafting"
"DiagramCrafting"
"StructuralCrafting"
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenChapterRewards

Opens the chapter rewards page on the client, then runs one of two root interactions with what the player answered. Set RequireNewClick on the root that holds it, or holding the interact key opens the page again.

OpenChapterRewardsInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenChapterRewards

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ChapterIdString that matches the pattern: [^\s] and is at least 1 characters long

The id of the chapter whose rewards the page shows. The client holds the chapter data, the server only relays this id.

SuccessEither String or RootInteraction

Reference to a RootInteraction asset

The root interaction to run when the player takes the page's main action. It runs on the block the player pressed the interact key on, so block interactions such as PortalReturn work here. It carries no target entity. Author it inline ({ "Interactions": [...] }) or point at a Root_ asset.

Fail(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

The root interaction to run when the player keeps playing or dismisses the page. It runs on the same block as Success. Leave it out to run nothing.

TitleKeyString that matches the pattern: [^\s] and is at least 1 characters long

Localization key for the page title.

SubtitleKeyString that matches the pattern: [^\s] and is at least 1 characters long

Localization key for the line under the title.

LeaveKeyString that matches the pattern: [^\s] and is at least 1 characters long

Localization key for the label of the button that runs Success.

StayKeyString that matches the pattern: [^\s] and is at least 1 characters long

Localization key for the label of the button that runs Fail.

ShowRewardsBoolean defaults to: true

Whether the page lists the chapter's reward tiles. Defaults to true. Set it to false to show only the text and the two buttons.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenContainer

Opens the container of the block currently being interacted with.

OpenContainerInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenContainer

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenCustomUI

Opens a custom ui page.

OpenCustomUIInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenCustomUI

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

PageType Selector (1)
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenItemStackContainer

Opens a container contained within the current held item.

OpenItemStackContainerInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenItemStackContainer

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenPage

Opens a predefined page.

OpenPageInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenPage

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

PageAny one of the following String:
Page
NameDescription
"None"
"Bench"
"Inventory"
"ToolsSettings"
"Map"
"MachinimaEditor"
"ContentCreation"
"Custom"
"Serverside"
"Chapters"
"ChapterRewards"
CanCloseThroughInteractionBoolean defaults to: false
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

OpenProcessingBench

Opens the processing bench page.

OpenProcessingBenchInteraction with the following properties:

KeyTypeDescription
TypeConstant value: OpenProcessingBench

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Parallel

Runs the provided interactions in parallel to this interaction chain.

ParallelInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Parallel

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

InteractionsArray of the type: Either String or RootInteraction

Reference to a RootInteraction asset

The collection of interaction roots to run in parallel via forks.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PickBlock

Performs a 'block pick', moving a the target block to the user's hand if they have it in their inventory or are in creative.

PickBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PickBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PickupItem

Picks up an item entity and adds it to the player's inventory.

PickupItemInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PickupItem

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PlaceBlock

Places the current or given block.

PlaceBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PlaceBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

BlockTypeToPlace(Nullable) String

Reference to a BlockType asset

Overrides the placed block type of the held item with the provided block type.

RemoveItemInHandBoolean defaults to: true

Determines whether to remove the item that is in the instigating entities hand.

QuickReplaceBoolean defaults to: false

Replaces the targeted block without requiring it to be broken first. Only honored for players in Creative.

QuickRetypeBoolean defaults to: false

Swaps the targeted block to the held block type while keeping its shape and rotation. Only honored for players in Creative.

NoPhysicsBoolean defaults to: false

Suppresses block physics updates for the placement. Only honored for players in Creative.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PlaceFluid

Places the current or given block.

PlaceFluidInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PlaceFluid

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

FluidToPlace(Nullable) String

Reference to a Fluid asset

RemoveItemInHandBoolean defaults to: true
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PlaceModeSelect

Runs the interactions for the player's active creative place mode. Players outside Creative always run the Default branch.

PlaceModeSelectInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PlaceModeSelect

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

DefaultInteractionsEither String or Interaction

Reference to a Interaction asset

The interactions to run for the default place mode, non-Creative players, and any mode without its own branch.

ReplaceInteractions(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run for the quick replace place mode.

RetypeInteractions(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run for the quick retype place mode.

ExtrudeInteractions(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run for the extrude place mode.

SurfaceDrawInteractions(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run for the surface draw place mode.

FastPlaceInteractions(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run for the fast place mode.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PlacementCountCondition

PlacementCountConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PlacementCountCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

BlockString
ValueInteger defaults to: 0
LessThanBoolean defaults to: true
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Portal

EnterPortalInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Portal

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PortalReturn

ReturnPortalInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PortalReturn

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PrefabSelectionInteraction

Interaction that handles the selection functionally for the prefab selection tool.

PrefabSelectionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PrefabSelectionInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Projectile

Fires a projectile.

ProjectileInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Projectile

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Config(Nullable) String

Reference to a ProjectileConfig asset

The ID of the projectile config asset to use for the projectile.

IgnorePitchBoolean defaults to: false

If true, the shooter's pitch is set to 0 before the launch direction is computed, so the projectile's pitch is fixed by the projectile config's SpawnRotationOffset.

IgnoreYawBoolean defaults to: false

If true, the shooter's yaw is set to 0 before the launch direction is computed, so the projectile's yaw is fixed by the projectile config's SpawnRotationOffset.

IgnoreRollBoolean defaults to: false

If true, the shooter's roll is set to 0 before the launch direction is computed, so the projectile's roll is fixed by the projectile config's SpawnRotationOffset.

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

The maximum lifetime of the projectile in seconds, after which it will despawn.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

PullEntityAbility

Reels the hit entity toward the caster (inverted knockback): an optional hooked delay, then a drag lasting a fixed time from any range, stopping at reach. A victim guarding toward the caster resists the whole pull.

PullEntityAbilityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: PullEntityAbility

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

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

Seconds the victim stays hooked before the reel rips.

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

Seconds the drag takes, from any range: the required speed is recomputed every tick from the remaining distance and time, so far victims arrive as fast as near ones and knockback-resistant ones arrive on the same schedule.

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

Upward bow of the drag path, in blocks: the aim point starts this far above the caster's feet and eases down to the feet on approach, lifting victims over block lips instead of grinding them against faces.

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

Distance from the caster at which the reel lets go, measured to the victim's bounding-box edge, so big entities stop at the same reach as small ones.

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

Widest victim the pull can drag, in blocks of bounding-box width or depth: heavier-than-the-chain entities (bosses) resist entirely. 0 or absent means no limit.

Effect(Nullable) String

Reference to a EntityEffect asset

Optional EntityEffect applied to the victim when the pull takes hold (e.g. a hooked root). Guard, size, and every other gate skip it together with the drag.

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

Duration of the applied Effect in seconds. When absent or 0 the effect's own duration applies.

EffectDurationAttribute(Nullable) String

Name of an ability attribute (e.g. Duration) that replaces EffectDuration when the cast carries resolved attributes, so duration runes extend the hooked state.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

RefillContainer

Refills a container item that is currently held.

RefillContainerInteraction with the following properties:

KeyTypeDescription
TypeConstant value: RefillContainer

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

StatesMap of the following:
Map
KeyType
any StringRefillState
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

RemoveEntity

Despawns the given entity.

RemoveEntityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: RemoveEntity

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EntityAny one of the following String (defaults to User):
InteractionTarget
NameDescription
"User"

Causes the interaction to target the entity that triggered/owns the interaction chain.

"Owner"

Causes the interaction to target the entity that owns the interaction chain.

"Target"

Causes the interaction to target the entity that is the target of the interaction chain.

The entity to target for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Repeat

Forks from the current interaction into one or more chains that run the specified interactions.

When run this will create a new chain that will run the interactions specified in ForkInteractions. This will then wait until that chain completes. If the chain completes successfully it will then check the Repeat field to see if it needs to run again, if not then the interactions Next are run otherwise this repeats with the next fork. If the chain fails then any repeating is ignored and the interactions Failed are run instead.

RepeatInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Repeat

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ForkInteractionsEither String or RootInteraction

Reference to a RootInteraction asset

The interactions to run in the forks created by this interaction.

RepeatInteger defaults to: 1

The number of times to repeat. -1 is considered as infinite, be careful when using this value.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Replace

Runs the interaction defined by the interaction variables if defined.

ReplaceInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Replace

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

DefaultValue(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

VarString
DefaultOkBoolean defaults to: false
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ResetCooldown

Resets the cooldown.

ResetCooldownInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ResetCooldown

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Cooldown(Nullable)
InteractionCooldown

InteractionCooldown with the following properties:

KeyTypeDescription
Id(Nullable) String

The Id for the cooldown.

Cooldowns can be used on different interactions but share a cooldown.

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

The time in seconds this cooldown should last for.

Charges(Nullable) Array of Number

The charge times available for this interaction.

SkipCooldownResetBoolean defaults to: false

Determines whether resetting cooldown should be skipped.

InterruptRechargeBoolean defaults to: false

Determines whether recharge is interrupted by use.

ClickBypassBoolean defaults to: false

Whether this cooldown can be bypassed by clicking.

The cooldown concerning this interaction, defaulting to the root cooldown if none presented

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

RevealMapMarkersInView

Reveals the discoverable world map markers that sit inside the view cone of the player.

RevealMapMarkersInViewInteraction with the following properties:

KeyTypeDescription
TypeConstant value: RevealMapMarkersInView

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

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

The full angle of the view cone in degrees. A marker is found when it sits within half this angle of the look direction. Keep it narrow for a tool the player has to aim.

MaxDistanceNumber defaults to: 128.0

The maximum distance in blocks from the eye position of the player. This is not an occlusion test, so a marker behind terrain is still found. It must be a finite distance.

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

The time in seconds between scans. The first scan runs immediately. One scan tests every marker of the world, so a short interval costs more on a world with many markers. A value of 0 scans on every tick. The run ends on a scan, so this also bounds how long it takes to end.

RunWhile(Nullable) Array of the type: Type Selector (2)

Conditions that must all hold for the scanning to continue. The interaction finishes on the first scan where one of them fails. Leave this out, or give an empty list, to scan once.

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

The time in seconds the RunWhile conditions have to start holding in. This does nothing without RunWhile. Raise it above the windup of the interaction this runs beside, or that windup ends the run before the conditions ever hold. A value of 0 ends the run on the first scan where they do not hold.

RevealParticles(Nullable) Array of the type:
WorldParticle

WorldParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

The id of the particle system.

Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

The colour used if none was specified in the particle settings.

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

The scale of the particle system.

PositionOffset(Nullable) Vector3f

The position offset from the spawn position.

RotationOffset(Nullable) Direction

The rotation offset from the spawn rotation.

Particle systems to spawn on the marker block when the player reveals it. Only the player who found the marker sees them, because discovery is per player.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

RunOnBlockTypes

Searches for matching block types within a radius and runs interactions on each found block up to a configured maximum number of blocks.

RunOnBlockTypesInteraction with the following properties:

KeyTypeDescription
TypeConstant value: RunOnBlockTypes

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

RangeInteger defaults to: 0

The spherical radius to search for matching block types.

BlockSetsArray of String

Reference to a BlockSet asset

Array of BlockSet IDs to match within the search radius.

MaxCountInteger defaults to: 0

Maximum number of block positions to select for running interactions (uses reservoir sampling).

Interactions(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

The interaction chain to run on each found block. Can be defined inline or as a reference.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

RunRootInteraction

Runs the given interaction root.

RunRootInteraction with the following properties:

KeyTypeDescription
TypeConstant value: RunRootInteraction

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

RootInteractionString

Reference to a RootInteraction asset

A reference to a root interaction to run

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Seating

Arranges perfect seating accommodations

SeatingInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Seating

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Selector

An interaction that can be used to find entities/blocks within a given area.

This runs the given Selector every tick this interactions runs for, the selector may change the search area over time (based on RunTime). e.g. to trace out an arc of a sword swing.

When an entity/block is found this interaction will run a set of interactions (as defined by HitEntity/HitBlock) per a entity/block, this will not interrupt the selector and it will continue searching until the select interaction completes.

This interaction does not wait for any forked interaction chains from HitEntity/HitBlock to complete before finishing itself.

SelectInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Selector

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

SelectorType Selector (3)

The selector to use to find entities and blocks in an area. The selector may be spread over the duration RunTime.

HitEntity(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

The interactions to fork into when an entity is hit by the selector. The hit entity will be the target of the interaction chain.

An entity cannot be hit multiple times by a single selector.

HitEntityRules(Nullable) Array of the type:
HitEntity

HitEntity with the following properties:

KeyTypeDescription
NextEither String or RootInteraction

Reference to a RootInteraction asset

MatchersArray of the type: Either PlayerMatcher or VulnerableMatcher

Tests any hit entity with the given rules, running a fork for the last one matched. This overrides HitEntity if any match.

HitBlock(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

The interactions to fork into when a block is hit by the selector. The hit block will be the target of the interaction chain.

A block cannot be hit multiple times by a single selector.

FailOn(Nullable) Any one of the following String (defaults to Neither):
FailOnType
NameDescription
"Neither"
"Entity"
"Block"
"Either"

Changes what causes the Failed case to run

IgnoreOwnerBoolean defaults to: true

Determines whether the owner of the affiliated entity should be ignored in the selection.

For example, ignoring the thrower of a projectile.

MaxTargetsInteger defaults to: 0

Maximum number of targets to select for running interactions (uses reservoir sampling).

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SendBeacon

Broadcasts a beacon message to nearby NPCs and encounter managers listening for it.

SendBeaconInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SendBeacon

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

MessageString

The beacon message key to broadcast. Only receivers listening for this key react.

RangeNumber defaults to: 64.0

Broadcast radius.

ExpirationTimeNumber defaults to: 1.0

Seconds the message stays active on receivers. -1 is infinite.

TargetGroups(Nullable) Array of String

Optional NPC groups to restrict delivery to. Omit to broadcast to every listener in range.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SendMessage

Interaction that sends a message on use.

SendMessageInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SendMessage

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Target(Nullable) Any one of the following String (defaults to Owner):
Target
NameDescription
"Universe"

Send the message to every player of every live world.

"World"

Send the message to every player of the world the interaction runs in.

"Owner"

Send the message to the entity that ran the interaction.

The set of players that receive the message.

Message(Nullable) String
Key(Nullable) String
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Serial

Runs the given interactions in order.

SerialInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Serial

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

ParentString

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

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

InteractionsArray of the type: Either String or Interaction

Reference to a Interaction asset

A list of interactions to run. They will be executed in the order specified sequentially.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SetGameFlag

An interaction that writes the given game flag.

SetGameFlagInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SetGameFlag

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

KeyString
ValueInteger defaults to: 1
RaiseBoolean defaults to: false

Whether to only ever raise the flag instead of overwriting it.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SetMemoriesCapacity

Sets how many memories a player can store.

SetMemoriesCapacityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SetMemoriesCapacity

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

CapacityInteger defaults to: 0

Defines the amount of memories that a player can store.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ShowEventTitle

Shows an event title to the players of one world or of the whole universe.

ShowEventTitleInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ShowEventTitle

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

TargetAny one of the following String (defaults to World):
Target
NameDescription
"Universe"

Show the title to every player of every live world.

"World"

Show the title to every player of the world the interaction runs in.

The set of players that see the title.

PrimaryTitle
FormattedMessage

FormattedMessage with the following properties:

KeyTypeDescription
RawText(Nullable) String
MessageId(Nullable) String
Params(Nullable) Map (1)
MessageParams(Nullable) Map (2)
Children(Nullable) Array of the type: FormattedMessage
Bold(Nullable) (Nullable) Boolean
Italic(Nullable) (Nullable) Boolean
Monospace(Nullable) (Nullable) Boolean
Underline(Nullable) (Nullable) Boolean
Strikethrough(Nullable) (Nullable) Boolean
Color(Nullable) String
Link(Nullable) String

The main line of the title.

SecondaryTitle(Nullable)
FormattedMessage

FormattedMessage with the following properties:

KeyTypeDescription
RawText(Nullable) String
MessageId(Nullable) String
Params(Nullable) Map (1)
MessageParams(Nullable) Map (2)
Children(Nullable) Array of the type: FormattedMessage
Bold(Nullable) (Nullable) Boolean
Italic(Nullable) (Nullable) Boolean
Monospace(Nullable) (Nullable) Boolean
Underline(Nullable) (Nullable) Boolean
Strikethrough(Nullable) (Nullable) Boolean
Color(Nullable) String
Link(Nullable) String

The line below the primary title. Leave it out for a title of one line.

Style(Nullable) Any one of the following String (defaults to Default):
EventTitleStyle
NameDescription
"Default"

The standard event title presentation.

"Major"

A major event title presentation.

"GoblinBreach"

The presentation for a goblin breach.

"VoidEviction"

The presentation for a void-presence eviction.

The style the client uses to present the event title.

IsMajorBoolean

Deprecated field for whether the client presents this as a major event rather than a minor one.

Icon(Nullable) String

The icon to show beside the title. Leave it empty for a title with no icon.

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

The time in seconds the title stays on screen, after the fade in.

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

The time in seconds the title takes to fade in.

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

The time in seconds the title takes to fade out.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SignalNearbyVolumes

Sends a SignalReceived event to trigger volumes within a radius of the target point.

SignalNearbyVolumesInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SignalNearbyVolumes

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

MatchKey(Nullable) String

When set, only volumes carrying this tag are signalled. When absent, every volume in range is signalled.

MatchValue(Nullable) String
RadiusNumber defaults to: 50.0

Radius around the origin to search for volumes. 0 or less signals all volumes (matching the tag filter when set).

SignalKeys(Nullable) Array of String
SignalValues(Nullable) Array of String
RequireHitLocationBoolean defaults to: false

When true, the interaction does nothing if there is no hit location. When false (default), it falls back to the instigating entity's position.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Simple

A interaction that does nothing other than base interaction features. Can be used for simple delays or triggering animations in between other interactions.

SimpleInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Simple

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnAbilityEntity

Spawns a stationary ability entity (e.g. a tornado) at the point the caster aims at. It lives for Lifetime seconds and re-runs each of its Repeats chains at its own interval. Damage against it is ignored.

SpawnAbilityEntityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnAbilityEntity

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ModelString

The model asset for the entity. Its HitBox is what other abilities can target.

RepeatsArray of the type:
RepeatConfig

RepeatConfig with the following properties:

KeyTypeDescription
ChainEither String or RootInteraction

Reference to a RootInteraction asset

The chain to run each repeat; author a Selector there for the area the repeat affects. Author an inline chain ({ "Interactions": [...] }) or the id of a Root_* asset. The id of a plain interaction file does NOT work: only root-shaped assets register as chain roots.

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

Seconds between runs.

The repeating chains of the entity. Each entry runs its chain at its own interval, so a fast pull and a slow damage tick can coexist.

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

How many seconds the entity lives.

LifetimeAttribute(Nullable) String

Name of an ability attribute (e.g. Duration) that replaces Lifetime when the cast carries resolved attributes. The ability must declare the attribute; Lifetime is only the fallback.

ScaleAttribute(Nullable) String

Name of an ability attribute (e.g. AoeScale) that uniformly scales the entity's model and hitbox when the cast carries resolved attributes. Leave absent to keep the authored size.

RangeNumber defaults to: 20.0

How far away the caster can place the entity. Aiming at nothing places it at this range on the aim line.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnDeployableAtHitLocation

SpawnDeployableAtHitLocationInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnDeployableAtHitLocation

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ConfigType Selector (4)
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnDeployableAtLocation

Spawns a deployable at a specific location.

SpawnDeployableAtLocationInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnDeployableAtLocation

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ConfigType Selector (5)
Offset
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0
RotationYawAny one of the following String (defaults to None):
Rotation
NameDescription
"None"
"Ninety"
"OneEighty"
"TwoSeventy"
OriginSourceAny one of the following String (defaults to Entity):
OriginSource
NameDescription
"Entity"

The origin will be based on the position of the entity performing the interaction.

"Block"

The origin will be based on the position of the targeted block.

OffsetRotationModeAny one of the following String (defaults to None):
RelativeRotationMode
NameDescription
"None"

The reference rotation will not be applied. Values are treated as absolute.

"Yaw"

Only the yaw (Y-axis) component of the reference rotation will be applied.

"Full"

The full reference rotation (pitch, yaw, and roll) will be applied.

DeployableRotationModeAny one of the following String (defaults to None):
RelativeRotationMode
NameDescription
"None"

The reference rotation will not be applied. Values are treated as absolute.

"Yaw"

Only the yaw (Y-axis) component of the reference rotation will be applied.

"Full"

The full reference rotation (pitch, yaw, and roll) will be applied.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnDeployableFromRaycast

SpawnDeployableFromRaycastInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnDeployableFromRaycast

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ConfigType Selector (4)
PreviewStatConditions(Nullable) Map of the following:
Map of string to float

Modifiers to apply to EntityStats.

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

The max distance at which the player can deploy the deployable.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnMinecart

Spawns a minecart at the target block

SpawnMinecartInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnMinecart

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Model(Nullable) String

Reference to a ModelAsset asset

CartInteractions(Nullable) Map of the following:
Map of InteractionType
KeyTypeDescription
PrimaryEither String or RootInteraction

Reference to a RootInteraction asset

SecondaryEither String or RootInteraction

Reference to a RootInteraction asset

Ability1Either String or RootInteraction

Reference to a RootInteraction asset

Ability2Either String or RootInteraction

Reference to a RootInteraction asset

Ability3Either String or RootInteraction

Reference to a RootInteraction asset

Ability4Either String or RootInteraction

Reference to a RootInteraction asset

UseEither String or RootInteraction

Reference to a RootInteraction asset

PickEither String or RootInteraction

Reference to a RootInteraction asset

PickupEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEnterEither String or RootInteraction

Reference to a RootInteraction asset

CollisionLeaveEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEither String or RootInteraction

Reference to a RootInteraction asset

EntityStatEffectEither String or RootInteraction

Reference to a RootInteraction asset

SwapToEither String or RootInteraction

Reference to a RootInteraction asset

SwapFromEither String or RootInteraction

Reference to a RootInteraction asset

DeathEither String or RootInteraction

Reference to a RootInteraction asset

WieldingEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileSpawnEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileHitEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileMissEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileBounceEither String or RootInteraction

Reference to a RootInteraction asset

HeldEither String or RootInteraction

Reference to a RootInteraction asset

HeldOffhandEither String or RootInteraction

Reference to a RootInteraction asset

EquippedEither String or RootInteraction

Reference to a RootInteraction asset

DodgeEither String or RootInteraction

Reference to a RootInteraction asset

GameModeSwapEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakImpactEither String or RootInteraction

Reference to a RootInteraction asset

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnNPC

Spawns an NPC on the block that is being interacted with.

SpawnNPCInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnNPC

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

EntityId(Nullable) String

Reference to a NPCRole asset

The ID of the entity asset to spawn.

WeightedEntityIds(Nullable) Array of the type:
WeightedNPCSpawn

WeightedNPCSpawn with the following properties:

KeyTypeDescription
IdString

Reference to a NPCRole asset

The Role ID of the NPC to spawn.

WeightNumber defaults to: 0.0

The relative weight of this NPC (chance of being spawned is this value relative to the sum of all weights).

CountRange(Nullable) Array of Integer

Range [min, max] of this NPC to spawn when this entry is picked. Set min and max to the same value for an exact count.

A weighted list of entity IDs from which one is selected per spawn roll. Each entry has its own CountRange. Supersedes any provided EntityId. The number of weighted rolls is controlled by SpawnCount (default 1).

SpawnOffset(Nullable)
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0

The offset to apply to the spawn position of the NPC, relative to the block's rotation and center.

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

The yaw rotation offset in radians to apply to the NPC rotation, relative to the block's yaw.

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

The chance of the NPC spawning when the interaction is triggered.

AlternateSpawnMaxSearchDistanceInteger defaults to: 0

When the primary spawn position has no space (FAIL_INVALID_POSITION), try adjacent world columns along the horizontal cardinal axis toward the interacting player, up to this many block steps from the primary column. 0 disables alternate search. Distance is along that axis only, not a Euclidean radius.

SpawnCount(Nullable) Array of Integer

Range [min, max] of spawns per interaction trigger. With WeightedEntityIds this is the number of weighted rolls (each roll spawns the picked entry's own CountRange). Set min and max to the same value for an exact count.

DistanceRange(Nullable) Array of Number

Range [min, max] of random horizontal distance from the spawn offset to scatter each NPC. Applied per NPC when SpawnCount resolves to more than one. 0 disables scatter.

SpawnState(Nullable) String

An optional state to set on the spawned NPC if it exists.

SpawnSubState(Nullable) String

An optional sub-state to set on the spawned NPC if it exists. Only used when SpawnState is also set.

SpawnVelocityNumber

Random horizontal velocity magnitude applied to each spawned NPC in a random XZ direction. 0 disables.

AllowMidAirSpawnBoolean

When true, still validates physical space but skips the ground-seeking alternate column search on failure, allowing NPCs to spawn mid-air (e.g. from hanging cocoons). Defaults to false.

CenterHitboxOnPositionBoolean

When true, the spawned NPC's collision box is centered on the computed spawn position (including filler cells for block targets) rather than placing its feet there. Useful for NPCs emerging from hanging blocks such as cocoons. Defaults to false.

RequireFullCubeClearanceBoolean

When true (default), every non-air block blocks the spawn position. When false, decorative non-cube blocks (ropes, plants, cocoons, etc.) are ignored and only full-cube blocks block it, letting NPCs emerge from hanging blocks such as cocoons.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnPrefab

Spawns a prefab at the current location.

SpawnPrefabInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnPrefab

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

PrefabPath(Nullable) String
Offset
Vector3i

Vector3i with the following properties:

KeyTypeDescription
XInteger defaults to: 0
YInteger defaults to: 0
ZInteger defaults to: 0
RotationYawAny one of the following String (defaults to None):
Rotation
NameDescription
"None"
"Ninety"
"OneEighty"
"TwoSeventy"
OriginSourceAny one of the following String (defaults to Entity):
OriginSource
NameDescription
"Entity"

The origin will be based on the position of the entity performing the interaction.

"Block"

The origin will be based on the position of the targeted block.

ForceBoolean defaults to: false
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpawnTriggerVolume

Spawns a trigger volume at the hit location, falling back to the instigator's position when there is no hit.

SpawnTriggerVolumeInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpawnTriggerVolume

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

EffectAssetString

The TriggerVolumes/Effects asset id whose conditions and effects the spawned volume runs.

ShapeType Selector (6)

The shape of the spawned volume, relative to the hit location.

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

Seconds before the spawned volume auto-expires. 0 or less means it persists until destroyed by an effect.

RequireHitLocationBoolean defaults to: false

When true, the interaction does nothing if there is no hit location. When false (default), it falls back to the instigating entity's position.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SpectateControl

Spectator camera control that cycles the follow camera through the world's living non-spectating players, or detaches it to free cam.

SpectateControlInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SpectateControl

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Action(Nullable) Any one of the following String:
Action
NameDescription
"Prev"
"Next"
"Detach"
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SplitAbilityProjectile

Splits an ability projectile on its first entity hit when the cast carries a Fork or Ricochet rune; a no-op otherwise. Author in a ProjectileConfig's ProjectileHit chain. Fork counts the projectiles the flight splits into; Ricochet counts the chain's total hits. Both attributes rest at the implicit base 1. A cast attribute named SplitChild (e.g. SplitChildDamage: 0.5) multiplies each child's X attribute at every split, fork and ricochet alike, compounding down the chain; SplitChildScale multiplies the child's flight scale instead.

SplitAbilityProjectileInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SplitAbilityProjectile

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

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

Degrees between adjacent fork children. The fan centers on the projectile's flight direction, so an odd child count keeps one child flying straight.

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

How far around the impact a ricochet looks for its next target. A RicochetRange ability attribute overrides it, but note support modifiers grow attributes from the implicit base 1, not from this value.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

StartObjective

Starts the given objective or adds the player to an existing one.

StartObjectiveInteraction with the following properties:

KeyTypeDescription
TypeConstant value: StartObjective

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

SetupEither
SetupObjective

SetupObjective with the following properties:

KeyTypeDescription
TypeConstant value: Objective

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

ObjectiveIdString

Reference to a ObjectiveAsset asset

or
SetupObjectiveLine

SetupObjectiveLine with the following properties:

KeyTypeDescription
TypeConstant value: ObjectiveLine

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

ObjectiveLineIdString

Reference to a ObjectiveLineAsset asset

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

StatsCondition

Interaction that is successful if the given stat conditions match.

StatsConditionInteraction with the following properties:

KeyTypeDescription
TypeConstant value: StatsCondition

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Costs(Nullable) Map of the following:
Map of string to float

The stat costs to test. Omittable only when the interaction resolves its costs elsewhere (e.g. UseAbilityCost); without either the condition always fails.

LessThanBoolean defaults to: false
LenientBoolean defaults to: false

Specifies that the interaction can run even if the stat cost is not met, providing that the value is greater than zero.

ValueType(Nullable) Any one of the following String (defaults to Absolute):
ValueType
NameDescription
"Percent"
"Absolute"

Enum to specify if the Costs must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.

UseAbilityCostBoolean defaults to: false

Gate on the casting ability's declared Cost/CostType instead of an authored Costs map, so the ability item stays the single source. An ability without a cost passes. Only meaningful in ability cast chains.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

StatsConditionWithModifier

Interaction that is successful if the given stat conditions match.

StatsConditionWithModifierInteraction with the following properties:

KeyTypeDescription
TypeConstant value: StatsConditionWithModifier

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Costs(Nullable) Map of the following:
Map of string to float

The stat costs to test. Omittable only when the interaction resolves its costs elsewhere (e.g. UseAbilityCost); without either the condition always fails.

LessThanBoolean defaults to: false
LenientBoolean defaults to: false

Specifies that the interaction can run even if the stat cost is not met, providing that the value is greater than zero.

ValueType(Nullable) Any one of the following String (defaults to Absolute):
ValueType
NameDescription
"Percent"
"Absolute"

Enum to specify if the Costs must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.

InteractionModifierIdAny one of the following String:
InteractionModifierId
NameDescription
"Dodge"
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

SurfaceDrawPlaceBlock

Draws blocks along a plane while the click is held.

SurfaceDrawPlaceBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: SurfaceDrawPlaceBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

ForkInteractionsEither String or RootInteraction

Reference to a RootInteraction asset

The interactions to run for each committed block.

MaxBlocksPerTickInteger defaults to: 4

The maximum number of block forks started per tick. Demand beyond this queues and drains at this rate.

MaxBlocksPerGestureInteger defaults to: 512

The maximum number of blocks a single gesture may commit. The chain fails when a client exceeds it.

ValidateForkPositionsBoolean defaults to: true

Validates that each committed block position is plausible for the gesture's geometry, rejecting the placement otherwise.

MaxForkPositionViolationsInteger defaults to: 8

The number of rejected block positions a single gesture tolerates before the chain fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

TeleportConfigInstance

Teleports the Player to the named instance, creating it if required.

This is configured via a UI instead of inside the interaction. This interaction just executes that set configuration.

TeleportConfigInstanceInteraction with the following properties:

KeyTypeDescription
TypeConstant value: TeleportConfigInstance

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

TeleportInstance

Teleports the Player to the named instance, creating it if required.

TeleportInstanceInteraction with the following properties:

KeyTypeDescription
TypeConstant value: TeleportInstance

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

InstanceNameString

The name of the instance to teleport to.

InstanceKey(Nullable) String

The key to name the world. Random if not provided

PositionOffset(Nullable)
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0

The offset to apply to the return point.

Used to prevent repeated interactions when returning from the instance.

Rotation(Nullable)
Rotation3f

Rotation3f with the following properties:

KeyTypeDescription
Pitch(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
Yaw(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$

The rotation to set the player to when returning from an instance.

OriginSourceAny one of the following String (defaults to Entity):
OriginSource
NameDescription
"Entity"

The origin will be based on the position of the entity performing the interaction.

"Block"

The origin will be based on the position of the targeted block.

The source to use for the return position.

Defaults to the player's position.

PersonalReturnPointBoolean defaults to: false

Whether the player entering the instance will have their own return point set to the current location. Overriding the world's return point.

CloseOnBlockRemoveBoolean defaults to: true

Whether to delete the instance when the portal block is removed.

RemoveBlockAfterNumber defaults to: -1.0

The number of seconds to wait before removing the block that triggered the interaction. A negative value disables this.

This is needed instead of using another interaction due to all interactions being stopped once teleporting to another world.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Teleporter

TeleporterInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Teleporter

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Particle(Nullable) String

The particle to play on the entity when teleporting.

ClearOutXZNumber defaults to: 1.3

Upon reaching the warp destination, how far away one has to move on the XZ plane in order to use another Teleporter.

ClearOutYNumber defaults to: 2.5

Upon reaching the warp destination, how far away one has to move along the Y axis in order to use another Teleporter.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

ToggleGlider

Toggles Glider movement for the player.

ToggleGliderInteraction with the following properties:

KeyTypeDescription
TypeConstant value: ToggleGlider

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

TriggerAbilityFX

Spawns a world particle system and/or plays a world sound at the chain's hit location, the particles scaled by an optional ability attribute (e.g. an explosion growing with an AoE rune). Use this instead of Effects in server-simulated chains: their Effects never reach a client.

TriggerAbilityFXInteraction with the following properties:

KeyTypeDescription
TypeConstant value: TriggerAbilityFX

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

SystemId(Nullable) String

Reference to a ParticleSystem asset

The particle system to spawn. Optional when only SoundEventId is authored.

SoundEventId(Nullable) String

Reference to a SoundEvent asset

Optional world sound broadcast at the same location, e.g. an impact thud. Author sounds here rather than in Effects for server-simulated chains.

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

The base scale of the particle system.

ScaleAttribute(Nullable) String

Name of an ability attribute (e.g. AoeScale) that multiplies the scale when the acting entity carries resolved attributes. Leave absent for a fixed scale.

Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

Optional tint, for greyscale (_GS) particle textures. An element conversion on the cast overrides it with the element's damage color. Leave absent for the system's own colors.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

TriggerCooldown

Triggers the cooldown as if it was triggered normally.

TriggerCooldownInteraction with the following properties:

KeyTypeDescription
TypeConstant value: TriggerCooldown

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Cooldown(Nullable)
InteractionCooldown

InteractionCooldown with the following properties:

KeyTypeDescription
Id(Nullable) String

The Id for the cooldown.

Cooldowns can be used on different interactions but share a cooldown.

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

The time in seconds this cooldown should last for.

Charges(Nullable) Array of Number

The charge times available for this interaction.

SkipCooldownResetBoolean defaults to: false

Determines whether resetting cooldown should be skipped.

InterruptRechargeBoolean defaults to: false

Determines whether recharge is interrupted by use.

ClickBypassBoolean defaults to: false

Whether this cooldown can be bypassed by clicking.

The cooldown concerning this interaction, defaulting to the root cooldown if none presented

UseAbilityCooldownBoolean defaults to: false

Arm the casting ability's declared Cooldown, keyed by its Cast root, so the ability item stays the single source (and Parallel pseudo-roots cannot mis-key the id). Only meaningful in ability cast chains.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

TriggerSpawnMarkers

TriggerSpawnMarkersInteraction with the following properties:

KeyTypeDescription
TypeConstant value: TriggerSpawnMarkers

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

MarkerType(Nullable) String

Reference to a SpawnMarker asset

The manual spawn marker type to trigger. If omitted, will trigger all manual spawners.

RangeNumber defaults to: 10.0

Range within which to trigger spawn markers.

CountInteger defaults to: 0

Max number of spawn markers to activate. Set to 0 to activate all spawn markers.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

UseBlock

Attempts to use the target block, executing interactions on it if any.

UseBlockInteraction with the following properties:

KeyTypeDescription
TypeConstant value: UseBlock

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

UseCaptureCrate

UseCaptureCrateInteraction with the following properties:

KeyTypeDescription
TypeConstant value: UseCaptureCrate

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

AcceptedNpcGroups(Nullable) Array of the type: Either String or NPCGroup

Reference to a NPCGroup asset

FullIcon(Nullable) String
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

UseCoop

UseCoopInteraction with the following properties:

KeyTypeDescription
TypeConstant value: UseCoop

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

UseEntity

Attempts to use the target entity, executing interactions on it if any.

UseEntityInteraction with the following properties:

KeyTypeDescription
TypeConstant value: UseEntity

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

UseNPC

Interacts with a target NPC.

UseNPCInteraction with the following properties:

KeyTypeDescription
TypeConstant value: UseNPC

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

UseWateringCan

Waters the target farmable block. Supports configurable width and depth for directional area-of-effect watering.

UseWateringCanInteraction with the following properties:

KeyTypeDescription
TypeConstant value: UseWateringCan

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

Next(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction succeeds.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

UseLatestTargetBoolean defaults to: false

Determines whether to use the clients latest target block position for this interaction.

DurationInteger defaults to: 0
RefreshModifiers(Nullable) Array of String
RadiusXInteger defaults to: 0
RadiusZInteger defaults to: 0
Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Wielding

Interaction that blocks while the key is held and applies various modifiers while active.

WieldingInteraction with the following properties:

KeyTypeDescription
TypeConstant value: Wielding

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

ParentString

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

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

ViewDistanceNumber defaults to: 96.0

Configures the distance in which other players will be able to see the effects of this interaction.

Effects(Nullable) InteractionEffects

Sets effects that will be applied whilst the interaction is running.

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

The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.

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

The time in seconds this interaction should run for.

If Effects.WaitForAnimationToFinish is set and the length of the animation is longer than the runtime then the interaction will run for longer than the set time.

OnItemChangeBehavior(Nullable) Any one of the following String (defaults to Cancel):
InteractionItemChangeBehavior
NameDescription
"Cancel"
"Fail"
"Finish"
"Ignore"

What should happen to the interaction when the entity's held item changes.

CancelOnItemChangeBoolean

Deprecated field for whether the interaction will be cancelled when the entity's held item changes.

Rules
InteractionRules

InteractionRules with the following properties:

KeyTypeDescription
BlockedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should block this interaction from starting. If not set then a set of default rules will be applied based on the interaction type that theinteraction is fired with. This is only effective when used on the root interaction of a chain.

BlockingArray of the type: InteractionType

A collection of interaction types that this interaction blocks from starting whilst running. Defaults to an empty set (blocking nothing).

InterruptedBy(Nullable) Array of the type: InteractionType

A collection of interaction types that should stop this interaction while it's running. This is only effective when used on the root interaction of a chain.

Interrupting(Nullable) Array of the type: InteractionType

A collection of interaction types that this interaction should stop when it starts.

BlockedByBypass(Nullable) String

A tag that if matched will bypass the BlockedBy rules.

BlockingBypass(Nullable) String

A tag that if matched will bypass the Blocking rules.

InterruptedByBypass(Nullable) String

A tag that if matched will bypass the InterruptedBy rules.

InterruptingBypass(Nullable) String

A tag that if matched will bypass the Interrupting rules.

A set of rules that control when this interaction can run.

Settings(Nullable) Map of the following:
Map of GameMode
KeyTypeDescription
AdventureInteractionSettings
CreativeInteractionSettings

Per a gamemode settings.

Camera(Nullable)
InteractionCameraSettings

InteractionCameraSettings with the following properties:

KeyTypeDescription
FirstPerson(Nullable) Array of the type: InteractionCamera
ThirdPerson(Nullable) Array of the type: InteractionCamera

Configures the camera behaviour for this interaction.

FailOnDamageBoolean defaults to: false

Whether the interaction will be cancelled and the item removed when the entity takes damage

CancelOnOtherClickBoolean defaults to: true
Forks(Nullable) Map of the following:
Map of InteractionType
KeyTypeDescription
PrimaryEither String or RootInteraction

Reference to a RootInteraction asset

SecondaryEither String or RootInteraction

Reference to a RootInteraction asset

Ability1Either String or RootInteraction

Reference to a RootInteraction asset

Ability2Either String or RootInteraction

Reference to a RootInteraction asset

Ability3Either String or RootInteraction

Reference to a RootInteraction asset

Ability4Either String or RootInteraction

Reference to a RootInteraction asset

UseEither String or RootInteraction

Reference to a RootInteraction asset

PickEither String or RootInteraction

Reference to a RootInteraction asset

PickupEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEnterEither String or RootInteraction

Reference to a RootInteraction asset

CollisionLeaveEither String or RootInteraction

Reference to a RootInteraction asset

CollisionEither String or RootInteraction

Reference to a RootInteraction asset

EntityStatEffectEither String or RootInteraction

Reference to a RootInteraction asset

SwapToEither String or RootInteraction

Reference to a RootInteraction asset

SwapFromEither String or RootInteraction

Reference to a RootInteraction asset

DeathEither String or RootInteraction

Reference to a RootInteraction asset

WieldingEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileSpawnEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileHitEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileMissEither String or RootInteraction

Reference to a RootInteraction asset

ProjectileBounceEither String or RootInteraction

Reference to a RootInteraction asset

HeldEither String or RootInteraction

Reference to a RootInteraction asset

HeldOffhandEither String or RootInteraction

Reference to a RootInteraction asset

EquippedEither String or RootInteraction

Reference to a RootInteraction asset

DodgeEither String or RootInteraction

Reference to a RootInteraction asset

GameModeSwapEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakEither String or RootInteraction

Reference to a RootInteraction asset

OnBreakImpactEither String or RootInteraction

Reference to a RootInteraction asset

A collection of interactions to fork into when the input associated with the interaction type is used.

For example listing a Primary interaction type here with interactions will allow the user to press the input tied to the Primary interaction type whilst holding the input used to run the current interaction to run the specified interactions. e.g. Having a shield that you can hold Secondary to block and whilst blocking press Primary to shield bash.

This does not cancel the current interaction when triggered but the CancelOnOtherClick check will still run and may cancel the interaction.

The existing forks will continue to run even if this interaction ends.

Failed(Nullable) Either String or Interaction

Reference to a Interaction asset

The interactions to run when this interaction fails.

IgnoreForFlaggedConditionsBoolean defaults to: false

An override flag that can be used by Conditions to determine whether to ignore this interaction.

KnockbackModifiers(Nullable) Map of the following:
Map of string to double
DamageModifiers(Nullable) Map of the following:
Map of string to float
AngledWielding(Nullable)
AngledWielding

AngledWielding with the following properties:

KeyTypeDescription
Angle(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
AngleDistance(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
KnockbackModifiers(Nullable) Map of string to double (1)
DamageModifiers(Nullable) Map of string to float
Next(Nullable) Either String or Interaction

Reference to a Interaction asset

StaminaCost(Nullable)
StaminaCost

StaminaCost with the following properties:

KeyTypeDescription
CostType(Nullable) CostType

Define how the stamina loss is computed. Use MAX_HEALTH_PERCENTAGE to define how many % of the player's max health 1 stamina point is worth. Use DAMAGE define how much damage 1 stamina point is worth. Default value is MAX_HEALTH_PERCENTAGE.

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

The value to define how much a stamina point is worth. When CostType.MAX_HEALTH_PERCENTAGE, a ratio is expected, so for 4% of max health, the value expected here is 0.04. Default value is 0.04f

Configuration to define how stamina loss is computed.

BlockedEffects(Nullable)
DamageEffects

DamageEffects with the following properties:

KeyTypeDescription
ModelParticles(Nullable) Array of the type: ModelParticle
WorldParticles(Nullable) Array of the type: WorldParticle
LocalSoundEventId(Nullable) String

Reference to a SoundEvent asset

WorldSoundEventId(Nullable) String

Reference to a SoundEvent asset

PlayerSoundEventId(Nullable) String

Reference to a SoundEvent asset

The sound to play to a player receiving the damage.

ViewDistanceNumber defaults to: 75.0
Knockback(Nullable) Type Selector
CameraEffect(Nullable) Either String or CameraEffect

Reference to a CameraEffect asset

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

A multiplier to apply to any stamina drain caused by this damage.

BlockedInteractions(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

Notes:

Types referenced by this type

InteractionType

Any one of the following String:

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

BlockFace

(Nullable) Any one of the following String:

NameDescription
"Up"
"Down"
"North"
"East"
"South"
"West"
"UpNorth"
"UpSouth"
"UpEast"
"UpWest"
"DownNorth"
"DownSouth"
"DownEast"
"DownWest"
"NorthEast"
"SouthEast"
"SouthWest"
"NorthWest"
"UpNorthEast"
"UpSouthEast"
"UpSouthWest"
"UpNorthWest"
"DownNorthEast"
"DownSouthEast"
"DownSouthWest"
"DownNorthWest"

Type

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

NameDescription
"Dps"
"Absolute"

DamageClass

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

NameDescription
"Unknown"
"Light"
"Charged"
"Signature"

Map of string to float

(Nullable) Map of the following:

Type Selector

Any of these:

Key: TypeType
default case: Directional
DirectionalKnockback

DirectionalKnockback with the following properties:

KeyTypeDescription
Type(Nullable) String

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

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

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
RelativeXNumber defaults to: 0.0
VelocityYNumber defaults to: 0.0
RelativeZNumber defaults to: 0.0
Force
ForceKnockback

ForceKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Force

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

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

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
DirectionVector3d
Point
PointKnockback

PointKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Point

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

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

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
VelocityYNumber defaults to: 0.0
RotateYInteger defaults to: 0
OffsetXInteger defaults to: 0
OffsetZInteger defaults to: 0

ChangeVelocityType

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

NameDescription
"Add"

Adds the velocity to any existing velocity

"Set"

Changes the velocity to the given value. Overriding existing values.

Map

(Nullable) Map of the following:

KeyType
any String
TargetEntityEffect

TargetEntityEffect with the following properties:

KeyTypeDescription
DurationNumber defaults to: 0.0
ChanceNumber defaults to: 1.0
EntityTypeDurationModifiers(Nullable) Map of string to double
OverlapBehavior(Nullable) OverlapBehavior

Map of string to double

(Nullable) Map of the following:

KeyType
StringNumber

OverlapBehavior

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

NameDescription
"Extend"
"Overwrite"
"Ignore"

ModifierTarget

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

NameDescription
"Min"
"Max"

CalculationType

Any one of the following String:

NameDescription
"Additive"
"Multiplicative"

Type 0

(Nullable) Map of the following:

KeyType
any Stringanything

Type Selector (1)

Any of these:

Key: IdType
AugmentMessage
Supplier

Supplier with the following properties:

KeyTypeDescription
IdConstant value: AugmentMessage

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

KeyString
AugmentUpgrade
AugmentUpgradePage

AugmentUpgradePage with the following properties:

KeyTypeDescription
IdConstant value: AugmentUpgrade

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

BlockLore
BlockLorePageSupplier

BlockLorePageSupplier with the following properties:

KeyTypeDescription
IdConstant value: BlockLore

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

TextAlignment(Nullable) TextAlignment

Horizontal alignment of the description text. Defaults to Center.

BlockSpawner
BlockSpawnerSettingsPage

BlockSpawnerSettingsPage with the following properties:

KeyTypeDescription
IdConstant value: BlockSpawner

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

ConfigInstanceBlock
ConfigureInstanceBlockPage

ConfigureInstanceBlockPage with the following properties:

KeyTypeDescription
IdConstant value: ConfigInstanceBlock

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

GoblinLabConsole
GoblinLabConsolePage

GoblinLabConsolePage with the following properties:

KeyTypeDescription
IdConstant value: GoblinLabConsole

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

ItemRepair
ItemRepairPageSupplier

ItemRepairPageSupplier with the following properties:

KeyTypeDescription
IdConstant value: ItemRepair

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

RepairPenaltyNumber defaults to: 0.0
LaunchPad
LaunchPadSettingsPage

LaunchPadSettingsPage with the following properties:

KeyTypeDescription
IdConstant value: LaunchPad

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

Memories
MemoriesPage

MemoriesPage with the following properties:

KeyTypeDescription
IdConstant value: Memories

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

MemoriesUnlocked
MemoriesUnlockedPage

MemoriesUnlockedPage with the following properties:

KeyTypeDescription
IdConstant value: MemoriesUnlocked

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

PortalDevice
PortalDevicePageSupplier

PortalDevicePageSupplier with the following properties:

KeyTypeDescription
IdConstant value: PortalDevice

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

Config(Nullable) PortalDeviceConfig

The portal device's config.

PrefabSpawner
PrefabSpawnerSettingsPage

PrefabSpawnerSettingsPage with the following properties:

KeyTypeDescription
IdConstant value: PrefabSpawner

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

Shop
ShopPageSupplier

ShopPageSupplier with the following properties:

KeyTypeDescription
IdConstant value: Shop

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

ShopId(Nullable) String
Teleporter
TeleporterSettingsPageSupplier

TeleporterSettingsPageSupplier with the following properties:

KeyTypeDescription
IdConstant value: Teleporter

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

CreateBoolean defaults to: true
Mode(Nullable) Mode

TextAlignment

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

NameDescription
"Left"
"Center"
"Right"

Mode

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

NameDescription
"Full"
"Warp"

Type Selector (2)

Any of these:

Key: IdType
Alive
AliveCondition

AliveCondition with the following properties:

KeyTypeDescription
IdConstant value: Alive

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

Charging
ChargingCondition

ChargingCondition with the following properties:

KeyTypeDescription
IdConstant value: Charging

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

DelayNumber

The delay duration within which a recent charge is considered valid.

UseIgnoreFlagBoolean defaults to: false

If true, the IgnoreForFlaggedConditions on matching interactions will be adhered to.

CheckPlayerGameMode
CheckPlayerGameModeCondition

CheckPlayerGameModeCondition with the following properties:

KeyTypeDescription
IdConstant value: CheckPlayerGameMode

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

GameModeGameMode

The game mode to check for. If null, the condition always passes.

Environment
EnvironmentCondition

EnvironmentCondition with the following properties:

KeyTypeDescription
IdConstant value: Environment

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

Environments(Nullable) Array of String

The environments to evaluate the condition against.

Gliding
GlidingCondition

GlidingCondition with the following properties:

KeyTypeDescription
IdConstant value: Gliding

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

HasEffect
HasEffectCondition

HasEffectCondition with the following properties:

KeyTypeDescription
IdConstant value: HasEffect

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

EffectId(Nullable) String

Reference to a EntityEffect asset

The effect to check for. Returns true if the entity has an active effect matching this one. If null, this condition always returns false.

InFluid
InFluidCondition

InFluidCondition with the following properties:

KeyTypeDescription
IdConstant value: InFluid

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

FluidIds(Nullable) Array of String

Reference to a Fluid asset

Fluid IDs to match against. Returns true when at least one block within the entity's bounding box contains one of these fluids.

Tags(Nullable) Array of String

Fluid tags to match against. Returns true when at least one block within the entity's bounding box contains a fluid with any of these tags.

IsPlayer
IsPlayerCondition

IsPlayerCondition with the following properties:

KeyTypeDescription
IdConstant value: IsPlayer

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

LogicCondition
LogicCondition

LogicCondition with the following properties:

KeyTypeDescription
IdConstant value: LogicCondition

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

OperatorOperator

The logical operator to combine the conditions.

ConditionsArray of the type: Type Selector (2)

The array of conditions to be evaluated.

NoDamageTaken
NoDamageTakenCondition

NoDamageTakenCondition with the following properties:

KeyTypeDescription
IdConstant value: NoDamageTaken

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

DelayNumber

The delay duration for the no damage taken condition.

OutOfCombat
OutOfCombatCondition

OutOfCombatCondition with the following properties:

KeyTypeDescription
IdConstant value: OutOfCombat

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

DelaySeconds(Nullable) Number

Delay before an entity is considered out of combat. Expressed in seconds.

RegenHealth
RegenHealthCondition

RegenHealthCondition with the following properties:

KeyTypeDescription
IdConstant value: RegenHealth

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

Sprinting
SprintingCondition

SprintingCondition with the following properties:

KeyTypeDescription
IdConstant value: Sprinting

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

Stat
StatCondition

StatCondition with the following properties:

KeyTypeDescription
IdConstant value: Stat

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

StatString

Reference to a EntityStatType asset

The stat to evaluate the condition against.

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

The amount to compare the entity's stat against.

Comparison(Nullable) StatComparisonType

The comparison type used for evaluating the stat condition.

Suffocating
SuffocatingCondition

SuffocatingCondition with the following properties:

KeyTypeDescription
IdConstant value: Suffocating

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

Wielding
WieldingCondition

WieldingCondition with the following properties:

KeyTypeDescription
IdConstant value: Wielding

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

InverseBoolean defaults to: false

Determines whether the condition is inverted.

UseIgnoreFlagBoolean defaults to: false

If true, the IgnoreForFlaggedConditions on matching interactions will be adhered to.

GameMode

Any one of the following String:

NameDescription
"Adventure"
"Creative"

Operator

Any one of the following String:

NameDescription
"And"
"Or"

StatComparisonType

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

NameDescription
"Gte"
"Gt"
"Lte"
"Lt"
"Equal"

Type Selector (3)

Any of these:

Key: IdType
AOECircle

A selector that selects all entities within a given range.

AOECircleSelector

AOECircleSelector with the following properties:

KeyTypeDescription
IdConstant value: AOECircle

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

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

The range of the area to search for targets in.

Offset(Nullable) Vector3d

The offset of the area to search for targets in.

SizeAttribute(Nullable) String

Name of an ability attribute (e.g. AoeScale) that scales Range when the acting entity carries resolved attributes, e.g. an ability projectile with support runes.

AOECylinder

A selector that selects all entities within a given range and height.

AOECylinderSelector

AOECylinderSelector with the following properties:

KeyTypeDescription
IdConstant value: AOECylinder

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

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

The range of the area to search for targets in.

Offset(Nullable) Vector3d

The offset of the area to search for targets in.

SizeAttribute(Nullable) String

Name of an ability attribute (e.g. AoeScale) that scales Range when the acting entity carries resolved attributes, e.g. an ability projectile with support runes.

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

The height of the area to search for targets in from the entity position.

Donut

A ring-shaped selector whose radius grows from MinRadius to MaxRadius over the run time.

DonutSelector

DonutSelector with the following properties:

KeyTypeDescription
IdConstant value: Donut

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

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

The radius of the ring at the start of the run time.

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

The radius of the ring at the end of the run time.

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

The constant radial thickness of the ring, centered on the current radius.

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

The constant vertical height of the ring, extending up from the selector position.

AngleDegNumber defaults to: 360.0

The angular size of the ring in degrees. 360 is a full donut; a smaller value makes an arc centered on the attacker's look direction at the moment the selector starts.

Offset(Nullable) Vector3d

The offset applied to the transform position used as the origin location of the selector.

YawOffsetDegNumber defaults to: 0.0

The yaw rotation offset in degrees, applied to the arc facing and the origin Offset.

Horizontal

A selector that swings in a horizontal arc over a given period of time.

HorizontalSelector

Raycast
RaycastSelector

RaycastSelector with the following properties:

KeyTypeDescription
IdConstant value: Raycast

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

Offset(Nullable) Vector3d

The offset of the area to search for targets in.

DistanceInteger defaults to: 30

The max search distance for the raycast

IgnoreFluidsBoolean defaults to: false
IgnoreEmptyCollisionMaterialBoolean defaults to: false
BlockTag(Nullable) String

The required tag for the block to have to match for the raycast to hit them

Stab

A selector that stabs in a straight line over a given period of time.

StabSelector

Map (1)

(Nullable) Map of the following:

KeyType
any StringType 1

Type 1

Any of these:

Type
Boolean
Number
Integer
String

Map (2)

(Nullable) Map of the following:

KeyType
any StringFormattedMessage

Type Selector (4)

Any of these:

Type Selector (5)

Any of these:

Type Selector (6)

Any of these:

Key: TypeType
Box
BoxShape

BoxShape with the following properties:

KeyTypeDescription
TypeConstant value: Box

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

Min(Nullable) Vector3d
Max(Nullable) Vector3d
Rotation(Nullable) Vector3d
Cylinder
CylinderShape

CylinderShape with the following properties:

KeyTypeDescription
TypeConstant value: Cylinder

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

Center(Nullable) Vector3d
RadiusNumber defaults to: 0.0
HeightNumber defaults to: 0.0
Sphere
SphereShape

SphereShape with the following properties:

KeyTypeDescription
TypeConstant value: Sphere

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

Center(Nullable) Vector3d
RadiusNumber defaults to: 0.0

Map of string to double (1)

(Nullable) Map of the following:

CostType

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

NameDescription
"MaxHealthPercentage"
"Damage"

On this page

AddItemApplyAbilityEffectsApplyEffectApplyForceAttachBeamAugmentConditionBedBlockConditionBreakBlockBuilderToolCameraCameraShakeCanBreakRespawnPointCancelChainCarryBlockCarryDroppedBlockCarryPlaceBlockChainFlagChainingChangeActiveSlotChangeBlockChangeFarmingStageChangeStatChangeStatWithModifierChangeStateChargingCheckUniqueItemUsageClearCarriedBlockClearEntityEffectConditionContextualUseNPCCooldownConditionCycleBlockGroupDamageEntityDestroyBlockDestroyTaggedVolumesDoorDragEraseBlockDragPlaceBlockDurabilityConditionEffectConditionEquipItemEventStartInteractionEventStopInteractionExitInstanceExplodeExtrudePlaceBlockFertilizeSoilFirstClickGameFlagConditionGlobalEventStartInteractionGlobalEventStopInteractionGrantAbilityChargesGroundedConditionHarvestCropHubPortalIncreaseBackpackCapacityIncrementCooldownInterruptLaunchAbilityProjectileLaunchPadLaunchProjectileLearnRecipeMemoriesConditionModifyIntervalConditionInteractionModifyInventoryMountMovementConditionOpenAbilityBenchOpenBenchPageOpenChapterRewardsOpenContainerOpenCustomUIOpenItemStackContainerOpenPageOpenProcessingBenchParallelPickBlockPickupItemPlaceBlockPlaceFluidPlaceModeSelectPlacementCountConditionPortalPortalReturnPrefabSelectionInteractionProjectilePullEntityAbilityRefillContainerRemoveEntityRepeatReplaceResetCooldownRevealMapMarkersInViewRunOnBlockTypesRunRootInteractionSeatingSelectorSendBeaconSendMessageSerialSetGameFlagSetMemoriesCapacityShowEventTitleSignalNearbyVolumesSimpleSpawnAbilityEntitySpawnDeployableAtHitLocationSpawnDeployableAtLocationSpawnDeployableFromRaycastSpawnMinecartSpawnNPCSpawnPrefabSpawnTriggerVolumeSpectateControlSplitAbilityProjectileStartObjectiveStatsConditionStatsConditionWithModifierSurfaceDrawPlaceBlockTeleportConfigInstanceTeleportInstanceTeleporterToggleGliderTriggerAbilityFXTriggerCooldownTriggerSpawnMarkersUseBlockUseCaptureCrateUseCoopUseEntityUseNPCUseWateringCanWieldingNotes:InteractionTypeBlockFaceTypeDamageClassMap of string to floatType SelectorChangeVelocityTypeMapMap of string to doubleOverlapBehaviorModifierTargetCalculationTypeType 0Type Selector (1)TextAlignmentModeType Selector (2)GameModeOperatorStatComparisonTypeType Selector (3)Map (1)Type 1Map (2)Type Selector (4)Type Selector (5)Type Selector (6)Map of string to double (1)CostType