ORK Framework  2.27.1
API Documentation
ORKFramework.SceneTarget Class Reference
Inheritance diagram for ORKFramework.SceneTarget:
ORKFramework.BaseData ORKFramework.ISaveData ORKFramework.IBaseData

Public Member Functions

 SceneTarget (string name, int id)
 
SceneTarget GetCopy ()
 
string GetSceneName ()
 
bool LoadScene ()
 
void SpawnPlayer ()
 
void Spawn (GameObject obj)
 
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Public Attributes

bool isVar = false
 
string sceneName = ""
 
LoadSceneMode loadSceneMode = LoadSceneMode.Single
 
bool loadAsync = false
 
SceneTargetType type = SceneTargetType.SpawnID
 
Vector3 position = Vector3.zero
 
float yRot = 0
 
int spawnID = 0
 
string variableKey = ""
 

Properties

bool Exists [get]
 
bool IsLoaded [get]
 

Member Function Documentation

◆ LoadGame()

void ORKFramework.SceneTarget.LoadGame ( DataObject  data)

Used to load the data - you need to get the data from the ORKFramework.DataObject.

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

◆ SaveGame()

DataObject ORKFramework.SceneTarget.SaveGame ( )

Used to save the data - you need to add the data to a ORKFramework.DataObject.

Returns
A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.