Adventure Creator 1.84.3
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2024
Loading...
Searching...
No Matches
AC.SceneInfo Class Reference

Public Member Functions

 SceneInfo (int _buildIndex, string _filename, bool _addedToBuildSettings=true)
bool IsCurrentActive ()
 Checks if this represents the currently-active main scene.
bool Open (bool forceReload=false)
 Loads the scene normally.
void Add ()
void Close (bool evenIfCurrent=false)
AsyncOperation OpenAsync (LoadSceneMode loadSceneMode=LoadSceneMode.Single)
 Loads the scene asynchronously.

Properties

string Filename [get]
int BuildIndex [get]

Detailed Description

A data container for an actual scene in the build.

Constructor & Destructor Documentation

◆ SceneInfo()

AC.SceneInfo.SceneInfo ( int _buildIndex,
string _filename,
bool _addedToBuildSettings = true )

The default constructor

Member Function Documentation

◆ Add()

void AC.SceneInfo.Add ( )

Adds the scene additively.

◆ Close()

void AC.SceneInfo.Close ( bool evenIfCurrent = false)

Closes the scene additively.

◆ IsCurrentActive()

bool AC.SceneInfo.IsCurrentActive ( )

Checks if this represents the currently-active main scene.

Returns
True if this represents the currently-active main scene

◆ Open()

bool AC.SceneInfo.Open ( bool forceReload = false)

Loads the scene normally.

Parameters
forceReloadIf True, the scene will be re-loaded if it is already open.

◆ OpenAsync()

AsyncOperation AC.SceneInfo.OpenAsync ( LoadSceneMode loadSceneMode = LoadSceneMode::Single)

Loads the scene asynchronously.

Returns
The generated AsyncOperation class

Property Documentation

◆ BuildIndex

int AC.SceneInfo.BuildIndex
get

The scene's build index number

◆ Filename

string AC.SceneInfo.Filename
get

The scene's filename, without extension or filepath