Asset path: Server/Entity/Effects/*.json
When set this asset will inherit properties from the named asset.
When inheriting from another EntityEffect most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.
Type information: String
Tags 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 |
The name of this entity effect that will be displayed in the UI. This must be a localization key.
Type information: (Nullable) String
Type information:
(Nullable)
ApplicationEffects with the following properties:
| Key | Type | Description |
|---|
| EntityBottomTint | (Nullable) A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| |
| EntityTopTint | (Nullable) A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| |
| EntityAnimationId | (Nullable) String | |
| Particles | (Nullable) Array of the type:
ModelParticle
ModelParticle with the following properties:
| Key | Type | Description |
|---|
| SystemId | StringReference to a ParticleSystem asset | | | TargetEntityPart | EntityPart | | | TargetNodeName | (Nullable) String | | | Color | (Nullable) A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| | | 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 | (Nullable) Array of the type:
ModelParticle
ModelParticle with the following properties:
| Key | Type | Description |
|---|
| SystemId | StringReference to a ParticleSystem asset | | | TargetEntityPart | EntityPart | | | TargetNodeName | (Nullable) String | | | Color | (Nullable) A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| | | 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. |
| |
| ScreenEffect | (Nullable) StringReference to a common asset in the folder:
with the extension: *.png | |
| HorizontalSpeedMultiplier | Number defaults to: 1.0 | |
| KnockbackMultiplier | Number defaults to: 1.0 | |
| LocalSoundEventId | (Nullable) StringReference to a SoundEvent asset | Local sound event played to the affected player |
| WorldSoundEventId | (Nullable) StringReference to a SoundEvent asset | World sound event played to surrounding players |
| ModelVFXId | (Nullable) StringReference to a ModelVFX asset | |
| MovementEffects | (Nullable)
MovementEffects
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 |
| |
| AbilityEffects | (Nullable)
AbilityEffects
AbilityEffects with the following properties:
| Key | Type | Description |
|---|
| Disabled | (Nullable) Array of the type: InteractionType | A collection of interaction types to become disabled while the entity effect affiliated with this ability effect is active |
| Handles any effects applied that are affiliated with abilities |
| MouseSensitivityAdjustmentTarget | (Nullable) Either Number defaults to: 0.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: 0.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. |
Type information: (Nullable) String
Reference to a SoundEvent asset
Type information: (Nullable) String
Reference to a SoundEvent asset
Type information:
(Nullable)
DamageCalculator with the following properties:
| Key | Type | Description |
|---|
| Type | (Nullable) Any one of the following String (defaults to Absolute):
Type
| Name | Description |
|---|
"Dps" | | "Absolute" | |
| |
| Class | Any one of the following String (defaults to Unknown):
DamageClass
| Name | Description |
|---|
"Unknown" | | "Light" | | "Charged" | | "Signature" | |
| 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 the following:
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)$ | |
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Type information:
(Nullable)
DamageEffects with the following properties:
| Key | Type | Description |
|---|
| ModelParticles | (Nullable) Array of the type:
ModelParticle
ModelParticle with the following properties:
| Key | Type | Description |
|---|
| SystemId | StringReference to a ParticleSystem asset | | | TargetEntityPart | EntityPart | | | TargetNodeName | (Nullable) String | | | Color | (Nullable) A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| | | 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. |
| |
| WorldParticles | (Nullable) Array of the type:
WorldParticle
WorldParticle with the following properties:
| Key | Type | Description |
|---|
| SystemId | StringReference 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. |
| |
| LocalSoundEventId | (Nullable) StringReference to a SoundEvent asset | |
| WorldSoundEventId | (Nullable) StringReference to a SoundEvent asset | |
| PlayerSoundEventId | (Nullable) StringReference to a SoundEvent asset | The sound to play to a player receiving the damage. |
| ViewDistance | Number defaults to: 75.0 | |
| Knockback | (Nullable) Type Selector | |
| CameraEffect | (Nullable) Either String or CameraEffectReference 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. |
Effects to play when stat modifiers are applied and updated.
Type information:
(Nullable)
DamageEffects with the following properties:
| Key | Type | Description |
|---|
| ModelParticles | (Nullable) Array of the type:
ModelParticle
ModelParticle with the following properties:
| Key | Type | Description |
|---|
| SystemId | StringReference to a ParticleSystem asset | | | TargetEntityPart | EntityPart | | | TargetNodeName | (Nullable) String | | | Color | (Nullable) A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| | | 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. |
| |
| WorldParticles | (Nullable) Array of the type:
WorldParticle
WorldParticle with the following properties:
| Key | Type | Description |
|---|
| SystemId | StringReference 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. |
| |
| LocalSoundEventId | (Nullable) StringReference to a SoundEvent asset | |
| WorldSoundEventId | (Nullable) StringReference to a SoundEvent asset | |
| PlayerSoundEventId | (Nullable) StringReference to a SoundEvent asset | The sound to play to a player receiving the damage. |
| ViewDistance | Number defaults to: 75.0 | |
| Knockback | (Nullable) Type Selector | |
| CameraEffect | (Nullable) Either String or CameraEffectReference 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. |
Type information:
(Nullable)
ModelOverride with the following properties:
| Key | Type | Description |
|---|
| Model | (Nullable) StringReference to a common asset in the folders:
-
Common/Characters/
-
Common/NPC/
-
Common/Items/
-
Common/VFX/
with the extension: *.blockymodel | |
| Texture | (Nullable) StringReference to a common asset in the folders:
-
Common/Characters/
-
Common/NPC/
-
Common/Items/
-
Common/VFX/
with the extension: *.png | |
| AnimationSets | (Nullable) Map of the following:
Map
| |
A model to change the affected entity's appearance to.
Type information: (Nullable) String
Reference to a ModelAsset asset
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|
StringReference to a EntityStatType asset | Array of the type:
StaticModifier
StaticModifier with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Static | This field controls the type, it must be set to the constant value "Static" to function as this type. | | Target | (Nullable) ModifierTarget | | | CalculationType | CalculationType | | | Amount | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
|
Modifiers to apply to EntityStats.
Type information:
(Nullable) Map of the following:
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.
Type information:
Any one of the following String (defaults to Absolute):
| Name | Description |
|---|
"Percent" | |
"Absolute" | |
Value used by default unless specified otherwise in the method's call.
Type information:
(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Value used by default unless specified otherwise in the method's call.
Type information:
(Nullable) Any one of the following String (defaults to Ignore):
| Name | Description |
|---|
"Extend" | |
"Overwrite" | |
"Ignore" | |
Value used by default unless specified otherwise in the method's call.
Type information: Boolean defaults to: false
Value used by default unless specified otherwise in the method's call.
Type information: Boolean defaults to: false
Value used by default unless specified otherwise in the method's call.
Type information: (Nullable) String
Value used by default unless specified otherwise in the method's call.
Type information:
(Nullable) Any one of the following String (defaults to Complete):
| Name | Description |
|---|
"Complete" | |
"Infinite" | |
"Duration" | |
Determines whether this effect applies the invulnerable component to the entity whilst active.
Type information: Boolean defaults to: false
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|
StringReference to a DamageCause asset | Array of the type:
ResistanceModifier
ResistanceModifier with the following properties:
| Key | Type | Description |
|---|
| CalculationType | ResistanceCalculationType | When using 'Percent', the amount represents a percentage reduction. For example, 0.25 equals 25% reduction. | | Amount | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
|
Modifiers applied to damage DEALT by the entity carrying this effect, keyed by damage cause (parent causes match their children). Positive Percent amounts increase the damage (0.25 = +25%); Flat amounts add before the percent scaling.
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|
StringReference to a DamageCause asset | Array of the type:
ResistanceModifier
ResistanceModifier with the following properties:
| Key | Type | Description |
|---|
| CalculationType | ResistanceCalculationType | When using 'Percent', the amount represents a percentage reduction. For example, 0.25 equals 25% reduction. | | Amount | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
|
Localization key used on the death screen when this EntityEffect kills a player.
Type information: (Nullable) String
Conditions that must ALL be true for this effect to remain active. If any condition fails, the effect is removed.
Type information:
(Nullable) Array of the type: Any of these:
Key: Id | Type |
|---|
| Alive | AliveCondition
AliveCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Alive | This field controls the type, it must be set to the constant value "Alive" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Charging | ChargingCondition
ChargingCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Charging | This field controls the type, it must be set to the constant value "Charging" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Delay | Number | The delay duration within which a recent charge is considered valid. | | UseIgnoreFlag | Boolean defaults to: false | If true, the IgnoreForFlaggedConditions on matching interactions will be adhered to. |
|
| CheckPlayerGameMode | CheckPlayerGameModeCondition
CheckPlayerGameModeCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: CheckPlayerGameMode | This field controls the type, it must be set to the constant value "CheckPlayerGameMode" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | GameMode | GameMode | The game mode to check for. If null, the condition always passes. |
|
| Environment | EnvironmentCondition
EnvironmentCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Environment | This field controls the type, it must be set to the constant value "Environment" to function as this type. | | Inverse | Boolean 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:
| Key | Type | Description |
|---|
| Id | Constant value: Gliding | This field controls the type, it must be set to the constant value "Gliding" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| HasEffect | HasEffectCondition
HasEffectCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: HasEffect | This field controls the type, it must be set to the constant value "HasEffect" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | EffectId | (Nullable) StringReference 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:
| Key | Type | Description |
|---|
| Id | Constant value: InFluid | This field controls the type, it must be set to the constant value "InFluid" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | FluidIds | (Nullable) Array of StringReference 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:
| Key | Type | Description |
|---|
| Id | Constant value: IsPlayer | This field controls the type, it must be set to the constant value "IsPlayer" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| LogicCondition | LogicCondition
LogicCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: LogicCondition | This field controls the type, it must be set to the constant value "LogicCondition" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Operator | Operator | The logical operator to combine the conditions. | | Conditions | Array of the type: Type Selector (1) | The array of conditions to be evaluated. |
|
| NoDamageTaken | NoDamageTakenCondition
NoDamageTakenCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: NoDamageTaken | This field controls the type, it must be set to the constant value "NoDamageTaken" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Delay | Number | The delay duration for the no damage taken condition. |
|
| OutOfCombat | OutOfCombatCondition
OutOfCombatCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: OutOfCombat | This field controls the type, it must be set to the constant value "OutOfCombat" to function as this type. | | Inverse | Boolean 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:
| Key | Type | Description |
|---|
| Id | Constant value: RegenHealth | This field controls the type, it must be set to the constant value "RegenHealth" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Sprinting | SprintingCondition
SprintingCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Sprinting | This field controls the type, it must be set to the constant value "Sprinting" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Stat | StatCondition
StatCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Stat | This field controls the type, it must be set to the constant value "Stat" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Stat | StringReference to a EntityStatType asset | The stat to evaluate the condition against. | | Amount | Either 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:
| Key | Type | Description |
|---|
| Id | Constant value: Suffocating | This field controls the type, it must be set to the constant value "Suffocating" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Wielding | WieldingCondition
WieldingCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Wielding | This field controls the type, it must be set to the constant value "Wielding" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | UseIgnoreFlag | Boolean defaults to: false | If true, the IgnoreForFlaggedConditions on matching interactions will be adhered to. |
|
Types referenced by this type
Any one of the following String (defaults to Self):
| Name | Description |
|---|
"Self" | |
"Entity" | |
"PrimaryItem" | |
"SecondaryItem" | |
Any one of the following String:
| Name | Description |
|---|
"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" | |
Any of these:
Key: Type | Type |
|---|
default case: Directional | DirectionalKnockback
DirectionalKnockback with the following properties:
| Key | Type | Description |
|---|
| Type | (Nullable) String | This field controls the type, it must be set to the constant value "Directional" to function as this type. | | Force | Number 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 | | | RelativeX | Number defaults to: 0.0 | | | VelocityY | Number defaults to: 0.0 | | | RelativeZ | Number defaults to: 0.0 | |
|
| Force | ForceKnockback
ForceKnockback with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Force | This field controls the type, it must be set to the constant value "Force" to function as this type. | | Force | Number 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 | | | Direction | Vector3d | |
|
| Point | PointKnockback
PointKnockback with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Point | This field controls the type, it must be set to the constant value "Point" to function as this type. | | Force | Number 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 | | | VelocityY | Number defaults to: 0.0 | | | RotateY | Integer defaults to: 0 | | | OffsetX | Integer defaults to: 0 | | | OffsetZ | Integer defaults to: 0 | |
|
(Nullable) Any one of the following String (defaults to Add):
| Name | Description |
|---|
"Add" | Adds the velocity to any existing velocity |
"Set" | Changes the velocity to the given value. Overriding existing values. |
(Nullable) Any one of the following String (defaults to Max):
| Name | Description |
|---|
"Min" | |
"Max" | |
Any one of the following String:
| Name | Description |
|---|
"Additive" | |
"Multiplicative" | |
Any one of the following String:
| Name | Description |
|---|
"Flat" | |
"Percent" | |
Any one of the following String:
| Name | Description |
|---|
"Adventure" | |
"Creative" | |
Any one of the following String:
Any of these:
Key: Id | Type |
|---|
| Alive | AliveCondition
AliveCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Alive | This field controls the type, it must be set to the constant value "Alive" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Charging | ChargingCondition
ChargingCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Charging | This field controls the type, it must be set to the constant value "Charging" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Delay | Number | The delay duration within which a recent charge is considered valid. | | UseIgnoreFlag | Boolean defaults to: false | If true, the IgnoreForFlaggedConditions on matching interactions will be adhered to. |
|
| CheckPlayerGameMode | CheckPlayerGameModeCondition
CheckPlayerGameModeCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: CheckPlayerGameMode | This field controls the type, it must be set to the constant value "CheckPlayerGameMode" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | GameMode | GameMode | The game mode to check for. If null, the condition always passes. |
|
| Environment | EnvironmentCondition
EnvironmentCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Environment | This field controls the type, it must be set to the constant value "Environment" to function as this type. | | Inverse | Boolean 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:
| Key | Type | Description |
|---|
| Id | Constant value: Gliding | This field controls the type, it must be set to the constant value "Gliding" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| HasEffect | HasEffectCondition
HasEffectCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: HasEffect | This field controls the type, it must be set to the constant value "HasEffect" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | EffectId | (Nullable) StringReference 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:
| Key | Type | Description |
|---|
| Id | Constant value: InFluid | This field controls the type, it must be set to the constant value "InFluid" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | FluidIds | (Nullable) Array of StringReference 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:
| Key | Type | Description |
|---|
| Id | Constant value: IsPlayer | This field controls the type, it must be set to the constant value "IsPlayer" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| LogicCondition | LogicCondition
LogicCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: LogicCondition | This field controls the type, it must be set to the constant value "LogicCondition" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Operator | Operator | The logical operator to combine the conditions. | | Conditions | Array of the type: Type Selector (1) | The array of conditions to be evaluated. |
|
| NoDamageTaken | NoDamageTakenCondition
NoDamageTakenCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: NoDamageTaken | This field controls the type, it must be set to the constant value "NoDamageTaken" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Delay | Number | The delay duration for the no damage taken condition. |
|
| OutOfCombat | OutOfCombatCondition
OutOfCombatCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: OutOfCombat | This field controls the type, it must be set to the constant value "OutOfCombat" to function as this type. | | Inverse | Boolean 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:
| Key | Type | Description |
|---|
| Id | Constant value: RegenHealth | This field controls the type, it must be set to the constant value "RegenHealth" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Sprinting | SprintingCondition
SprintingCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Sprinting | This field controls the type, it must be set to the constant value "Sprinting" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Stat | StatCondition
StatCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Stat | This field controls the type, it must be set to the constant value "Stat" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | Stat | StringReference to a EntityStatType asset | The stat to evaluate the condition against. | | Amount | Either 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:
| Key | Type | Description |
|---|
| Id | Constant value: Suffocating | This field controls the type, it must be set to the constant value "Suffocating" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. |
|
| Wielding | WieldingCondition
WieldingCondition with the following properties:
| Key | Type | Description |
|---|
| Id | Constant value: Wielding | This field controls the type, it must be set to the constant value "Wielding" to function as this type. | | Inverse | Boolean defaults to: false | Determines whether the condition is inverted. | | UseIgnoreFlag | Boolean defaults to: false | If true, the IgnoreForFlaggedConditions on matching interactions will be adhered to. |
|
(Nullable) Any one of the following String (defaults to Gte):
| Name | Description |
|---|
"Gte" | |
"Gt" | |
"Lte" | |
"Lt" | |
"Equal" | |
