ShowEventTitleAction
An action that shows an event title to players near a location.
Type
This field controls the type, it must be set to the constant value "ShowEventTitleAction" to function as this type.
Type information: Constant value: ShowEventTitleAction
LocationKey
The variable name of the location to show the title near.
Type information: String
Radius
The radius around the location within which players will see the title.
Type information: Integer defaults to: 0
PrimaryTitle
The main title text shown to players.
Type information: String
Style
The style the client uses to present the event title. Uses the default style if none is specificed.
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 use. May be omitted
Type information: (Nullable) String
SecondaryTitle
The subtitle text shown below the primary title.
Type information: (Nullable) String
Duration
How long the title stays on screen, in seconds. Defaults to 4.0 when unset.
Type information:
(Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$
FadeInDuration
How long the title takes to fade in, in seconds. Defaults to 1.5 when unset.
Type information:
(Nullable) Either Number defaults to: 1.5 or String that matches the pattern: ^(-?Infinity|NaN)$
FadeOutDuration
How long the title takes to fade out, in seconds. Defaults to 1.5 when unset.
Type information:
(Nullable) Either Number defaults to: 1.5 or String that matches the pattern: ^(-?Infinity|NaN)$
SoundFX
The sound to play for nearby players when the title is shown. Plays at a flat volume, with no distance falloff.
Type information:
(Nullable)
SoundFX with the following properties:
| Key | Type | Description |
|---|---|---|
| Effect | Either String or SoundEvent | The sound effect to send to nearby players. |
| MinVolumeDb | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | The minimum random volume to apply to the effect, in decibels. 0 is unity and the maximum. Both bounds must be set to randomise. |
| MaxVolumeDb | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | The maximum random volume to apply to the effect, in decibels. 0 is unity and the maximum. Both bounds must be set to randomise. |
| MinPitchSemitones | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | The minimum random pitch to apply to the effect, in semitones. Both bounds must be set to randomise. |
| MaxPitchSemitones | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | The maximum random pitch to apply to the effect, in semitones. Both bounds must be set to randomise. |
| VolumeMin | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | Deprecated linear multiplier. Use MinVolumeDb instead. |
| VolumeMax | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | Deprecated linear multiplier. Use MaxVolumeDb instead. |
| PitchMin | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | Deprecated linear multiplier. Use MinPitchSemitones instead. |
| PitchMax | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | Deprecated linear multiplier. Use MaxPitchSemitones instead. |
CameraFX
The camera effect to send to nearby players. Intensity falls off with distance from the location.
Type information:
(Nullable)
CameraFX with the following properties:
| Key | Type | Description |
|---|---|---|
| Effect | Either String or CameraEffect | The camera effect to apply to nearby players. |
| IntensityMin | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | The minimum intensity to apply for players furthest from effect origin position. |
| IntensityMax | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | The maximum intensity to apply for players closest to the effect origin position. |