Class ScriptingObjectReferenceBase

The scripting object reference.

Inheritance

ScriptingObjectReferenceBase

Inherited Members

ScriptingObjectReferenceBase

Assembly: FlaxEngine.dll

File: Engine/Scripting/ScriptingObjectReference.h

Syntax

public class ScriptingObjectReferenceBase

Constructors

~ScriptingObjectReferenceBase()

Finalizes an instance of the ScriptingObjectReference class.

Declaration

public ~ScriptingObjectReferenceBase()

ScriptingObjectReferenceBase()

Initializes a new instance of the ScriptingObjectReferenceBase class.

Declaration

public ScriptingObjectReferenceBase()

ScriptingObjectReferenceBase(ScriptingObject* obj)

Initializes a new instance of the ScriptingObjectReferenceBase class.

Declaration

public ScriptingObjectReferenceBase(ScriptingObject* obj)

Parameters

ScriptingObject obj The object to link.

Fields

_object

Declaration

protected ScriptingObject* _object = nullptr

Field Value

ScriptingObject

Changed

Action fired when reference gets changed.

Declaration

public EventType Changed

Field Value

EventType

Methods

GetID()

Gets the object ID.

Declaration

public Guid GetID() const

Returns

Guid

GetManagedInstance()

Gets managed instance object (or null if no object linked).

Declaration

public MObject* GetManagedInstance() const

Returns

MObject

GetOrCreateManagedInstance()

Gets the managed instance object or creates it if missing or null if not assigned.

Declaration

public MObject* GetOrCreateManagedInstance() const

Returns

MObject

HasManagedInstance()

Determines whether object is assigned and managed instance of the object is alive.

Declaration

public bool HasManagedInstance() const

Returns

bool

OnDeleted(ScriptingObject* obj)

Declaration

protected void OnDeleted(ScriptingObject* obj)

Parameters

ScriptingObject obj

OnSet(ScriptingObject* object)

Sets the object.

Declaration

protected void OnSet(ScriptingObject* object)

Parameters

ScriptingObject object The object.