Adventure Creator  1.79.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2022
AC.SubScene Class Reference
Inheritance diagram for AC.SubScene:

Public Member Functions

void Initialise (MultiSceneChecker _multiSceneChecker)
 Syncs the component with the correct scene. More...
 
void MakeMain ()
 

Protected Attributes

int sceneIndex
 
string sceneName
 
LocalVariables localVariables
 
SceneSettings sceneSettings
 
KickStarter kickStarter
 
MainCamera mainCamera
 

Properties

int SceneIndex [get]
 
string SceneName [get]
 
LocalVariables LocalVariables [get]
 
SceneSettings SceneSettings [get]
 

Detailed Description

This component keeps track of data regarding any scene added to the active scene during gameplay. It is generated automatically by the sub-scene's MultiSceneChecker, and should not be added manually.

Member Function Documentation

◆ Initialise()

void AC.SubScene.Initialise ( MultiSceneChecker  _multiSceneChecker)

Syncs the component with the correct scene.

Parameters
_multiSceneCheckerThe MultiSceneChecker component in the scene for which this component is to sync with.

◆ MakeMain()

void AC.SubScene.MakeMain ( )

Prepares the sub-scene to become the new active scene, due to the active scene being removed. The gameobject will be destroyed afterwards.

Property Documentation

◆ LocalVariables

LocalVariables AC.SubScene.LocalVariables
get

Gets the LocalVariables for the scene that this component represents.

◆ SceneIndex

int AC.SubScene.SceneIndex
get

Gets the build index of the scene that this component represents.

◆ SceneName

string AC.SubScene.SceneName
get

Gets the name the scene that this component represents.

◆ SceneSettings

SceneSettings AC.SubScene.SceneSettings
get

Gets the SceneSettings for the scene that this component represents.