LoadingScreenBackgroundGameModeConfig

Inheritance 2 ancestors · 19 siblings

Class Documentation

The loading screen art and tips of a mode.

The client picks the background texture in this order:

Random. If UsingRandomLoadingScreen is set, or the RandomLoadingScreenBackground level property is 1, it takes a random entry of PossibleRandomLoadingScreenBackgrounds. If the list is empty or the entry is empty, it continues at step 3.
Level property. Otherwise, if the LoadingScreenBackground level property is not empty, it loads that path, with .png replaced by .tex. If the texture does not load, it continues at step 3.
Queue, then mode. It looks up the game's queue in LoadingScreenBackgroundOverride. A matching entry supplies the texture. With no match, LoadingScreenBackground does.

Whenever the chosen path is empty, the client shows its default texture. It also does so when the random step is taken in a mode that ships no object.

A level property is a named value the game session carries. Game mutators set them, so steps 1 and 2 let a mutator change the art without a change to this object.

Properties

LoadScreenTipConfiguration

Link<LoadScreenTipConfiguration> = "0x0"

Documentation Edit documentation

The LoadScreenTipConfiguration that the tips panel of the loading screen uses in this mode.

LoadingScreenBackground

File = "0x0"

Type history (2 revisions)

14.1 - 16.16 String
since 16.17 File

Documentation Edit documentation

The mode's default background texture. It is used in step 3, when no LoadingScreenBackgroundOverride entry matches the game's queue.

LoadingScreenBackgroundOverride

Map<String, File> = {}

Type history (2 revisions)

14.1 - 16.16 Map<String, String>
since 16.17 Map<String, File>

Documentation Edit documentation

Background textures per queue. The key is the QueueType of the game's MatchmakingQueue, which the client finds by the queue id of the game.

Examples:

The Teamfight Tactics map ships six keys, among them SET_REVIVAL_TFT, FIVE_YEAR_ANNIVERSARY_TFT and CHONCC_TREASURE.

MutatorControlledLoadingScreenBackgrounds

List2<File> = []

Type history (2 revisions)

14.1 - 16.16 List2<String>
since 16.17 List2<File>

Documentation Edit documentation

A list of background textures. No client code reads it. A mutator changes the background through the level properties of steps 1 and 2, and neither step looks at this list.

PossibleRandomLoadingScreenBackgrounds

List2<File> = []

14.20

Type history (2 revisions)

14.20 - 16.16 List2<String>
since 16.17 List2<File>

Documentation Edit documentation

The textures the random step picks from. Each entry has the same chance.

UsingRandomLoadingScreen

Bool = false

14.20

Documentation Edit documentation

When true, the client picks the background at random from PossibleRandomLoadingScreenBackgrounds (step 1). The RandomLoadingScreenBackground level property does the same for one game.