Public Member Functions
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.

int	Save ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.

int	Synchronize ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.

int	Delete ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.

override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

Public Member Functions inherited from DepictionEngine.JsonScriptableObject
override void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.

Public Member Functions inherited from DepictionEngine.PropertyScriptableObject
override void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.

void	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.

override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

override bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

Public Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
virtual void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.

bool	Initialize ()
	Needs to be called before the object can be used. Objects created through the DepictionEngine.InstanceManager should automatically Initialize the object.

virtual void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.

InitializationContext	GetInitializeContext ()

bool	IsDisposing ()
	Is the object disposing?.

bool	IsDisposed ()
	Has the object been disposed?

void	Originator (Action callback, IScriptableBehaviour originator)
	Provides the code executed in this callback information about the DepictionEngine.IScriptableBehaviour that triggered it by keeping a reference available under DepictionEngine.IScriptableBehaviour.originator.

bool	OnDisposing ()

bool	UpdateDisposingContext (bool forceUpdate=false)
	This is where you clear or dispose any remaining references. It will be called automatically by DepictionEngine.DisposeManager immediately after DepictionEngine.IDisposable.OnDisposing unless the object was Destroyed as a result of an Editor action.

void	OnDisposeInternal (DisposeContext disposeContext)

virtual bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

void	OnDestroy ()
	This is where you destroy any remaining dependencies.

virtual void	OnBeforeSerialize ()

virtual void	OnAfterDeserialize ()

virtual void	OnValidate ()

bool	Equals (Disposable.Null value)

override bool	Equals (object value)

override int	GetHashCode ()

Public Member Functions inherited from DepictionEngine.IScriptableBehaviour
InitializationContext	GetInitializeContext ()

void	Originator (Action callback, IScriptableBehaviour originator)
	Provides the code executed in this callback information about the DepictionEngine.IScriptableBehaviour that triggered it by keeping a reference available under DepictionEngine.IScriptableBehaviour.originator.

int	GetInstanceID ()

void	OnDestroy ()
	This is where you destroy any remaining dependencies.

void	Initialized (InitializationContext initializingContext)
	Acts as a reliable constructor and will always by called unlike Awake which is sometimes skipped during Undo / Redo operations.

void	Recycle ()
	Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.

bool	Initialize ()
	Needs to be called before the object can be used. Objects created through the DepictionEngine.InstanceManager should automatically Initialize the object.

bool	IsDisposing ()
	Is the object disposing?.

bool	IsDisposed ()
	Has the object been disposed?

bool	OnDisposing ()

bool	OnDispose (DisposeContext disposeContext)
	This is where you dispose any remaining dependencies.

void	OnDisposeInternal (DisposeContext disposeContext)

bool	UpdateDisposingContext (bool forceUpdate=false)
	This is where you clear or dispose any remaining references. It will be called automatically by DepictionEngine.DisposeManager immediately after DepictionEngine.IDisposable.OnDisposing unless the object was Destroyed as a result of an Editor action.

bool	Equals (Disposable.Null value)

void	ResetId ()
	Resets the Id to DepictionEngine.SerializableGuid.Empty.

int	Save ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.

int	Synchronize ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.

int	Delete ()
	Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.

Static Public Attributes
const float	DEFAULT_AUTO_SYNCHRONIZE_INTERVAL = 0.0f

const bool	DEFAULT_AUTO_DISPOSE = true

const bool	DEFAULT_DONT_SAVE_TO_SCENE = false

Protected Member Functions
override bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.

override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.

override void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

override void	Saving (Scene scene, string path)

override bool	UpdateHideFlags ()

virtual bool	GetDefaultDontSaveToScene ()

Protected Member Functions inherited from DepictionEngine.JsonScriptableObject
override void	Initializing ()
	The first step of the initialization process.

override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.

override SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)

Protected Member Functions inherited from DepictionEngine.PropertyScriptableObject
override void	Initializing ()
	The first step of the initialization process.

override void	InitializeUID (InitializationContext initializingContext)
	Initializes the object's unique identifiers.

virtual SerializableGuid	GetId (SerializableGuid id, InitializationContext initializingContext)

override bool	Initialize (InitializationContext initializingContext)
	The main initialization function.

