EventTitleConfig
The text, style, icon and timing used to show an event title.
PrimaryTitle
The main line of the title.
Type information:
The main line of the title.
FormattedMessage with the following properties:
| Key | Type | Description | ||||
|---|---|---|---|---|---|---|
| RawText | (Nullable) String | |||||
| MessageId | (Nullable) String | |||||
| Params | (Nullable) Map of the following:
Map
| |||||
| MessageParams | (Nullable) Map of the following:
Map
| |||||
| Children | (Nullable) Array of the type: FormattedMessage | |||||
| Bold | (Nullable) (Nullable) Boolean | |||||
| Italic | (Nullable) (Nullable) Boolean | |||||
| Monospace | (Nullable) (Nullable) Boolean | |||||
| Underline | (Nullable) (Nullable) Boolean | |||||
| Strikethrough | (Nullable) (Nullable) Boolean | |||||
| Color | (Nullable) String | |||||
| Link | (Nullable) String |
SecondaryTitle
The line below the primary title. Leave it out for a title of one line.
Type information:
(Nullable) The line below the primary title. Leave it out for a title of one line.
FormattedMessage with the following properties:
| Key | Type | Description | ||||
|---|---|---|---|---|---|---|
| RawText | (Nullable) String | |||||
| MessageId | (Nullable) String | |||||
| Params | (Nullable) Map of the following:
Map
| |||||
| MessageParams | (Nullable) Map of the following:
Map
| |||||
| Children | (Nullable) Array of the type: FormattedMessage | |||||
| Bold | (Nullable) (Nullable) Boolean | |||||
| Italic | (Nullable) (Nullable) Boolean | |||||
| Monospace | (Nullable) (Nullable) Boolean | |||||
| Underline | (Nullable) (Nullable) Boolean | |||||
| Strikethrough | (Nullable) (Nullable) Boolean | |||||
| Color | (Nullable) String | |||||
| Link | (Nullable) String |
Style
The style the client uses to present the event title.
Type information:
(Nullable) Any one of the following String (defaults to Default):
| Name | Description |
|---|---|
"Default" | The standard event title presentation. |
"Major" | A major event title presentation. |
"GoblinBreach" | The presentation for a goblin breach. |
"VoidEviction" | The presentation for a void-presence eviction. |
Icon
The icon to show beside the title. Leave it empty for a title with no icon.
Type information: (Nullable) String
DurationS
The time in seconds the title stays on screen, after the fade in.
Type information:
(Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$
FadeInDurationS
The time in seconds the title takes to fade in.
Type information:
(Nullable) Either Number defaults to: 1.5 or String that matches the pattern: ^(-?Infinity|NaN)$
FadeOutDurationS
The time in seconds the title takes to fade out.
Type information:
(Nullable) Either Number defaults to: 1.5 or String that matches the pattern: ^(-?Infinity|NaN)$
SoundEventId
The sound event to play when the title is shown. Leave it out for a title with no sound.
Type information: (Nullable) String
Reference to a SoundEvent asset
Notes:
Types referenced by this type
Type 0
Any of these:
| Type |
|---|
Boolean |
Number |
Integer |
String |