InteractionEffects
Particles
Particles to play when triggering this interaction.
Type information:
(Nullable) Array of the type:
ModelParticle with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| SystemId | String | |||||||||||||
| TargetEntityPart | Any one of the following String (defaults to Self):
EntityPart
| |||||||||||||
| TargetNodeName | (Nullable) String | |||||||||||||
| Color | (Nullable) A color in the form:
| |||||||||||||
| Scale | Number defaults to: 1.0 | |||||||||||||
| PositionOffset | (Nullable)
Vector3f
| |||||||||||||
| RotationOffset | (Nullable)
Direction
| |||||||||||||
| DetachedFromModel | Boolean defaults to: false | To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space. | ||||||||||||
| ClearParticlesOnRemove | Boolean defaults to: false | When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan. |
FirstPersonParticles
Particles to play when triggering this interaction while in first person.
Type information:
(Nullable) Array of the type:
ModelParticle with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| SystemId | String | |||||||||||||
| TargetEntityPart | Any one of the following String (defaults to Self):
EntityPart
| |||||||||||||
| TargetNodeName | (Nullable) String | |||||||||||||
| Color | (Nullable) A color in the form:
| |||||||||||||
| Scale | Number defaults to: 1.0 | |||||||||||||
| PositionOffset | (Nullable)
Vector3f
| |||||||||||||
| RotationOffset | (Nullable)
Direction
| |||||||||||||
| DetachedFromModel | Boolean defaults to: false | To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space. | ||||||||||||
| ClearParticlesOnRemove | Boolean defaults to: false | When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan. |
WorldSoundEventId
Sound to play when triggering this interaction.
Type information: (Nullable) String
Reference to a SoundEvent asset
LocalSoundEventId
Sound to play when triggering this interaction but only to the player that triggered it.
Type information: (Nullable) String
Reference to a SoundEvent asset
Trails
The model trails to create when triggering this interaction
Type information:
(Nullable) Array of the type:
ModelTrail with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| TrailId | (Nullable) Either String or Trail | |||||||||||||
| TargetEntityPart | (Nullable) Any one of the following String (defaults to Self):
EntityPart
| |||||||||||||
| TargetNodeName | (Nullable) String | |||||||||||||
| PositionOffset | (Nullable)
Vector3f
| |||||||||||||
| RotationOffset | (Nullable)
Direction
| |||||||||||||
| FixedRotation | Boolean defaults to: false |
WaitForAnimationToFinish
Whether this interaction should hold until the animation is finished before continuing. Generally this overrides the runtime of the interaction.
Type information: Boolean defaults to: false
ItemPlayerAnimationsId
The item animations set to use while this interaction is active
Type information:
(Nullable) Either String or ItemPlayerAnimations
Reference to a ItemPlayerAnimations asset
ItemAnimationId
The item animation to play when triggering this interaction.
Type information: (Nullable) String
ClearAnimationOnFinish
Whether any animations triggered by this interaction should be cleared when this interaction finishes.
Type information: Boolean defaults to: false
ClearSoundEventOnFinish
Whether any sound events triggered by this interaction should be cleared when this interaction finishes.
Type information: Boolean defaults to: false
CameraEffect
The camera effects to trigger while this interaction is active.
Type information:
(Nullable) Either String or CameraEffect
Reference to a CameraEffect asset
HideFirstPersonHeldItem
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.
Type information: Boolean defaults to: false
MovementEffects
The movement effects to apply while this interaction is active.
Type information:
(Nullable)
MovementEffects with the following properties:
| Key | Type | Description |
|---|---|---|
| DisableAll | Boolean defaults to: false | Determines whether all movement input is disabled |
| DisableForward | Boolean defaults to: false | Determines whether forwards movement input is disabled |
| DisableBackward | Boolean defaults to: false | Determines whether backwards movement input is disabled |
| DisableLeft | Boolean defaults to: false | Determines whether left-strafe movement input is disabled |
| DisableRight | Boolean defaults to: false | Determines whether right-strafe movement input is disabled |
| DisableSprint | Boolean defaults to: false | Determines whether sprint input is disabled |
| DisableJump | Boolean defaults to: false | Determines whether jump input is disabled |
| DisableCrouch | Boolean defaults to: false | Determines whether crouch input is disabled |
| SpeedMultiplier | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The multiplier applied to the entity's movement speed |
Zoom
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).
Type information:
(Nullable) Configuration for the shared client-side zoom system.
Adding a Zoom block to an interaction step's Effects makes that step drive the zoom while it is active. All values are optional and fall back to sensible defaults.
ZoomConfig with the following properties:
| Key | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| MagnificationMultiplier | (Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | How many times narrower the field of view becomes while zoomed (relative to the player's FoV). | ||||||||
| MouseSensitivityMultiplier | (Nullable) Either Number defaults to: 0.5 or String that matches the pattern: ^(-?Infinity|NaN)$ | Mouse sensitivity multiplier applied while zoomed (lower = steadier aim). | ||||||||
| OverlayTexture | (Nullable) String | Optional screen-effect texture drawn over the screen while zoomed. | ||||||||
| DepthOfField | Boolean defaults to: false | Whether to enable a depth-of-field post effect while zoomed. | ||||||||
| AllowCameraOrbit | Boolean defaults to: false | Whether the free-rotate orbit camera is allowed while zoomed. When false (the default), an active orbit ends when the zoom begins and orbit cannot be started while zoomed, since its pull-back distance is field-of-view derived. | ||||||||
| ForcePerspective | (Nullable) Any one of the following String (defaults to None):
ForcedPerspective
| Temporarily forces the player's camera perspective while zoomed, restoring it afterwards. None leaves the perspective untouched; FirstPerson and ThirdPerson switch a player in the other perspective. | ||||||||
| LodMultiplier | (Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Scales entity level-of-detail distances while zoomed so distant things keep updating. 0 means scale with MagnificationMultiplier. | ||||||||
| TransitionLerp | (Nullable) Either Number defaults to: 0.4000000059604645 or String that matches the pattern: ^(-?Infinity|NaN)$ | Shared field-of-view interpolation factor for zooming in and out: a unitless lerp weight in the 0-1 range applied each fixed movement tick (higher snaps faster, 1 is instant). | ||||||||
| InLerp | (Nullable) Either Number defaults to: 0.4000000059604645 or String that matches the pattern: ^(-?Infinity|NaN)$ | Optional override for the zoom-in FoV lerp. Falls back to TransitionLerp. | ||||||||
| OutLerp | (Nullable) Either Number defaults to: 0.4000000059604645 or String that matches the pattern: ^(-?Infinity|NaN)$ | Optional override for the zoom-out FoV lerp. Falls back to TransitionLerp. | ||||||||
| OverlayFade | Boolean defaults to: true | Whether the overlay fades in/out (false = snap on/off instantly). | ||||||||
| OverlayFadePerSecond | (Nullable) Either Number defaults to: 3.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Shared overlay fade rate in units per second: the overlay alpha eases toward its target at this rate (higher = faster). | ||||||||
| OverlayFadeInPerSecond | (Nullable) Either Number defaults to: 3.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Optional override for the overlay fade-in rate. Falls back to OverlayFadePerSecond. | ||||||||
| OverlayFadeOutPerSecond | (Nullable) Either Number defaults to: 3.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Optional override for the overlay fade-out rate. Falls back to OverlayFadePerSecond. |
PersistZoom
Whether this step's Zoom keeps applying after the step finishes, covering the rest of the chain. Ignored when Zoom is absent.
Type information: Boolean defaults to: false
StartDelay
An optional delay on applying any interaction effects.
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$