HytaleDocs

Models

Asset path: Server/Models/*.json

Parent

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

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

Model

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Characters/
  • Common/NPC/
  • Common/Items/
  • Common/VFX/

with the extension: *.blockymodel

Texture

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Characters/
  • Common/NPC/
  • Common/Items/
  • Common/VFX/

with the extension: *.png

GradientSet

Type information: (Nullable) String

GradientId

Type information: (Nullable) String

Icon

Type information: (Nullable) String

Reference to a common asset in the folders:

  • Common/Icons/ModelsGenerated/
  • Common/Icons/Models/

with the extension: *.png

IconProperties

Type information:

(Nullable)

AssetIconProperties with the following properties:

KeyTypeDescription
ScaleNumber defaults to: 0.0
Translation(Nullable) Fixed size array of the following:
Type
Number
Number
Rotation(Nullable) Fixed size array of the following:
Type
Number
Number
Number

Light

Type information:

(Nullable)

ColorLight with the following properties:

KeyTypeDescription
Color(Nullable) A color the form:

#RGB

RadiusInteger defaults to: 0

PhysicsValues

Type information:

(Nullable)

PhysicsValues with the following properties:

KeyTypeDescription
MassNumber defaults to: 1.0
DragCoefficientNumber defaults to: 0.5
InvertedGravityBoolean defaults to: false

MinScale

Type information: Number defaults to: 0.949999988079071

MaxScale

Type information: Number defaults to: 1.0499999523162842

EyeHeight

Type information: Number defaults to: 0.0

HitBox

Type information:

Box with the following properties:

KeyTypeDescription
Min(Nullable)
Vector3d

Vector3d with the following properties:

KeyTypeDescription
XNumber defaults to: 0.0
YNumber defaults to: 0.0
ZNumber defaults to: 0.0
Max(Nullable)
Vector3d

Vector3d with the following properties:

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

DetailBoxes

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of the type:
DetailBox

DetailBox with the following properties:

KeyTypeDescription
OffsetVector3d
BoxBox

CrouchOffset

Type information: Number defaults to: 0.0

SittingOffset

Type information: Number defaults to: 0.0

SleepingOffset

Type information: Number defaults to: 0.0

Camera

Type information:

(Nullable)

CameraSettings with the following properties:

KeyTypeDescription
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)$
Yaw(Nullable)
CameraAxis

CameraAxis with the following properties:

KeyTypeDescription
AngleRange(Nullable) Rangef
TargetNodesArray of the type: CameraNode
Pitch(Nullable)
CameraAxis

CameraAxis with the following properties:

KeyTypeDescription
AngleRange(Nullable) Rangef
TargetNodesArray of the type: CameraNode

DefaultAttachments

Type information:

(Nullable) Array of the type:

ModelAttachment with the following properties:

KeyTypeDescription
Model(Nullable) String

Reference to a common asset in the folders:

  • Common/Characters/
  • Common/NPC/
  • Common/Items/
  • Common/Cosmetics/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
with the extension: *.blockymodel
Texture(Nullable) String

Reference to a common asset in the folders:

  • Common/Characters/
  • Common/NPC/
  • Common/Items/
  • Common/Cosmetics/
  • Common/Items/
  • Common/NPC/
  • Common/Resources/
with the extension: *.png
GradientSet(Nullable) String
GradientId(Nullable) String
WeightNumber defaults to: 1.0

RandomAttachmentSets

Type information:

(Nullable) Map of the following:

KeyType
any StringMap of the following:
Map
KeyType
any StringModelAttachment

AnimationSets

Type information:

(Nullable) Map of the following:

KeyType
any String
AnimationSet

AnimationSet with the following properties:

KeyTypeDescription
AnimationsArray of the type: Animation
NextAnimationDelay(Nullable) Rangef

Particles

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.

Trails

Type information:

(Nullable) Array of the type:

ModelTrail with the following properties:

KeyTypeDescription
TrailId(Nullable) Either String or Trail

Reference to a Trail asset

TargetEntityPart(Nullable) Any one of the following String (defaults to Self):
EntityPart
NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"
TargetNodeName(Nullable) String
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)$
FixedRotationBoolean defaults to: false

Phobia

Enum used to specify if the NPC is part of a phobia (e.g. spider for arachnophobia).

Type information:

Any one of the following String (defaults to None):

NameDescription
"None"
"Arachnophobia"
"Ophidiophobia"

PhobiaModelAssetId

The model to use if the player has the setting with the matching phobia toggled on.

Type information: (Nullable) String

Reference to a ModelAsset asset

Notes:

Types referenced by this type

CameraNode

Any one of the following String:

NameDescription
"None"
"Head"
"LShoulder"
"RShoulder"
"Belly"

MacroCommands

Previous Page

Particles (ParticleSpawner)

Next Page

On this page

ParentTagsModelTextureGradientSetGradientIdIconIconPropertiesLightPhysicsValuesMinScaleMaxScaleEyeHeightHitBoxDetailBoxesCrouchOffsetSittingOffsetSleepingOffsetCameraDefaultAttachmentsRandomAttachmentSetsAnimationSetsParticlesTrailsPhobiaPhobiaModelAssetIdNotes:CameraNode