ScreenTemplate Class Reference

A "template" class that represents a screen state that can be animated to show or hide itself. More...

Public Member Functions
virtual void	PlayScreen ()
	Default behavior stops all Coroutines, then starts a Coroutine to play the screen.

Protected Member Functions
virtual void	Awake ()
	Default behavior is to get all the FAST.AudioClipFromFiles that are children of this GameObject and add them to FAST.ScreenTemplate.audioLUT.
virtual void	OnDisable ()
	Default behavior stops all Coroutines, which could be playing or clearing the screen.
virtual void	OnEnable ()
	Default behavior plays the screen.
IEnumerator	PlayScreenAnimation ()
	The Coroutine you must define to animate playing the screen.
virtual IEnumerator	PlayScreenCoroutine ()

Protected Attributes
bool	_isPlaying = false
	Inspector, Code This attribute backs the FAST.ScreenTemplate.IsPlaying property.
Dictionary< string, AudioClipFromFile >	audioLUT = new()
	Code All the FAST.AudioClipFromFiles that are children of this GameObject and should be considered audio available for this screen to use.
AudioPlayer	audioPlayer
	Inspector, Code A reference to a FAST.AudioPlayer that will be used for playback of sequential audio.

Properties
bool	IsPlaying [get]
	Code Returns true when the screen is playing its animation.

Detailed Description

A "template" class that represents a screen state that can be animated to show or hide itself.

Inherit from this class to define a base screen class with modified or additional functionality specific to your activity. Then, inherit from that base screen class to define each screen in the activity and the specifics needed to animate it.

See also

UnityEngine.GameObject

UnityEngine.Coroutine

Member Function Documentation

Awake()

virtual void Awake ( )

protectedvirtual

Default behavior is to get all the FAST.AudioClipFromFiles that are children of this GameObject and add them to FAST.ScreenTemplate.audioLUT.

OnDisable()

virtual void OnDisable ( )

protectedvirtual

Default behavior stops all Coroutines, which could be playing or clearing the screen.

OnEnable()

virtual void OnEnable ( )

protectedvirtual

Default behavior plays the screen.

PlayScreen()

virtual void PlayScreen ( )

virtual

Default behavior stops all Coroutines, then starts a Coroutine to play the screen.

PlayScreenAnimation()

IEnumerator PlayScreenAnimation ( )

abstractprotected

The Coroutine you must define to animate playing the screen.

PlayScreenCoroutine()

virtual IEnumerator PlayScreenCoroutine ( )

protectedvirtual

Default behavior runs a Coroutine to animate playing the screen.

Member Data Documentation

_isPlaying

bool _isPlaying = false

protected

Inspector, Code
This attribute backs the FAST.ScreenTemplate.IsPlaying property.

audioLUT

Dictionary<string, AudioClipFromFile> audioLUT = new()

protected

Code
All the FAST.AudioClipFromFiles that are children of this GameObject and should be considered audio available for this screen to use.

audioPlayer

AudioPlayer audioPlayer

protected

Inspector, Code
A reference to a FAST.AudioPlayer that will be used for playback of sequential audio.

Property Documentation

IsPlaying

bool IsPlaying

get

Code
Returns true when the screen is playing its animation.

---

The documentation for this class was generated from the following file:

• C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/Screen Management/ScreenTemplate.cs