HytaleDocs
Misc

DeployableTrapConfig

Type

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

Type information: Constant value: Trap

Id

Used to identify this deployable for uses such as MaxLiveCount

Type information: (Nullable) String

MaxLiveCount

The maximum amount of this deployable that can be live at once

Type information: Integer defaults to: 2147483647

Model

Type information: String

Reference to a ModelAsset asset

ModelPreview

Type information: (Nullable) String

Reference to a ModelAsset asset

ModelScale

Type information:

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

LiveDuration

The duration of the lifetime of the deployable in seconds

Type information:

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

Invulnerable

Whether this deployable is invulnerable to damage or not

Type information: Boolean defaults to: false

Stats

The default stat configuration for the deployable

Type information:

(Nullable) Map of the following:

KeyType
any String
StatConfig

StatConfig with the following properties:

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

The maximum value for the stat.

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

The initial value for the stat. If omitted, will be set to max.

DeploySoundEventId

The ID of the sound to play upon deployment (at deployment location)

Type information: (Nullable) String

DespawnSoundEventId

The ID of the sound to play when despawning

Type information: (Nullable) String

DieSoundEventId

The ID of the sound to play when despawning due to death

Type information: (Nullable) String

AmbientSoundEventId

The ID of the sound to play ambiently from the deployable while it's in the world

Type information: (Nullable) String

SpawnParticles

A collection of model particles to play when this deployable is spawned.

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartAny one of the following String (defaults to Self):
EntityPart
NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RotationOffset(Nullable)
Direction

Direction with the following properties:

KeyTypeDescription
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Pitch(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DetachedFromModelBoolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemoveBoolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

DespawnParticles

A collection of model particles to play when this deployable is despawned.

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartAny one of the following String (defaults to Self):
EntityPart
NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RotationOffset(Nullable)
Direction

Direction with the following properties:

KeyTypeDescription
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Pitch(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DetachedFromModelBoolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemoveBoolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

DebugVisuals

Whether or not to display debug visuals.

Type information: Boolean defaults to: false

AllowPlaceOnWalls

Whether or not this deployable can be placed on walls.

Type information: Boolean defaults to: false

WireframeDebugVisuals

Whether debug visuals will be wireframe or have color.

Type information: Boolean defaults to: false

HitboxCollisionConfig

The HitboxCollision config to apply to the deployable.

Type information: (Nullable) String

Reference to a HitboxCollisionConfig asset

CountTowardsGlobalLimit

Whether or not this deployable counts towards global deployable limit

Type information: Boolean defaults to: true

Shape

The shape of the detection area

Type information:

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

NameDescription
"Sphere"
"Cylinder"

StartRadius

The initial detection radius

Type information:

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

EndRadius

If set, the detection radius will expand to this size over the RadiusChangeTime (RadiusChangeTime must be set)

Type information:

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

Height

The height of the Shape, if using a cylinder shape

Type information:

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

RadiusChangeTime

The time (starting at spawn) it takes to change from StartRadius to EndRadius

Type information:

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

DamageInterval

The interval between damage being applied to targets in seconds

Type information:

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

DamageAmount

The amount of damage to apply to targets per interval

Type information:

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

DamageCause

The amount of damage to apply to targets per interval

Type information:

(Nullable) Either String or DamageCause

Reference to a DamageCause asset

ApplyEffects

Type information:

(Nullable) Array of the type: Either String or EntityEffect

Reference to a EntityEffect asset

AttackOwner

Whether or not the owner is affected by the attack & effect of this deployable

Type information: Boolean defaults to: false

AttackTeam

Whether or not the team is affected by the attack & effect of this deployable

Type information: Boolean defaults to: false

AttackEnemies

Whether or not this deployable interacts with non-team entities

Type information: Boolean defaults to: true

FuzeDuration

The time it will take for the trap to become active

Type information:

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

ActiveDuration

The time the trap will stay alive after getting triggered

Type information:

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

DestroyOnTriggered

Whether the trap will disappear when it's triggered by a players

Type information: Boolean defaults to: false

DeployableAoeConfig

Previous Page

DeployableTrapSpawnerConfig

Next Page

On this page

TypeIdMaxLiveCountModelModelPreviewModelScaleLiveDurationInvulnerableStatsDeploySoundEventIdDespawnSoundEventIdDieSoundEventIdAmbientSoundEventIdSpawnParticlesDespawnParticlesDebugVisualsAllowPlaceOnWallsWireframeDebugVisualsHitboxCollisionConfigCountTowardsGlobalLimitShapeStartRadiusEndRadiusHeightRadiusChangeTimeDamageIntervalDamageAmountDamageCauseApplyEffectsAttackOwnerAttackTeamAttackEnemiesFuzeDurationActiveDurationDestroyOnTriggered