Difference between revisions of "Cutscene"
(Initial page) |
(→Custom Editor: Added the image) |
||
| (One intermediate revision by one user not shown) | |||
| Line 3: | Line 3: | ||
==Events== | ==Events== | ||
It exposes events to handle most of the functions from the interface, each of which have this function signature: | It exposes events to handle most of the functions from the interface, each of which have this function signature: | ||
| − | public delegate void CutsceneNotification () | + | '''public delegate void CutsceneNotification ()''' |
| − | ===public event CutsceneNotification OnCutsceneStart | + | ===public event CutsceneNotification OnCutsceneStart=== |
| − | ===public event CutsceneNotification OnCutsceneReset | + | This is called when the cutscene is starting. |
| − | ===public event CutsceneNotification OnCutsceneUpdate | + | ===public event CutsceneNotification OnCutsceneReset=== |
| − | ===public event CutsceneNotification OnCutsceneFinished | + | This is called when the cutscene is resetting. |
| + | ===public event CutsceneNotification OnCutsceneUpdate=== | ||
| + | This is called every frame that the cutscene is active to update the cutscene. | ||
| + | ===public event CutsceneNotification OnCutsceneFinished=== | ||
| + | This is called when the cutscene is finished. | ||
==Flags== | ==Flags== | ||
This class also keeps an internal “isComplete” flag, and exposes a setter function that can be used by the cutscene commands to notify the cutscene when they have completed. | This class also keeps an internal “isComplete” flag, and exposes a setter function that can be used by the cutscene commands to notify the cutscene when they have completed. | ||
| − | + | '''public void SetComplete (bool _complete)''' | |
==Custom Editor== | ==Custom Editor== | ||
| + | [[File:Cutscene.png|right|Cutscene Editor]] | ||
The Cutscene class also has functions for getting the CompoundCutscene list to which the cutscene belongs to. This is for easily manipulating the cutscene in the editor. | The Cutscene class also has functions for getting the CompoundCutscene list to which the cutscene belongs to. This is for easily manipulating the cutscene in the editor. | ||
In the editor, the Cutscene will display “registered” if it’s in the list of the CompoundCutscene directly above the Cutscene in the Hierarchy window. If it’s not in the list, it will display “unregistered”. There is a button to change whether the Cutscene is registered or not. If unregistered and re-registered, the cutscene will be placed at the bottom of the list of Cutscenes in the CompoundCutscene. | In the editor, the Cutscene will display “registered” if it’s in the list of the CompoundCutscene directly above the Cutscene in the Hierarchy window. If it’s not in the list, it will display “unregistered”. There is a button to change whether the Cutscene is registered or not. If unregistered and re-registered, the cutscene will be placed at the bottom of the list of Cutscenes in the CompoundCutscene. | ||
| + | === cutsceneName : string === | ||
| + | This is the name of the cutscene clip. Changing this will also set the name of the game object the cutscene is attached to. | ||
| + | [[Category:API]] | ||
[[Category:Cutscene Framework]] | [[Category:Cutscene Framework]] | ||
| + | [[Category:Premium Scripts]] | ||
Latest revision as of 03:16, 15 April 2013
This script implements the CutsceneCmdInterface. Every Cutscene Command requires this type of script to be attached as well.
Contents |
[edit] Events
It exposes events to handle most of the functions from the interface, each of which have this function signature: public delegate void CutsceneNotification ()
[edit] public event CutsceneNotification OnCutsceneStart
This is called when the cutscene is starting.
[edit] public event CutsceneNotification OnCutsceneReset
This is called when the cutscene is resetting.
[edit] public event CutsceneNotification OnCutsceneUpdate
This is called every frame that the cutscene is active to update the cutscene.
[edit] public event CutsceneNotification OnCutsceneFinished
This is called when the cutscene is finished.
[edit] Flags
This class also keeps an internal “isComplete” flag, and exposes a setter function that can be used by the cutscene commands to notify the cutscene when they have completed. public void SetComplete (bool _complete)
[edit] Custom Editor
The Cutscene class also has functions for getting the CompoundCutscene list to which the cutscene belongs to. This is for easily manipulating the cutscene in the editor. In the editor, the Cutscene will display “registered” if it’s in the list of the CompoundCutscene directly above the Cutscene in the Hierarchy window. If it’s not in the list, it will display “unregistered”. There is a button to change whether the Cutscene is registered or not. If unregistered and re-registered, the cutscene will be placed at the bottom of the list of Cutscenes in the CompoundCutscene.
[edit] cutsceneName : string
This is the name of the cutscene clip. Changing this will also set the name of the game object the cutscene is attached to.
