HytaleDocs
TriggerVolumes

Effects

Asset path: Server/TriggerVolumes/Effects/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another TriggerEffectAsset 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

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:

KeyType
any StringArray of String

Conditions

Type information:

(Nullable) Array of the type: Any of these:

Key: TypeType
BlockTypeCondition
BlockTypeCondition

BlockTypeCondition with the following properties:

KeyTypeDescription
TypeConstant value: BlockTypeCondition

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

Event(Nullable) String
EntryInteger
BlockType(Nullable) Array of String
PositionSource(Nullable) PositionSource
PositionOffset(Nullable) Vector3d
RotationX(Nullable) AxisRotation
RotationY(Nullable) AxisRotation
RotationZ(Nullable) AxisRotation
State(Nullable) String
CooldownCondition
CooldownCondition

CooldownCondition with the following properties:

KeyTypeDescription
TypeConstant value: CooldownCondition

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

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

EntityCountCondition with the following properties:

KeyTypeDescription
TypeConstant value: EntityCountCondition

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

Event(Nullable) String
EntryInteger
Comparison(Nullable) Comparison
CountInteger defaults to: 1
EntityType(Nullable) Array of String
GameModeCondition
GameModeCondition

GameModeCondition with the following properties:

KeyTypeDescription
TypeConstant value: GameModeCondition

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

Event(Nullable) String
EntryInteger
GameMode(Nullable) GameMode
ItemConditionItemCondition
PermissionCondition
PermissionCondition

PermissionCondition with the following properties:

KeyTypeDescription
TypeConstant value: PermissionCondition

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

Event(Nullable) String
EntryInteger
Permission(Nullable) String defaults to:
PlayerCountCondition
PlayerCountCondition

PlayerCountCondition with the following properties:

KeyTypeDescription
TypeConstant value: PlayerCountCondition

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

Event(Nullable) String
EntryInteger
Comparison(Nullable) Comparison
CountInteger defaults to: 1
RandomChanceCondition
RandomChanceCondition

RandomChanceCondition with the following properties:

KeyTypeDescription
TypeConstant value: RandomChanceCondition

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

