Difference between revisions of "CutsceneDisplayStateManager"
From Headbone Creative
(Initial page) |
(Adding API information and categories) |
||
| Line 1: | Line 1: | ||
This class interfaces with the [[DisplayStateManager]] to show a different display state based upon the current cutscene. | This class interfaces with the [[DisplayStateManager]] to show a different display state based upon the current cutscene. | ||
| + | |||
| + | == Public Variables == | ||
| + | === config : List<CutsceneConfig> === | ||
| + | This is a list of objects that define what display state should be set for different cutscenes. The objects in this list contain two members: | ||
| + | public class CutsceneConfig { | ||
| + | public string cutsceneName = ""; | ||
| + | public string displayStateToUse = ""; | ||
| + | } | ||
| + | ==== cutsceneName : string ==== | ||
| + | This is the name of the cutscene that is passed into the PlayCutscene function (below). | ||
| + | ==== displayStateToUse : string ==== | ||
| + | This is the name of the state to set in the DisplayStateManager. | ||
| + | == Public Functions == | ||
| + | === bool CutsceneExists (string name) === | ||
| + | This returns true or false, depending if a CutsceneConfig with the given name was found in the list. | ||
| + | === void PlayCutscene (string name) === | ||
| + | This will call into the DisplayStateManager to set the new state, if a cutscene with the given name was found in the list. | ||
| + | |||
| + | [[Category:API]] | ||
| + | [[Category:Cutscene Framework]] | ||
| + | [[Category:Premium Scripts]] | ||
Latest revision as of 18:47, 15 April 2013
This class interfaces with the DisplayStateManager to show a different display state based upon the current cutscene.
Contents |
[edit] Public Variables
[edit] config : List<CutsceneConfig>
This is a list of objects that define what display state should be set for different cutscenes. The objects in this list contain two members:
public class CutsceneConfig {
public string cutsceneName = "";
public string displayStateToUse = "";
}
[edit] cutsceneName : string
This is the name of the cutscene that is passed into the PlayCutscene function (below).
[edit] displayStateToUse : string
This is the name of the state to set in the DisplayStateManager.
[edit] Public Functions
[edit] bool CutsceneExists (string name)
This returns true or false, depending if a CutsceneConfig with the given name was found in the list.
[edit] void PlayCutscene (string name)
This will call into the DisplayStateManager to set the new state, if a cutscene with the given name was found in the list.
