HytaleDocs
Entity

ModelVFX

Asset path: Server/Entity/ModelVFX/*.json

Parent

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

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

SwitchTo

Type information:

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

NameDescription
"Disappear"
"PostColor"
"Distortion"
"Transparency"
"AlphaTransparency"

EffectDirection

Type information:

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

NameDescription
"None"
"BottomUp"
"TopDown"
"ToCenter"
"FromCenter"

AnimationDuration

Type information:

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

AnimationRange

Type information:

(Nullable)

Vector2f 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)$

LoopOption

Type information:

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

NameDescription
"PlayOnce"
"Loop"
"LoopMirror"

CurveType

Type information:

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

NameDescription
"Linear"
"QuartIn"
"QuartOut"
"QuartInOut"

HighlightColor

Type information:

(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

HighlightThickness

Type information:

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

UseBloomOnHighlight

Type information: Boolean defaults to: false

UseProgessiveHighlight

Type information: Boolean defaults to: false

NoiseScale

Type information:

(Nullable)

Vector2f 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)$

NoiseScrollSpeed

Type information:

(Nullable)

Vector2f 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)$

PostColor

Type information:

(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

PostColorOpacity

Type information:

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

Opacity

Type information:

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

On this page