Event(Nullable) String
EntryInteger
Chance(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
TagConditionTagCondition
TimeOfDay
TimeOfDayCondition

TimeOfDayCondition with the following properties:

KeyTypeDescription
TypeConstant value: TimeOfDay

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

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

Effects

Type information:

(Nullable) Array of the type: Any of these:

Key: TypeType
CancelParticles
CancelParticlesEffect

CancelParticlesEffect with the following properties:

KeyTypeDescription
TypeConstant value: CancelParticles

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
ParticleSystems(Nullable) Array of String
InstantBoolean
ClearRespawnPoints
ClearRespawnPointsEffect

ClearRespawnPointsEffect with the following properties:

KeyTypeDescription
TypeConstant value: ClearRespawnPoints

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Name(Nullable) String
AllPlayersBoolean defaults to: false
ControlDoors
ControlDoorsEffect

ControlDoorsEffect with the following properties:

KeyTypeDescription
TypeConstant value: ControlDoors

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Action(Nullable) DoorAction
DamageEntity
DamageEntityEffect

DamageEntityEffect with the following properties:

KeyTypeDescription
TypeConstant value: DamageEntity

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Mode(Nullable) DamageMode
Amount(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DeleteVolume
DeleteVolumeEffect

DeleteVolumeEffect with the following properties:

KeyTypeDescription
TypeConstant value: DeleteVolume

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MatchKey(Nullable) String defaults to:
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Center(Nullable) Center
DeleteGroupBoolean
DisableVolume
DisableVolumeEffect

DisableVolumeEffect with the following properties:

KeyTypeDescription
TypeConstant value: DisableVolume

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MatchKey(Nullable) String defaults to:
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Center(Nullable) Center
EnableVolume
EnableVolumeEffect

EnableVolumeEffect with the following properties:

KeyTypeDescription
TypeConstant value: EnableVolume

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MatchKey(Nullable) String defaults to:
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Center(Nullable) Center
EntityEffect
EntityEffectEffect

EntityEffectEffect with the following properties:

KeyTypeDescription
TypeConstant value: EntityEffect

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Effect(Nullable) String
Mode(Nullable) Mode
Duration(Nullable) Either Number defaults to: -1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
GiveItem
GiveItemEffect

GiveItemEffect with the following properties:

KeyTypeDescription
TypeConstant value: GiveItem

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Item(Nullable) String
QuantityInteger defaults to: 1
OverflowBehavior(Nullable) OverflowBehavior
ModifyRulesModifyRulesEffect
ModifyTagsModifyTagsEffect
PastePrefabPastePrefabEffect
PlaceBlockPlaceBlockEffect
PlayAnimation
PlayAnimationEffect

PlayAnimationEffect with the following properties:

KeyTypeDescription
TypeConstant value: PlayAnimation

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
NpcType(Nullable) String defaults to:
Animation(Nullable) String
Target(Nullable) Target
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
StopBoolean defaults to: false
PlaySoundPlaySoundEffect
PlayVfxPlayVfxEffect
RemoveEntitiesRemoveEntitiesEffect
ReplaceBlockTypeReplaceBlockTypeEffect
RunRootInteraction
RunRootInteractionEffect

RunRootInteractionEffect with the following properties:

KeyTypeDescription
TypeConstant value: RunRootInteraction

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
RootInteraction(Nullable) String
InteractionType(Nullable) InteractionType
EquipSlotInteger defaults to: 0
SendMessage
SendMessageEffect

SendMessageEffect with the following properties:

KeyTypeDescription
TypeConstant value: SendMessage

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Message(Nullable) String
Recipient(Nullable) Recipient
SendSignalSendSignalEffect
SetGameMode
SetGameModeEffect

SetGameModeEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetGameMode

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
GameMode(Nullable) GameMode
SetMusic
SetMusicEffect

SetMusicEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetMusic

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MusicContainer(Nullable) String
ClearMusicBoolean defaults to: false
SetRespawnPoint
SetRespawnPointEffect

SetRespawnPointEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetRespawnPoint

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Origin(Nullable) EffectOrigin
Position(Nullable) Vector3d
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Name(Nullable) String
ClearExistingBoolean defaults to: true
SetVelocity
SetVelocityEffect

SetVelocityEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetVelocity

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Velocity(Nullable) Vector3d
AdditiveBoolean defaults to: false
RelativeMode(Nullable) RelativeMode
SetWeather
SetWeatherEffect

SetWeatherEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetWeather

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Weather(Nullable) String
PlayerOnlyBoolean defaults to: true
ResetWeatherBoolean defaults to: false
SetWorldSpawn
SetWorldSpawnEffect

SetWorldSpawnEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetWorldSpawn

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Origin(Nullable) EffectOrigin (1)
Position(Nullable) Vector3d
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ClearPlayerRespawnPointsBoolean defaults to: true
ShowEventTitleShowEventTitleEffect
SpawnNpcSpawnNpcEffect
TeleportTeleportEffect
TimeTimeEffect
TriggerNpcMarkers
TriggerNpcMarkersEffect

TriggerNpcMarkersEffect with the following properties:

KeyTypeDescription
TypeConstant value: TriggerNpcMarkers

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MarkerType(Nullable) String
RangeNumber
MatchTag(Nullable) String
RadiusNumber
Center(Nullable) Center

RejectionEffects

Type information:

(Nullable) Array of the type: Any of these:

Key: TypeType
CancelParticles
CancelParticlesEffect

CancelParticlesEffect with the following properties:

KeyTypeDescription
TypeConstant value: CancelParticles

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
ParticleSystems(Nullable) Array of String
InstantBoolean
ClearRespawnPoints
ClearRespawnPointsEffect

ClearRespawnPointsEffect with the following properties:

KeyTypeDescription
TypeConstant value: ClearRespawnPoints

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Name(Nullable) String
AllPlayersBoolean defaults to: false
ControlDoors
ControlDoorsEffect

ControlDoorsEffect with the following properties:

KeyTypeDescription
TypeConstant value: ControlDoors

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Action(Nullable) DoorAction
DamageEntity
DamageEntityEffect

DamageEntityEffect with the following properties:

KeyTypeDescription
TypeConstant value: DamageEntity

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Mode(Nullable) DamageMode
Amount(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DeleteVolume
DeleteVolumeEffect

DeleteVolumeEffect with the following properties:

KeyTypeDescription
TypeConstant value: DeleteVolume

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MatchKey(Nullable) String defaults to:
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Center(Nullable) Center
DeleteGroupBoolean
DisableVolume
DisableVolumeEffect

DisableVolumeEffect with the following properties:

KeyTypeDescription
TypeConstant value: DisableVolume

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MatchKey(Nullable) String defaults to:
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Center(Nullable) Center
EnableVolume
EnableVolumeEffect

EnableVolumeEffect with the following properties:

KeyTypeDescription
TypeConstant value: EnableVolume

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MatchKey(Nullable) String defaults to:
MatchValue(Nullable) String
RadiusNumber defaults to: 50.0
Center(Nullable) Center
EntityEffect
EntityEffectEffect

EntityEffectEffect with the following properties:

KeyTypeDescription
TypeConstant value: EntityEffect

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Effect(Nullable) String
Mode(Nullable) Mode
Duration(Nullable) Either Number defaults to: -1.0 or String that matches the pattern: ^(-?Infinity|NaN)$
GiveItem
GiveItemEffect

GiveItemEffect with the following properties:

KeyTypeDescription
TypeConstant value: GiveItem

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Item(Nullable) String
QuantityInteger defaults to: 1
OverflowBehavior(Nullable) OverflowBehavior
ModifyRulesModifyRulesEffect
ModifyTagsModifyTagsEffect
PastePrefabPastePrefabEffect
PlaceBlockPlaceBlockEffect
PlayAnimation
PlayAnimationEffect

PlayAnimationEffect with the following properties:

KeyTypeDescription
TypeConstant value: PlayAnimation

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
NpcType(Nullable) String defaults to:
Animation(Nullable) String
Target(Nullable) Target
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
StopBoolean defaults to: false
PlaySoundPlaySoundEffect
PlayVfxPlayVfxEffect
RemoveEntitiesRemoveEntitiesEffect
ReplaceBlockTypeReplaceBlockTypeEffect
RunRootInteraction
RunRootInteractionEffect

RunRootInteractionEffect with the following properties:

KeyTypeDescription
TypeConstant value: RunRootInteraction

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
RootInteraction(Nullable) String
InteractionType(Nullable) InteractionType
EquipSlotInteger defaults to: 0
SendMessage
SendMessageEffect

SendMessageEffect with the following properties:

KeyTypeDescription
TypeConstant value: SendMessage

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Message(Nullable) String
Recipient(Nullable) Recipient
SendSignalSendSignalEffect
SetGameMode
SetGameModeEffect

SetGameModeEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetGameMode

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
GameMode(Nullable) GameMode
SetMusic
SetMusicEffect

SetMusicEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetMusic

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MusicContainer(Nullable) String
ClearMusicBoolean defaults to: false
SetRespawnPoint
SetRespawnPointEffect

SetRespawnPointEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetRespawnPoint

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Origin(Nullable) EffectOrigin
Position(Nullable) Vector3d
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Name(Nullable) String
ClearExistingBoolean defaults to: true
SetVelocity
SetVelocityEffect

SetVelocityEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetVelocity

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Velocity(Nullable) Vector3d
AdditiveBoolean defaults to: false
RelativeMode(Nullable) RelativeMode
SetWeather
SetWeatherEffect

SetWeatherEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetWeather

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Weather(Nullable) String
PlayerOnlyBoolean defaults to: true
ResetWeatherBoolean defaults to: false
SetWorldSpawn
SetWorldSpawnEffect

SetWorldSpawnEffect with the following properties:

KeyTypeDescription
TypeConstant value: SetWorldSpawn

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
Origin(Nullable) EffectOrigin (1)
Position(Nullable) Vector3d
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ClearPlayerRespawnPointsBoolean defaults to: true
ShowEventTitleShowEventTitleEffect
SpawnNpcSpawnNpcEffect
TeleportTeleportEffect
TimeTimeEffect
TriggerNpcMarkers
TriggerNpcMarkersEffect

TriggerNpcMarkersEffect with the following properties:

KeyTypeDescription
TypeConstant value: TriggerNpcMarkers

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

Event(Nullable) String
Interval(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Delay(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
EntryInteger
MarkerType(Nullable) String
RangeNumber
MatchTag(Nullable) String
RadiusNumber
Center(Nullable) Center

Rules

Type information:

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

ConditionTiming

Type information:

(Nullable) Any one of the following String:

NameDescription
"BeforeVolumeDelay"
"AfterVolumeDelay"

TargetTypes

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"Player"
"Npc"
"ItemDrop"
"Projectile"

IncludeVolumeSettings

Type information: Boolean

VolumeTags

Type information:

(Nullable) Map of the following:

KeyType
any StringString

RejectionDelayMode

Type information:

(Nullable) Any one of the following String:

NameDescription
"Immediate"
"UseVolumeDelay"

Cooldown

Type information:

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

CooldownMode

Type information:

(Nullable) Any one of the following String:

NameDescription
"PerEntity"
"Total"

ActivationDelay

Type information:

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

ProjectileSource

Type information:

(Nullable) Any one of the following String:

NameDescription
"Shooter"
"Projectile"

KeepLoaded

Type information: Boolean

RotateEffectsOnPaste

Type information: Boolean

CancelDelayedOnExit

Type information: Boolean

Notes:

Types referenced by this type

PositionSource

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

NameDescription
"Event"
"VolumeOrigin"
"Entity"
"WorldAbsolute"

AxisRotation

(Nullable) Any one of the following String:

NameDescription
"Any"
"Deg0"
"Deg90"
"Deg180"
"Deg270"

Scope

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

NameDescription
"PerPlayer"
"WholeVolume"

Comparison

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

NameDescription
"AtLeast"
"AtMost"
"Exactly"
"NotEquals"
"MoreThan"
"LessThan"

GameMode

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

NameDescription
"Adventure"
"Creative"

DoorAction

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

NameDescription
"Open"
"Close"

DamageMode

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

NameDescription
"Flat"
"PercentMax"
"PercentCurrent"

Center

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

NameDescription
"Volume"
"Entity"
"Event"

Mode

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

NameDescription
"Apply"
"Remove"

OverflowBehavior

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

NameDescription
"DropRemainder"
"IgnoreRemainder"
"RequireFullStack"

Target

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

NameDescription
"TriggeringEntity"
"NpcsInVolume"

InteractionType

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

NameDescription
"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"

Recipient

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

NameDescription
"TriggeringPlayer"
"NearestPlayer"
"PlayersInVolume"
"AllPlayers"

EffectOrigin

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

NameDescription
"VolumeOrigin"
"Entity"
"Event"
"WorldAbsolute"

RelativeMode

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

NameDescription
"Absolute"
"VolumeOrigin"
"HorizontalFacing"
"FullLook"

EffectOrigin (1)

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

NameDescription
"VolumeOrigin"
"Entity"
"Event"
"WorldAbsolute"

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