virtual void	InitializeFields (InitializationContext initializingContext)

virtual void	InitializeSerializedFields (InitializationContext initializingContext)
	Initialize SerializedField's to their default values.

virtual bool	AddInstanceToManager ()
	Should this object be added to the DepictionEngine.InstanceManager.

override bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.

virtual bool	SetValue< T > (string name, T value, ref T valueField, Action< T, T > assignedCallback=null, bool allowAutoDisposeOnOutOfSynchProperty=false)

void	PropertyAssigned< T > (IProperty property, string name, T newValue, T oldValue)

virtual bool	InitializeLastFields ()

Protected Member Functions inherited from DepictionEngine.MultithreadSafeScriptableObject
virtual bool	OnDisposedLocked ()

Protected Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
bool	IsDuplicateInitializing ()

virtual void	DestroyAfterFailedInitialization ()

virtual void	Initializing ()
	The first step of the initialization process.

virtual void	InitializeUID (InitializationContext initializingContext)
	Initializes the object's unique identifiers.

virtual bool	AddToInstanceManager ()
	Add the object to the DepictionEngine.InstanceManager if possible.

virtual bool	Initialize (InitializationContext initializingContext)
	The main initialization function.

virtual bool	IsValidInitialization (InitializationContext initializingContext)
	Provides the ability to interrupt the initialization.

bool	InitValue< T > (Action< T > callback, T defaultValue, InitializationContext initializingContext)

bool	InitValue< T > (Action< T > callback, T defaultValue, T duplicateValue, InitializationContext initializingContext)

virtual bool	UpdateAllDelegates ()
	Function to initialize event handlers.

virtual void	Saving (UnityEngine.SceneManagement.Scene scene, string path)

bool	HasChanged (object newValue, object oldValue, bool forceChangeDuringInitializing=true)
	Are the two objects equals?

bool	IsFallbackValues ()

bool	IsNotFallbackValues ()

bool	IsDestroying ()
	Is the object destroying?

virtual bool	UpdateHideFlags ()

virtual DisposeContext	GetDisposingContext ()

virtual void	OnEnable ()

virtual void	OnDisable ()

Properties
Action< IPersistent, Action >	PersistenceSaveOperationEvent `[get, set]`
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.

Action< IPersistent, Action >	PersistenceSynchronizeOperationEvent `[get, set]`
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.

Action< IPersistent, Action >	PersistenceDeleteOperationEvent `[get, set]`
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.

new string	name `[get, set]`
	The name of the object.

float	autoSynchronizeInterval `[get, set]`
	The interval (in seconds) at which we call the DepictionEngine.IPersistent.Synchronize function. Automatically calling DepictionEngine.IPersistent.Synchronize can be useful to keep objects in synch with a datasource. Set to zero to deactivate.

bool	autoDispose `[get, set]`
	When enabled the object can be disposed automatically by its datasource if it is no longer required in any loader and does not have any out of synch properties.

bool	dontSaveToScene `[get, set]`
	When enabled the object will not be saved as part of the Scene.

bool	createPersistentIfMissing `[get, set]`
	When enabled a new DepictionEngine.IPersistent will be created if none is present in the datasource.

bool	containsCopyrightedMaterial `[get]`
	Whether or not the object contains data that is copyrighted. If true the object may not be persisted in a Scene or DepictionEngine.Datasource.

Properties inherited from DepictionEngine.JsonScriptableObject
JSONNode	initializationJson `[get]`

Properties inherited from DepictionEngine.PropertyScriptableObject
Type	type `[get]`
	The Cass type.

Action< IProperty, string, object, object >	PropertyAssignedEvent `[get, set]`
	Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.

SerializableGuid	id `[get]`
	Global unique identifier.

Properties inherited from DepictionEngine.MultithreadSafeScriptableObject
bool	locked `[get, set]`

Properties inherited from DepictionEngine.ScriptableObjectDisposable
bool	wasFirstUpdated `[get]`

bool	initialized `[get]`
	Has the object been initialized.

bool	instanceAdded `[get, set]`

bool	isFallbackValues `[get]`
	Was this component created by a DepictionEngine.FallbackValues.

IScriptableBehaviour	originator `[get]`
	Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.

