Click or drag to resize

Managers

Most video-games require a host of managers to handle things like UI, sounds, and effects. The most common of these are included in the kit. What follows is a cheat-sheet of the most useful methods in the included managers. Consult the manager reference pages linked at the bottom for a more in-depth look at the features and options available.

UIManager

All of the methods return a UniTask which completes after respective animations have ended and can be await-ed upon.

Method(s)

Description

Show

Instantiate and show a window from a prefab.

Hide

Hide a window with a name.

WindowShow

Show a given window.

WindowHide

Hide a given window.

ResourceManager

All of the ResourceManager methods provide async versions which should be the ones you use to perform I/O operations for a smoother experience.

Method(s)

Description

Load

Load a resource.

Unload

Unload a resource.

ReadText / ReadBytes

Read the contents of a file in text/binary mode.

Save

Save the contents of an object to a file.

SaveText / SaveBytes

Save a string or byte-array to a file.

Delete

Delete a file.

Exists

Check whether a file exists.

SceneDirector

All of the methods return a UniTask which completes after fading is done and can be await-ed as well.

Method(s)

Description

FadeIn

Fade in the screen.

FadeOut

Fade out the screen.

LoadScene

Load a scene with fading.

ReloadScene

Reload the scene with fading.

AudioManager

Method(s)

Description

PlaySound

Play general sounds.

PlayUI

Play UI sounds.

PlayMusic / PauseMusic / StopMusic

Handle background music.

Play(AudioSource)

Spawn an AudioSource in the world and pool it.

Play(AudioClip, Boolean, Boolean)

Play an AudioClip with a dedicated AudioSource.

EffectsManager

Method(s)

Description

Spawn

Spawn and pool a particle effect.

Despawn

Despawn a particle effect.

DespawnAll

Despawn all particle effects.

SettingsManager
See Also