Entity
UI
Asset path: Server/Entity/UI/*.json
This object has different properties depending on the value of the Type property.
All possible options are listed below:
CombatTextUIComponent with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: CombatText | This field controls the type, it must be set to the constant value "CombatText" to function as this type. |
| Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another CombatTextUIComponent 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. |
| HitboxOffset | (Nullable)
Vector2f
Vector2f with the following properties:
| Key | Type | Description |
|---|
| X | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | | | Y | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| Offset from the centre of the entity's hitbox to display this component. |
| RandomPositionOffsetRange | RangeVector2f
RangeVector2f with the following properties:
| The maximum range for randomly offsetting text instances from their starting position. Values are treated as absolute and apply in both directions of the axis. |
| ViewportMargin | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The minimum distance (in px) from the edges of the viewport that text instances should clamp to. |
| Duration | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The duration for which text instances in this component should be visible. |
| HitAngleModifierStrength | (Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | Strength of the modifier to apply to the X axis of a position animation (if set) based on the angle of a melee attack. |
| FontSize | (Nullable) Either Number defaults to: 68.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The font size to apply to text instances. |
| TextColor | A color in the form:
-
#RRGGBB
-
rgb(rrr, ggg, bbb)
| The text color to apply to text instances. |
| AnimationEvents | Array of the type: Type Selector | Animation events for controlling animation of scale, position, and opacity. |
| Tags | (Nullable) Map of the following:
Map
| Key | Type |
|---|
any String | Array of String |
| 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. |
EntityStatUIComponent with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: EntityStat | This field controls the type, it must be set to the constant value "EntityStat" to function as this type. |
| Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another EntityStatUIComponent 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. |
| HitboxOffset | (Nullable)
Vector2f
Vector2f with the following properties:
| Key | Type | Description |
|---|
| X | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | | | Y | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| Offset from the centre of the entity's hitbox to display this component. |
| EntityStat | String that matches the pattern: [^\s] and is at least 1 characters longReference to a EntityStatType asset | The entity stat to represent. |
| Tags | (Nullable) Map of the following:
Map
| Key | Type |
|---|
any String | Array of String |
| 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. |
Types referenced by this type
Any of these:
Key: Type | Type |
|---|
| Opacity | CombatTextUIComponentOpacityAnimationEvent
CombatTextUIComponentOpacityAnimationEvent with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Opacity | This field controls the type, it must be set to the constant value "Opacity" to function as this type. | | Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another CombatTextUIComponentOpacityAnimationEvent 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. | | StartAt | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The percentage of the display duration at which this event should begin. | | EndAt | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The percentage of the display duration at which this event should end. | | StartOpacity | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The opacity that should be applied to text instances before the animation event begins. | | EndOpacity | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The opacity that should be applied to text instances by the end of the animation. | | Tags | (Nullable) Map | 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. |
|
| Position | CombatTextUIComponentPositionAnimationEvent
CombatTextUIComponentPositionAnimationEvent with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Position | This field controls the type, it must be set to the constant value "Position" to function as this type. | | Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another CombatTextUIComponentPositionAnimationEvent 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. | | StartAt | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The percentage of the display duration at which this event should begin. | | EndAt | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The percentage of the display duration at which this event should end. | | PositionOffset | Vector2f | The offset from the starting position that the text instance should animate to. | | Tags | (Nullable) Map | 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. |
|
| Scale | CombatTextUIComponentScaleAnimationEvent
CombatTextUIComponentScaleAnimationEvent with the following properties:
| Key | Type | Description |
|---|
| Type | Constant value: Scale | This field controls the type, it must be set to the constant value "Scale" to function as this type. | | Parent | String | When set this asset will inherit properties from the named asset.
When inheriting from another CombatTextUIComponentScaleAnimationEvent 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. | | StartAt | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The percentage of the display duration at which this event should begin. | | EndAt | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The percentage of the display duration at which this event should end. | | StartScale | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The scale that should be applied to text instances before the animation event begins. | | EndScale | Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | The scale that should be applied to text instances by the end of the animation. | | Tags | (Nullable) Map | 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. |
|
(Nullable) Map of the following:
| Key | Type |
|---|
any String | Array of String |