DisposeContext	disposingContext `[get]`
	The DepictionEngine.DisposeContext under which the object was destroyed.

bool	poolComplete `[get, set]`
	Is the object done disposing.

Action< IDisposable >	InitializedEvent `[get, set]`
	Dispatched after the object as been initialized.

Action< IDisposable, DisposeContext >	DisposedEvent `[get, set]`
	Dispatched during the DepictionEngine.MonoBehaviourDisposable.OnDispose, DepictionEngine.ScriptableObjectDisposable.OnDispose or DepictionEngine.Disposable.OnDispose.

SceneManager	sceneManager `[get]`

InstanceManager	instanceManager `[get]`

DatasourceManager	datasourceManager `[get]`

TweenManager	tweenManager `[get]`

InputManager	inputManager `[get]`

CameraManager	cameraManager `[get]`

PoolManager	poolManager `[get]`

RenderingManager	renderingManager `[get]`

Properties inherited from DepictionEngine.IScriptableBehaviour
string	name `[get, set]`

bool	isFallbackValues `[get]`
	Was this component created by a DepictionEngine.FallbackValues.

IScriptableBehaviour	originator `[get]`
	Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.

Properties inherited from DepictionEngine.IDisposable
Action< IDisposable >	InitializedEvent `[get, set]`
	Dispatched after the object as been initialized.

Action< IDisposable, DisposeContext >	DisposedEvent `[get, set]`
	Dispatched during the DepictionEngine.MonoBehaviourDisposable.OnDispose, DepictionEngine.ScriptableObjectDisposable.OnDispose or DepictionEngine.Disposable.OnDispose.

bool	initialized `[get]`
	Has the object been initialized.

bool	poolComplete `[get, set]`
	Is the object done disposing.

DisposeContext	disposingContext `[get]`
	The DepictionEngine.DisposeContext under which the object was destroyed.

Properties inherited from DepictionEngine.IMultithreadSafe
bool	locked `[get, set]`

Properties inherited from DepictionEngine.IProperty
SerializableGuid	id `[get]`
	The DepictionEngine.SerializableGuid of the object.

Action< IProperty, string, object, object >	PropertyAssignedEvent `[get, set]`
	Dispatched when a new value as been assigned to a field using the DepictionEngine.PropertyMonoBehaviour.SetValue method.

Properties inherited from DepictionEngine.IPersistent
bool	autoDispose `[get]`

bool	dontSaveToScene `[get, set]`

bool	containsCopyrightedMaterial `[get]`

bool	createPersistentIfMissing `[get]`

Action< IPersistent, Action >	PersistenceSaveOperationEvent `[get, set]`
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.

Action< IPersistent, Action >	PersistenceSynchronizeOperationEvent `[get, set]`
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.

Action< IPersistent, Action >	PersistenceDeleteOperationEvent `[get, set]`
	Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.

Additional Inherited Members
Static Public Member Functions inherited from DepictionEngine.ScriptableObjectDisposable
static bool	operator!= (ScriptableObjectDisposable lhs, Disposable.Null rhs)

static bool	operator== (ScriptableObjectDisposable lhs, Disposable.Null _)

Member Function Documentation

◆ AddInstanceToManager()

override bool DepictionEngine.PersistentScriptableObject.AddInstanceToManager ( )

protectedvirtual

Should this object be added to the DepictionEngine.InstanceManager.

Returns: True of the object should be added.

Reimplemented from DepictionEngine.PropertyScriptableObject.

◆ Delete()

int DepictionEngine.PersistentScriptableObject.Delete ( )

Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceDeleteOperationEvent.

Returns: The number of DepictionEngine.IPersistent successfully added to the queue.

Implements DepictionEngine.IPersistent.

◆ Initialize()

override bool DepictionEngine.PersistentScriptableObject.Initialize ( InitializationContext initializingContext )

protectedvirtual

The main initialization function.

Parameters

initializingContext

Returns: False if the initialization failed.

Reimplemented from DepictionEngine.JsonScriptableObject.

◆ InitializeSerializedFields()

override void DepictionEngine.PersistentScriptableObject.InitializeSerializedFields ( InitializationContext initializingContext )

protectedvirtual

Initialize SerializedField's to their default values.

