HytaleDocs
Misc

DeployableTurretConfig

Type

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

Type information: Constant value: Turret

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

TrackableRadius

The radius in which a targeted entity can be tracked

Type information:

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

DetectionRadius

The radius in which an entity can be targeted

Type information:

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

RotationSpeed

The speed at which the turret can rotate to hit it's target

Type information:

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

PreferOwnerTarget

If true, will prefer targeting entities that the owner is attacking

Type information: Boolean defaults to: false

Ammo

The total ammo the turret has, each projectile will consume one

Type information: Integer defaults to: 0

DeployDelay

The delay in seconds until the deployable is ready to begin targeting logic

Type information:

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

ProjectileConfig

Type information:

ProjectileConfig

ShotInterval

Type information:

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

BurstCount

Type information: Integer defaults to: 0

BurstCooldown

Type information:

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

ProjectileDamage

Type information:

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

CanShootOwner

Type information: Boolean defaults to: false

Knockback

Type information:

(Nullable) Any of these:

Key: TypeType
default case: Directional
DirectionalKnockback

DirectionalKnockback with the following properties:

KeyTypeDescription
Type(Nullable) String

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

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

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
RelativeXNumber defaults to: 0.0
VelocityYNumber defaults to: 0.0
RelativeZNumber defaults to: 0.0
Force
ForceKnockback

ForceKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Force

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

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

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
DirectionVector3d
Point
PointKnockback

PointKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Point

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

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

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
VelocityYNumber defaults to: 0.0
RotateYInteger defaults to: 0
OffsetXInteger defaults to: 0
OffsetZInteger defaults to: 0

TargetOffset

Type information:

(Nullable)

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0

DoLineOfSightTest

Type information: Boolean defaults to: true

ProjectileHitWorldSoundEventId

The positioned sound event played to surrounding players when the projectile hits a player

Type information: (Nullable) String

ProjectileHitLocalSoundEventId

The positioned sound event played to a player hit by the projectile

Type information: (Nullable) String

RespectTeams

Type information: Boolean defaults to: true

ProjectileSpawnOffsets

Type information:

(Nullable) Map of the following:

KeyType
any String
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0

Notes:

Types referenced by this type

ChangeVelocityType

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

NameDescription
"Add"

Adds the velocity to any existing velocity

"Set"

Changes the velocity to the given value. Overriding existing values.

On this page