Depiction Engine For Unity 2023.0 (Alpha)
Loading...
Searching...
No Matches
DepictionEngine.IScriptableBehaviour Interface Reference

An abstract interface for both MonoBehaviour and ScriptableObject. More...

Public Member Functions

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.
 
- Public Member Functions inherited from DepictionEngine.IDisposable
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)
 

Properties

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< IDisposableInitializedEvent [get, set]
 Dispatched after the object as been initialized.
 
Action< IDisposable, DisposeContextDisposedEvent [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.
 

Detailed Description

An abstract interface for both MonoBehaviour and ScriptableObject.

Member Function Documentation

◆ OnDestroy()

void DepictionEngine.IScriptableBehaviour.OnDestroy ( )

This is where you destroy any remaining dependencies.

Implemented in DepictionEngine.MonoBehaviourDisposable, and DepictionEngine.ScriptableObjectDisposable.

◆ Originator()

void DepictionEngine.IScriptableBehaviour.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.

Parameters
callback
originator

Implemented in DepictionEngine.MonoBehaviourDisposable, and DepictionEngine.ScriptableObjectDisposable.

Property Documentation

◆ isFallbackValues

bool DepictionEngine.IScriptableBehaviour.isFallbackValues
get

◆ name

string DepictionEngine.IScriptableBehaviour.name
getset

◆ originator

IScriptableBehaviour DepictionEngine.IScriptableBehaviour.originator
get

Which DepictionEngine.IScriptableBehaviour triggered the current code execution if any at all.

Implemented in DepictionEngine.MonoBehaviourDisposable, and DepictionEngine.ScriptableObjectDisposable.


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