Parameters

initializingContext

Reimplemented from DepictionEngine.PropertyScriptableObject.

◆ OnDispose()

override bool DepictionEngine.PersistentScriptableObject.OnDispose ( DisposeContext disposeContext )

virtual

This is where you dispose any remaining dependencies.

Parameters

disposeContext The context under which the object is being destroyed.

Returns: False if the object was already disposed otherwise True.

Reimplemented from DepictionEngine.PropertyScriptableObject.

◆ Recycle()

override void DepictionEngine.PersistentScriptableObject.Recycle ( )

virtual

Resets the fields to their default value so the object can be reused again. It will be called by the DepictionEngine.PoolManager if the object is being recycled from the pool.

Reimplemented from DepictionEngine.PropertyScriptableObject.

◆ Save()

int DepictionEngine.PersistentScriptableObject.Save ( )

Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSaveOperationEvent.

Returns: The number of DepictionEngine.IPersistent successfully added to the queue.

Implements DepictionEngine.IPersistent.

◆ Synchronize()

int DepictionEngine.PersistentScriptableObject.Synchronize ( )

Trigger the dispatch of a DepictionEngine.IPersistent.PersistenceSynchronizeOperationEvent.

Returns: The number of DepictionEngine.IPersistent successfully added to the queue.

Implements DepictionEngine.IPersistent.

◆ UpdateHideFlags()

override bool DepictionEngine.PersistentScriptableObject.UpdateHideFlags ( )

protectedvirtual

Reimplemented from DepictionEngine.ScriptableObjectDisposable.

Property Documentation

◆ autoDispose

bool DepictionEngine.PersistentScriptableObject.autoDispose

getset

When enabled the object can be disposed automatically by its datasource if it is no longer required in any loader and does not have any out of synch properties.

Implements DepictionEngine.IPersistent.

◆ containsCopyrightedMaterial

bool DepictionEngine.PersistentScriptableObject.containsCopyrightedMaterial

get

Whether or not the object contains data that is copyrighted. If true the object may not be persisted in a Scene or DepictionEngine.Datasource.

Implements DepictionEngine.IPersistent.

◆ createPersistentIfMissing

bool DepictionEngine.PersistentScriptableObject.createPersistentIfMissing

getset

When enabled a new DepictionEngine.IPersistent will be created if none is present in the datasource.

Implements DepictionEngine.IPersistent.

◆ dontSaveToScene

bool DepictionEngine.PersistentScriptableObject.dontSaveToScene

getset

When enabled the object will not be saved as part of the Scene.

Implements DepictionEngine.IPersistent.

◆ name

new string DepictionEngine.PersistentScriptableObject.name

getset

The name of the object.

Implements DepictionEngine.IScriptableBehaviour.

◆ PersistenceDeleteOperationEvent

Action<IPersistent, Action> DepictionEngine.PersistentScriptableObject.PersistenceDeleteOperationEvent

getset

Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their delete operation queue.

Implements DepictionEngine.IPersistent.

◆ PersistenceSaveOperationEvent

Action<IPersistent, Action> DepictionEngine.PersistentScriptableObject.PersistenceSaveOperationEvent

getset

Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their save operation queue.

Implements DepictionEngine.IPersistent.

◆ PersistenceSynchronizeOperationEvent

Action<IPersistent, Action> DepictionEngine.PersistentScriptableObject.PersistenceSynchronizeOperationEvent

getset

Dispatched as a signal to any DepictionEngine.DatasourceBase containing this DepictionEngine.IPersistent to let them know that they need to add it to their synchronize operation queue.

Implements DepictionEngine.IPersistent.

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

PersistentScriptableObject.cs

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ AddInstanceToManager()

◆ Delete()

◆ Initialize()

◆ InitializeSerializedFields()

◆ OnDispose()

◆ Recycle()

◆ Save()

◆ Synchronize()

◆ UpdateHideFlags()

Property Documentation

◆ autoDispose

◆ containsCopyrightedMaterial

◆ createPersistentIfMissing

◆ dontSaveToScene

◆ name

◆ PersistenceDeleteOperationEvent

◆ PersistenceSaveOperationEvent

◆ PersistenceSynchronizeOperationEvent