HytaleDocs
Misc

ModifyRulesEffect

Type

This field controls the type, it must be set to the constant value "ModifyRules" to function as this type.

Type information: Constant value: ModifyRules

Event

Type information: (Nullable) String

Interval

Type information:

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

Delay

Type information:

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

Entry

Type information: Integer

MatchKey

Type information: (Nullable) String defaults to: ``

MatchValue

Type information: (Nullable) String

Radius

Type information: Number defaults to: 50.0

Center

Type information:

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

NameDescription
"Volume"
"Entity"
"Event"

Operation

Type information:

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

NameDescription
"Set"
"Append"
"SetField"
"Remove"
"SetRulesActive"

Rule

Type information:

(Nullable) Any of these:

Key: TypeType
CreativePlacement
CreativePlacementRule

CreativePlacementRule with the following properties:

KeyTypeDescription
TypeConstant value: CreativePlacement

This field controls the type, it must be set to the constant value "CreativePlacement" to function as this type.

EnabledBoolean
DamageMultiplier
DamageMultiplierRule

DamageMultiplierRule with the following properties:

KeyTypeDescription
TypeConstant value: DamageMultiplier

This field controls the type, it must be set to the constant value "DamageMultiplier" to function as this type.

EnabledBoolean
Multiplier(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Direction(Nullable) Direction
EntityFilter(Nullable) RuleEntityFilter
Entities(Nullable) Array of String
Fly
FlyRule

FlyRule with the following properties:

KeyTypeDescription
TypeConstant value: Fly

This field controls the type, it must be set to the constant value "Fly" to function as this type.

EnabledBoolean
NoBuild
NoBuildRule

NoBuildRule with the following properties:

KeyTypeDescription
TypeConstant value: NoBuild

This field controls the type, it must be set to the constant value "NoBuild" to function as this type.

EnabledBoolean
ExceptBlocks(Nullable) Array of String
ExceptBlockTags(Nullable) Array of String
Target(Nullable) DenySignalTarget
MatchKey(Nullable) String
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
SignalKeys(Nullable) Array of String
SignalValues(Nullable) Array of String
NoDamage
NoDamageRule

NoDamageRule with the following properties:

KeyTypeDescription
TypeConstant value: NoDamage

This field controls the type, it must be set to the constant value "NoDamage" to function as this type.

EnabledBoolean
EntityFilter(Nullable) RuleEntityFilter
Entities(Nullable) Array of String
PvpOnlyBoolean
NoDestroyNoDestroyRule
NoDoorOpen
NoDoorOpenRule

NoDoorOpenRule with the following properties:

KeyTypeDescription
TypeConstant value: NoDoorOpen

This field controls the type, it must be set to the constant value "NoDoorOpen" to function as this type.

EnabledBoolean
Target(Nullable) DenySignalTarget
MatchKey(Nullable) String
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
SignalKeys(Nullable) Array of String
SignalValues(Nullable) Array of String
NoHarvest
NoHarvestRule

NoHarvestRule with the following properties:

KeyTypeDescription
TypeConstant value: NoHarvest

This field controls the type, it must be set to the constant value "NoHarvest" to function as this type.

EnabledBoolean
ExceptBlocks(Nullable) Array of String
ExceptBlockTags(Nullable) Array of String
Target(Nullable) DenySignalTarget
MatchKey(Nullable) String
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
SignalKeys(Nullable) Array of String
SignalValues(Nullable) Array of String
NoHeal
NoHealRule

NoHealRule with the following properties:

KeyTypeDescription
TypeConstant value: NoHeal

This field controls the type, it must be set to the constant value "NoHeal" to function as this type.

EnabledBoolean
NoTick
NoTickRule

NoTickRule with the following properties:

KeyTypeDescription
TypeConstant value: NoTick

This field controls the type, it must be set to the constant value "NoTick" to function as this type.

EnabledBoolean
ScheduledTickBoolean defaults to: true
RandomTickBoolean defaults to: true
NoUse
NoUseRule

NoUseRule with the following properties:

KeyTypeDescription
TypeConstant value: NoUse

This field controls the type, it must be set to the constant value "NoUse" to function as this type.

EnabledBoolean
ExceptBlocks(Nullable) Array of String
ExceptBlockTags(Nullable) Array of String
Target(Nullable) DenySignalTarget
MatchKey(Nullable) String
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
SignalKeys(Nullable) Array of String
SignalValues(Nullable) Array of String

FieldKey

Type information: (Nullable) String

Active

Type information: Boolean defaults to: true

Notes:

Types referenced by this type

Direction

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

NameDescription
"Received"
"Dealt"
"Both"

RuleEntityFilter

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

NameDescription
"All"
"Except"
"Only"

DenySignalTarget

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

NameDescription
"Self"
"Other"
"Both"

On this page