Struct VariantType

Represents an object type that can be interpreted as more than one type.

Inherited Members

VariantType

Assembly: FlaxEngine.dll

File: Engine/Core/Types/Variant.h

Syntax

public struct VariantType

Constructors

VariantType(const StringAnsiView& typeName)

Declaration

public VariantType(const StringAnsiView& typeName)

Parameters

StringAnsiView typeName

VariantType(const VariantType& other)

Declaration

public VariantType(const VariantType& other)

Parameters

VariantType other

VariantType(Types type, const MClass* klass)

Declaration

public VariantType(Types type, const MClass* klass)

Parameters

Types type

MClass klass

VariantType(Types type, const ScriptingType& sType)

Declaration

public VariantType(Types type, const ScriptingType& sType)

Parameters

Types type

ScriptingType sType

VariantType(Types type, const StringAnsiView& typeName, bool staticName=false)

Declaration

public VariantType(Types type, const StringAnsiView& typeName, bool staticName=false)

Parameters

Types type

StringAnsiView typeName

bool staticName

VariantType(Types type, const StringView& typeName)

Declaration

public VariantType(Types type, const StringView& typeName)

Parameters

Types type

StringView typeName

VariantType(VariantType&& other)

Declaration

public VariantType(VariantType&& other) noexcept

Parameters

VariantType other

Fields

Packed

Declaration

public uint16 Packed

Field Value

uint16

StaticName

Internal flag used to indicate that pointer to TypeName has been linked from a static/external memory that is stable (eg. ScriptingType or MClass). Allows avoiding dynamic memory allocation.

Declaration

public uint8 StaticName

Field Value

uint8

Type

The type of the variant.

Declaration

public Types Type

Field Value

Types

TypeName

The optional additional full name of the scripting type. Used for Asset, Object, Enum, Structure types to describe type precisely.

Declaration

public char* TypeName

Field Value

char

Methods

~VariantType()

Declaration

public ~VariantType()

Returns

FORCE_INLINE

GetElementType()

Declaration

public VariantType GetElementType() const

Returns

VariantType

GetTypeName()

Declaration

public char* GetTypeName() const

Returns

char

Inline()

Declaration

public void Inline()

operator!=(const VariantType& other)

Declaration

public bool operator!=(const VariantType& other) const

Parameters

VariantType other

Returns

bool

operator=(const Types& type)

Declaration

public VariantType operator=(const Types& type)

Parameters

Types type

Returns

VariantType

operator=(const VariantType& other)

Declaration

public VariantType operator=(const VariantType& other)

Parameters

VariantType other

Returns

VariantType

operator=(VariantType&& other)

Declaration

public VariantType operator=(VariantType&& other)

Parameters

VariantType other

Returns

VariantType

operator==(const ScriptingTypeHandle& type)

Declaration

public bool operator==(const ScriptingTypeHandle& type) const

Parameters

ScriptingTypeHandle type

Returns

bool

operator==(const Types& type)

Declaration

public bool operator==(const Types& type) const

Parameters

Types type

Returns

bool

operator==(const VariantType& other)

Declaration

public bool operator==(const VariantType& other) const

Parameters

VariantType other

Returns

bool

SetTypeName(const MClass& klass)

Declaration

public void SetTypeName(const MClass& klass)

Parameters

MClass klass

SetTypeName(const ScriptingType& type)

Declaration

public void SetTypeName(const ScriptingType& type)

Parameters

ScriptingType type

SetTypeName(const StringAnsiView& typeName, bool staticName=false)

Declaration

public void SetTypeName(const StringAnsiView& typeName, bool staticName=false)

Parameters

StringAnsiView typeName

bool staticName

SetTypeName(const StringView& typeName)

Declaration

public void SetTypeName(const StringView& typeName)

Parameters

StringView typeName

ToString()

Declaration

public ::String ToString() const

Returns

::String

VariantType()

Declaration

public VariantType()

Returns

FORCE_INLINE

VariantType(Types type)

Declaration

public VariantType(Types type)

Parameters

Types type

Returns

FORCE_INLINE