Class SoftObjectReference

The scripting object soft reference. Objects gets referenced on use (ID reference is resolving it).

Inheritance

SoftObjectReferenceBase

SoftObjectReference

Inherited Members

SoftObjectReferenceBase::_id

SoftObjectReferenceBase::_object

SoftObjectReferenceBase::Changed

SoftObjectReferenceBase::GetID()

SoftObjectReferenceBase::OnDeleted(ScriptingObject* obj)

SoftObjectReferenceBase::OnResolve(MClass* type)

SoftObjectReferenceBase::OnSet(ScriptingObject* object)

SoftObjectReferenceBase::OnSet(const Guid& id)

SoftObjectReferenceBase::SoftObjectReferenceBase()

SoftObjectReference

SoftObjectReferenceBase::~SoftObjectReferenceBase()

Assembly: FlaxEngine.dll

File: Engine/Scripting/SoftObjectReference.h

Syntax

public class SoftObjectReference<T> : public SoftObjectReferenceBase

Type Parameters

T

Constructors

~SoftObjectReference()

Finalizes an instance of the SoftObjectReference class.

Declaration

public ~SoftObjectReference()

SoftObjectReference()

Initializes a new instance of the SoftObjectReference class.

Declaration

public SoftObjectReference()

SoftObjectReference(const SoftObjectReference& other)

Initializes a new instance of the SoftObjectReference class.

Declaration

public SoftObjectReference(const SoftObjectReference& other)

Parameters

SoftObjectReference other The other property.

SoftObjectReference(SoftObjectReference&& other)

Initializes a new instance of the SoftObjectReference class.

Declaration

public SoftObjectReference(SoftObjectReference&& other)

Parameters

SoftObjectReference other The other property.

SoftObjectReference(T* obj)

Initializes a new instance of the SoftObjectReference class.

Declaration

public SoftObjectReference(T* obj)

Parameters

T obj The object to link.

Methods

As()

Declaration

public U* As() const

Returns

U

Type Parameters

typename U

Get()

Gets the object (or null if unassigned).

Declaration

public T* Get() const

Returns

T

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

operator bool()

Declaration

public operator bool() const

Returns

FORCE_INLINE

operator T*()

Declaration

public operator T*() const

Returns

FORCE_INLINE

operator!=(const SoftObjectReference& other)

Declaration

public bool operator!=(const SoftObjectReference& other)

Parameters

SoftObjectReference other

Returns

bool

operator!=(T* other)

Declaration

public bool operator!=(T* other)

Parameters

T other

Returns

bool

operator=(const Guid& id)

Declaration

public SoftObjectReference operator=(const Guid& id)

Parameters

Guid id

Returns

SoftObjectReference

operator=(const SoftObjectReference& other)

Declaration

public SoftObjectReference operator=(const SoftObjectReference& other)

Parameters

SoftObjectReference other

Returns

SoftObjectReference

operator=(const T& other)

Declaration

public SoftObjectReference operator=(const T& other)

Parameters

T other

Returns

SoftObjectReference

operator=(SoftObjectReference&& other)

Declaration

public SoftObjectReference operator=(SoftObjectReference&& other)

Parameters

SoftObjectReference other

Returns

SoftObjectReference

operator=(T* other)

Declaration

public SoftObjectReference operator=(T* other)

Parameters

T other

Returns

SoftObjectReference

operator==(const SoftObjectReference& other)

Declaration

public bool operator==(const SoftObjectReference& other)

Parameters

SoftObjectReference other

Returns

bool

operator==(T* other)

Declaration

public bool operator==(T* other)

Parameters

T other

Returns

bool

operator->()

Declaration

public T* operator->() const

Returns

T

Set(const Guid& id)

Sets the object.

Declaration

public void Set(const Guid& id)

Parameters

Guid id The object ID. Uses Scripting to find the registered object of the given ID.

Returns

void

Set(T* object)

Sets the object.

Declaration

public void Set(T* object)

Parameters

T object The object.

Returns

void