Variant

Godot's tagged union type.

Primitives, Godot core types, and GodotObject-derived classes can be stored in a Variant. Other user-defined D types can be made compatible with Variant by defining to!CustomType(Variant) and to!Variant(CustomType) functions.

Properties and method arguments/returns are passed between Godot and D through Variant, so these must use Variant-compatible types.

struct Variant {

alias Type = VariantType;

alias DType = AliasSeq!(typeof(null), bool, long, double, String, Vector2, Vector2i, Rect2, Rect2i, Vector3, Vector3i, Transform2D, Vector4, Vector4i, Plane, Quaternion, AABB, Basis, Transform3D, Projection, Color, StringName, NodePath, RID, GodotObject, GodotCallable, GodotSignal, Dictionary, Array, PackedByteArray, PackedInt32Array, PackedInt64Array, PackedFloat32Array, PackedFloat64Array, PackedStringArray, PackedVector2Array, PackedVector3Array, PackedColorArray);

enum Operator;

T as();

static Array from(T t);

GodotType as();

static Variant from(T t);

enum bool hasToVariantFunction(T);

enum bool hasVariantConstructor(T);

template getFromVariantFunction(T);

enum bool hasFromVariantFunction(T);

template conversionToGodot(T);

enum bool convertsToGodot(T);

alias conversionToGodotType(T) = Unqual!(ReturnType!(conversionToGodot!T));

template conversionFromGodot(T);

enum bool convertsFromGodot(T);

alias conversionFromGodotType(T) = Unqual!(Parameters!(conversionFromGodot!T)[0]);

enum bool directlyCompatible(T);

template compatibleToGodot(T);

template compatibleFromGodot(T);

enum bool compatible(R);

template variantTypeOf(T);

R as();

this(R input);

void opAssign(T input);

this(this);

static Variant nil();

void opAssign(T nil);

void opAssign(T other);

bool opEquals(Variant other);

int opCmp(Variant other);

bool booleanize();

auto toString();

bool isType(GodotType type);

GodotType exactType();

}

Constructors

this this(R input): Undocumented in source.
this this(Variant other): Undocumented in source.
this this(T nil): Undocumented in source.

Destructor

~this ~this(): Undocumented in source.

Postblit

this(this) this(this): Undocumented in source.

Members

Aliases

DType alias DType = AliasSeq!(typeof(null), bool, long, double, String, Vector2, Vector2i, Rect2, Rect2i, Vector3, Vector3i, Transform2D, Vector4, Vector4i, Plane, Quaternion, AABB, Basis, Transform3D, Projection, Color, StringName, NodePath, RID, GodotObject, GodotCallable, GodotSignal, Dictionary, Array, PackedByteArray, PackedInt32Array, PackedInt64Array, PackedFloat32Array, PackedFloat64Array, PackedStringArray, PackedVector2Array, PackedVector3Array, PackedColorArray): D type that this Variant implementation uses
InternalType alias InternalType = AliasSeq!(typeof(null), godot_bool, int, double, godot_string, godot_vector2, godot_vector2i, godot_rect2, godot_rect2i, godot_vector3, godot_vector3i, godot_transform2d, godot_vector4, godot_vector4i, godot_plane, godot_quaternion, godot_aabb, godot_basis, godot_transform3d, godot_projection, godot_color, godot_string, godot_node_path, godot_rid, godot_object, godot_callable, godot_signal, godot_dictionary, godot_array, godot_packed_byte_array, godot_packed_int32_array, godot_packed_int64_array, godot_packed_float32_array, godot_packed_float64_array, godot_packed_string_array, godot_packed_vector2_array, godot_packed_vector3_array, godot_packed_color_array): GDExtension type that gets passed to the C functions
Type alias Type = VariantType: Undocumented in source.
conversionFromGodotType alias conversionFromGodotType(T) = Unqual!(Parameters!(conversionFromGodot!T)[0]): Undocumented in source.
conversionToGodotType alias conversionToGodotType(T) = Unqual!(ReturnType!(conversionToGodot!T)): Undocumented in source.

Enums

Operator enum Operator

Functions

as T as()
as T as()
as T as(): Undocumented in source. Be warned that the author may not have intended to support it.
as T as()
as GodotType as()
as R as()
as inout(T) as(): Undocumented in source. Be warned that the author may not have intended to support it.
booleanize bool booleanize(): Undocumented in source. Be warned that the author may not have intended to support it.
exactType GodotType exactType(): The exact GodotType of the value stored in this Variant.
isType bool isType(GodotType type): Is this Variant of the specified type or of a subclass of type?
opAssign void opAssign(T input): Undocumented in source. Be warned that the author may not have intended to support it.
opAssign void opAssign(void* input): Undocumented in source. Be warned that the author may not have intended to support it.
opAssign void opAssign(T nil): Undocumented in source. Be warned that the author may not have intended to support it.
opAssign void opAssign(T other): Undocumented in source. Be warned that the author may not have intended to support it.
opCmp int opCmp(Variant other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Variant other): Undocumented in source. Be warned that the author may not have intended to support it.
toString auto toString(): Undocumented in source. Be warned that the author may not have intended to support it.
type Type type(): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

from Array from(T t)
from Variant from(T t)
nil Variant nil(): Undocumented in source. Be warned that the author may not have intended to support it.

Templates

compatibleFromGodot template compatibleFromGodot(T): Undocumented in source.
compatibleToGodot template compatibleToGodot(T): Undocumented in source.
conversionFromGodot template conversionFromGodot(T): function to convert a Godot-compatible type to T
conversionToGodot template conversionToGodot(T): function to convert T to an equivalent Godot type
getFromVariantFunction template getFromVariantFunction(T): Undocumented in source.
variantTypeOf template variantTypeOf(T): Get the Variant.Type of a compatible D type. Incompatible types return nil.

Variables

_godot_variant godot_variant _godot_variant;: Undocumented in source.
compatible enum bool compatible(R);: Undocumented in source.
convertsFromGodot enum bool convertsFromGodot(T);: Undocumented in source.
convertsToGodot enum bool convertsToGodot(T);: Undocumented in source.
directlyCompatible enum bool directlyCompatible(T);: Undocumented in source.
hasFromVariantFunction enum bool hasFromVariantFunction(T);: Undocumented in source.
hasToVariantFunction enum bool hasToVariantFunction(T);: Undocumented in source.
hasVariantConstructor enum bool hasVariantConstructor(T);: Undocumented in source.