Entity
Stats
Asset path: Server/Entity/Stats/*.json
When set this asset will inherit properties from the named asset.
When inheriting from another EntityStatType 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 |
Type information:
Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Type information:
Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Type information:
Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Type information: Boolean defaults to: false
Type information:
(Nullable) Array of the type:
Regenerating with the following properties:
| Key | Type | Description |
|---|
| Interval | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| Amount | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| ClampAtZero | Boolean defaults to: false | Prevents this regenerating value from taking the stat value below zero. |
| RegenType | (Nullable) Any one of the following String:
RegenType
| Name | Description |
|---|
"Additive" | | "Percentage" | |
| |
| Conditions | (Nullable) Array of the type: Type Selector | |
| Modifiers | (Nullable) Array of the type:
RegeneratingModifier
RegeneratingModifier with the following properties:
| Key | Type | Description |
|---|
| Conditions | (Nullable) Array of the type: Type Selector | | | Amount | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| |
Type information:
(Nullable)
EntityStatEffects with the following properties:
| Key | Type | Description |
|---|
| TriggerAtZero | Boolean defaults to: false | Indicates that the effects should trigger when the stat reaches zero |
| SoundEventId | (Nullable) StringReference to a SoundEvent asset | |
| 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. |
| |
| Interactions | (Nullable) Either String or RootInteractionReference to a RootInteraction asset | |
Type information:
(Nullable)
EntityStatEffects with the following properties:
| Key | Type | Description |
|---|
| TriggerAtZero | Boolean defaults to: false | Indicates that the effects should trigger when the stat reaches zero |
| SoundEventId | (Nullable) StringReference to a SoundEvent asset | |
| 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. |
| |
| Interactions | (Nullable) Either String or RootInteractionReference to a RootInteraction asset | |
Type information:
(Nullable) Any one of the following String (defaults to InitialValue):
| Name | Description |
|---|
"InitialValue" | |
"MaxValue" | |
Type information: Boolean defaults to: false
Type information: Boolean defaults to: false
Types referenced by this 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 | 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. |
|
Any one of the following String:
| Name | Description |
|---|
"Adventure" | |
"Creative" | |
Any one of the following String:
(Nullable) Any one of the following String (defaults to Gte):
| Name | Description |
|---|
"Gte" | |
"Gt" | |
"Lte" | |
"Lt" | |
"Equal" | |
Any one of the following String (defaults to Self):
| Name | Description |
|---|
"Self" | |
"Entity" | |
"PrimaryItem" | |
"SecondaryItem" | |
