PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLoadLevel Class Reference

This script implements the sequencer command LoadLevel(levelName, [spawnpoint], [additive]). More...

Inheritance diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLoadLevel:
Collaboration diagram for PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLoadLevel:

Public Member Functions

void Start ()
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void Initialize (Sequencer sequencer, string endMessage, Transform speaker, Transform listener, params string[] parameters)
 Initializes the base properties.
 
void Initialize (Sequencer sequencer, Transform speaker, Transform listener, params string[] parameters)
 Initializes the base properties.
 

Additional Inherited Members

- Public Attributes inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
bool isPlaying = true
 Indicates whether the command is still playing.
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
void Stop ()
 Call this method to indicate that the command is done playing.
 
Transform GetSubject (string specifier, Transform defaultSubject=null)
 Sequencer commands usually specify a subject to which the command applies (e.g., where to aim the camera).
 
Transform GetSubject (int i, Transform defaultSubject=null)
 Sequencer commands usually specify a subject to which the command applies (e.g., where to aim the camera).
 
string GetParameter (int i, string defaultValue=null)
 Gets the i-th parameter (zero-based).
 
GetParameterAs< T > (int i, T defaultValue)
 Gets the i-th parameter (zero-based) as a specified type.
 
float GetParameterAsFloat (int i, float defaultValue=0)
 Gets the i-th parameter as a float.
 
int GetParameterAsInt (int i, int defaultValue=0)
 Gets the i-th parameter as an int.
 
bool GetParameterAsBool (int i, bool defaultValue=false)
 Gets the i-th parameter as a bool.
 
string GetParameters ()
 Gets the parameters as a comma-separated string.
 
bool IsAudioMuted ()
 Checks whether a Lua variable "Mute" is defined and true.
 
- Properties inherited from PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommand
Sequencer sequencer [get]
 Reference to the Sequencer, so you can access its properties such as SequencerCamera and CameraAngles.
 
string[] parameters [get]
 The parameters for the command.
 
string endMessage [get]
 Optional message to send the sequencer when the command completes.
 
Transform speaker [get]
 
Transform listener [get]
 

Detailed Description

This script implements the sequencer command LoadLevel(levelName, [spawnpoint], [additive]).

It tries, in order:

  • SaveSystem (to handle scene transitions and persistent data), or
  • LevelManager (to handle persistent data), or
  • manually calls PersistentDataManager.Record() to tell objects in the current level to record their persistent data first, and then it calls LevelWillBeUnloaded() to tell the objects to ignore the upcoming OnDestroy() if they have OnDestroy() handlers.

If a second parameter is included, it uses it as the player's spawnpoint in the new level.

If a third parameter named 'additive' is included, it loads the scene additively and does not use a spawnpoint.

Member Function Documentation

◆ Start()

void PixelCrushers.DialogueSystem.SequencerCommands.SequencerCommandLoadLevel.Start ( )
inline

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