ApplyForceInteraction
Applies a force to the user, optionally waiting for a condition to met before continuing.
Type
This field controls the type, it must be set to the constant value "ApplyForce" to function as this type.
Type information: Constant value: ApplyForce
Parent
When set this asset will inherit properties from the named asset.
When inheriting from another ApplyForceInteraction most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.
Type information: String
ViewDistance
Configures the distance in which other players will be able to see the effects of this interaction.
Type information: Number defaults to: 96.0
Effects
Sets effects that will be applied whilst the interaction is running.
Type information:
(Nullable)
InteractionEffects with the following properties:
| Key | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Particles | (Nullable) Array of the type:
ModelParticle
| Particles to play when triggering this interaction. | ||||||||||||||||||||||||||||||
| FirstPersonParticles | (Nullable) Array of the type:
ModelParticle
| Particles to play when triggering this interaction while in first person. | ||||||||||||||||||||||||||||||
| WorldSoundEventId | (Nullable) String | Sound to play when triggering this interaction. | ||||||||||||||||||||||||||||||
| LocalSoundEventId | (Nullable) String | Sound to play when triggering this interaction but only to the player that triggered it. | ||||||||||||||||||||||||||||||
| Trails | (Nullable) Array of the type:
ModelTrail
| The model trails to create when triggering this interaction | ||||||||||||||||||||||||||||||
| WaitForAnimationToFinish | Boolean defaults to: false | Whether this interaction should hold until the animation is finished before continuing. Generally this overrides the runtime of the interaction. | ||||||||||||||||||||||||||||||
| ItemPlayerAnimationsId | (Nullable) Either String or ItemPlayerAnimations | The item animations set to use while this interaction is active | ||||||||||||||||||||||||||||||
| ItemAnimationId | (Nullable) String | The item animation to play when triggering this interaction. | ||||||||||||||||||||||||||||||
| ClearAnimationOnFinish | Boolean defaults to: false | Whether any animations triggered by this interaction should be cleared when this interaction finishes. | ||||||||||||||||||||||||||||||
| ClearSoundEventOnFinish | Boolean defaults to: false | Whether any sound events triggered by this interaction should be cleared when this interaction finishes. | ||||||||||||||||||||||||||||||
| CameraEffect | (Nullable) Either String or CameraEffect | The camera effects to trigger while this interaction is active. | ||||||||||||||||||||||||||||||
| HideFirstPersonHeldItem | Boolean defaults to: false | Whether to hide the held item from the local player's own first-person view while this interaction is active. Other players still see the item. Default false. | ||||||||||||||||||||||||||||||
| MovementEffects | (Nullable)
MovementEffects
| The movement effects to apply while this interaction is active. | ||||||||||||||||||||||||||||||
| Zoom | (Nullable) ZoomConfig | Optional zoom configuration driving the shared client-side zoom system while this interaction step is active. See ZoomConfig for the available fields. By default the zoom clears when this step finishes; set PersistZoom to keep it applied for the rest of the chain (until the chain ends or a later step's zoom supersedes it). | ||||||||||||||||||||||||||||||
| PersistZoom | Boolean defaults to: false | Whether this step's Zoom keeps applying after the step finishes, covering the rest of the chain. Ignored when Zoom is absent. | ||||||||||||||||||||||||||||||
| StartDelay | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | An optional delay on applying any interaction effects. |
HorizontalSpeedMultiplier
The multiplier to apply to the horizontal speed of the entity whilst this interaction is running.
Type information:
(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RunTime
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.
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
OnItemChangeBehavior
What should happen to the interaction when the entity's held item changes.
Type information:
(Nullable) Any one of the following String (defaults to Cancel):
| Name | Description |
|---|---|
"Cancel" | |
"Fail" | |
"Finish" | |
"Ignore" |
CancelOnItemChange
Deprecated field for whether the interaction will be cancelled when the entity's held item changes.
Type information: Boolean
Rules
A set of rules that control when this interaction can run.
Type information:
InteractionRules with the following properties:
| Key | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BlockedBy | (Nullable) Array of the type: Any one of the following String:
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Blocking | Array of the type: Any one of the following String:
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: Any one of the following String:
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: Any one of the following String:
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlockingBypass | (Nullable) String | A tag that if matched will bypass the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InterruptedByBypass | (Nullable) String | A tag that if matched will bypass the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InterruptingBypass | (Nullable) String | A tag that if matched will bypass the |
Settings
Per a gamemode settings.
Type information:
(Nullable) Map of the following:
| Key | Type | Description |
|---|---|---|
| Adventure | InteractionSettings | |
| Creative | InteractionSettings |
Camera
Configures the camera behaviour for this interaction.
Type information:
(Nullable)
InteractionCameraSettings with the following properties:
| Key | Type | Description |
|---|---|---|
| FirstPerson | (Nullable) Array of the type: | |
| ThirdPerson | (Nullable) Array of the type: |
Next
The interactions to run when this interaction succeeds.
Type information:
(Nullable) Either String or Interaction
Reference to a Interaction asset
Failed
The interactions to run when this interaction fails.
Type information:
(Nullable) Either String or Interaction
Reference to a Interaction asset
Direction
The direction of the force to apply.
Type information:
(Nullable)
Vector3d with the following properties:
| Key | Type | Description |
|---|---|---|
| X | Number defaults to: 0.0 | |
| Y | Number defaults to: 0.0 | |
| Z | Number defaults to: 0.0 |
AdjustVertical
Whether the force should be adjusted based on the vertical look of the user.
Type information: Boolean
Force
The size of the force to apply.
Type information: Number
Forces
A collection of forces to apply to the user.
Replaces Direction, AdjustVertical and Force if used.
Type information:
Array of the type:
Force with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Direction | Vector3d
| The direction of the force to apply. | ||||||||||||
| AdjustVertical | Boolean defaults to: false | Whether the force should be adjusted based on the vertical look of the user. | ||||||||||||
| Force | Number defaults to: 1.0 | The size of the force to apply. |
Duration
The duration for which force should be continuously applied. If 0, force is applied on first run.
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
VerticalClamp
The angles in degrees to clamp the look angle to when adjusting the force
Type information:
(Nullable) Fixed size array of the following:
| Type |
|---|
Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ |
Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ |
WaitForGround
Determines whether or not on ground should be checked
Type information: Boolean defaults to: true
WaitForCollision
Determines whether or not collision should be checked
Type information: Boolean defaults to: false
RaycastDistance
The distance of the raycast for the collision check
Type information:
(Nullable) Either Number defaults to: 1.5 or String that matches the pattern: ^(-?Infinity|NaN)$
RaycastHeightOffset
The height offset of the raycast for the collision check (default 0)
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RaycastMode
The type of raycast performed for the collision check
Type information:
(Nullable) Any one of the following String (defaults to FollowMotion):
| Name | Description |
|---|---|
"FollowMotion" | |
"FollowLook" |
GroundCheckDelay
The delay in seconds before checking if on ground
Type information:
(Nullable) Either Number defaults to: 0.10000000149011612 or String that matches the pattern: ^(-?Infinity|NaN)$
CollisionCheckDelay
The delay in seconds before checking entity collision
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ChangeVelocityType
Configures how the velocity gets applied to the user.
Type information:
(Nullable) Any one of the following String (defaults to Set):
| Name | Description |
|---|---|
"Add" | Adds the velocity to any existing velocity |
"Set" | Changes the velocity to the given value. Overriding existing values. |
VelocityConfig
Specific configuration options that control how the velocity is affected.
Type information:
(Nullable)
VelocityConfig with the following properties:
| Key | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| GroundResistance | (Nullable) Either Number defaults to: 0.8199999928474426 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||
| GroundResistanceMax | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||
| AirResistance | (Nullable) Either Number defaults to: 0.9599999785423279 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||
| AirResistanceMax | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |||||||
| Threshold | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The threshold of the velocity's length before resistance starts to transition to the Max values (if set) | ||||||
| Style | (Nullable) Any one of the following String (defaults to Linear):
VelocityThresholdStyle
| Whether the transition from min to max resistance values should be linear or not |
GroundNext
The interaction to run if on-ground is apparent.
Type information:
(Nullable) Either String or Interaction
Reference to a Interaction asset
CollisionNext
The interaction to run if collision is apparent.
Type information:
(Nullable) Either String or Interaction
Reference to a Interaction asset
UseTargetBlockForDirection
Determines whether to align the direction to the target block of the interaction chain.
The interaction ignores Direction and Forces if this is used, only the settings in the root
of the interaction will be used.
Type information: Boolean defaults to: false
Tags
Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.
For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.
Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|---|
any String | Array of String |
Notes:
Types referenced by this type
EntityPart
Any one of the following String (defaults to Self):
| Name | Description |
|---|---|
"Self" | |
"Entity" | |
"PrimaryItem" | |
"SecondaryItem" |
EntityPart (1)
(Nullable) Any one of the following String (defaults to Self):
| Name | Description |
|---|---|
"Self" | |
"Entity" | |
"PrimaryItem" | |
"SecondaryItem" |