HytaleDocs
Misc

Regenerating

Interval

Type information:

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

Amount

Type information:

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

ClampAtZero

Prevents this regenerating value from taking the stat value below zero.

Type information: Boolean defaults to: false

RegenType

Type information:

(Nullable) Any one of the following String:

NameDescription
"Additive"
"Percentage"

Conditions

Type information:

(Nullable) Array of the type: 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

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.

Modifiers

Type information:

(Nullable) Array of the type:

RegeneratingModifier with the following properties:

KeyTypeDescription
Conditions(Nullable) Array of the type: Type Selector
Amount(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Notes:

Types referenced by this type

GameMode

Any one of the following String:

NameDescription
"Adventure"
"Creative"

Operator

Any one of the following String:

NameDescription
"And"
"Or"

Type Selector

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

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.

StatComparisonType

(Nullable) Any one of the following String (defaults to Gte):

NameDescription
"Gte"
"Gt"
"Lte"
"Lt"
"Equal"

On this page