Adventure Creator  1.79.1
An adventure game toolkit for Unity, by Chris Burton, ICEBOX Studios 2013-2022
AC.Remember Class Reference
Inheritance diagram for AC.Remember:
AC.ConstantID AC.RememberActionListParameters AC.RememberAnimator AC.RememberCollider AC.RememberContainer AC.RememberConversation AC.RememberFootstepSounds AC.RememberGameCamera2DDrag AC.RememberHotspot AC.RememberMaterial AC.RememberMoveable AC.RememberName AC.RememberNavMesh2D AC.RememberNPC AC.RememberParticleSystem AC.RememberSceneItem AC.RememberShapeable AC.RememberSound AC.RememberTimeline AC.RememberTrack AC.RememberTrigger AC.RememberVariables AC.RememberVideoPlayer AC.RememberVisibility

Public Member Functions

virtual void LoadData (string stringData)
 Deserialises a string of data, and restores the GameObject to its previous state. Overridden by subclasses. More...
 
virtual IEnumerator LoadDataCo (string stringData)
 Deserialises a string of data, and restores the GameObject to its previous state. By default, this just runs LoadData - only override this if the loading process takes multiple frames More...
 
- Public Member Functions inherited from AC.ConstantID
virtual string SaveData ()
 Serialises appropriate GameObject values into a string. Overriden by subclasses. More...
 
int AssignInitialValue (bool forcePrefab=false)
 Sets a new Constant ID number. More...
 
void SetNewID_Prefab ()
 
void SetManualID (int _id)
 

Protected Attributes

bool savePrevented = false
 

Properties

bool SavePrevented [get, set]
 
virtual int LoadOrder [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from AC.ConstantID
static HashSet< T > GetComponents< T > (int constantIDValue)
 Gets all components in the Hierarchy that also have a ConstantID component on the same GameObject. More...
 
static T GetComponent< T > (int constantIDValue)
 Gets a component in the Hierarchy that also has a ConstantID component on the same GameObject. More...
 
static ConstantID GetComponent (int constantIDValue)
 Gets a ConstantID component in the Hierarchy with a given ID number. More...
 
static HashSet< T > GetComponents< T > (int constantIDValue, Scene scene)
 Gets all components of a particular type within the scene, with a given ConstantID number. More...
 
static HashSet< T > GetComponents< T > (Scene scene)
 Gets all components of a particular type within the scene. Only components with an associated ConstantID number will be returned. More...
 
static T GetComponent< T > (int constantIDValue, Scene scene, bool sceneOnlyPrioritises=false)
 Gets a component associated with a given ConstantID number, in a particular scene More...
 
static ConstantID GetComponent (int constantIDValue, Scene scene, bool sceneOnlyPrioritises=false)
 Gets a ConstantID component ID number, in a particular scene More...
 
static void FindLocalReferences (MenuCommand command)
 
static void FindGlobalReferences (MenuCommand command)
 
- Public Attributes inherited from AC.ConstantID
int constantID
 
bool retainInPrefab = false
 
AutoManual autoManual = AutoManual.Automatic
 
- Protected Member Functions inherited from AC.ConstantID
void OnEnable ()
 
virtual void Start ()
 
void OnDisable ()
 
virtual void OnInitialiseScene ()
 
bool[] StringToBoolArray (string _string)
 
int[] StringToIntArray (string _string)
 
float[] StringToFloatArray (string _string)
 
string[] StringToStringArray (string _string)
 
string ArrayToString< T > (T[] _list)
 
void Update ()
 

Detailed Description

A subclass of ConstantID, that is used to distinguish further subclasses from ConstantID components.

Member Function Documentation

◆ LoadData()

virtual void AC.Remember.LoadData ( string  stringData)
virtual

◆ LoadDataCo()

virtual IEnumerator AC.Remember.LoadDataCo ( string  stringData)
virtual

Deserialises a string of data, and restores the GameObject to its previous state. By default, this just runs LoadData - only override this if the loading process takes multiple frames

Parameters
stringDataThe data, serialised as a string

Reimplemented in AC.RememberTimeline, AC.RememberAnimator, AC.RememberSceneItem, AC.RememberVideoPlayer, AC.RememberMaterial, AC.RememberSound, and AC.RememberFootstepSounds.

Property Documentation

◆ LoadOrder

virtual int AC.Remember.LoadOrder
get

An integer used to sort the order in which this data is loaded, relative to other Remember components in the scene

◆ SavePrevented

bool AC.Remember.SavePrevented
getset

If True, saving is prevented