Struct Variant
- Namespace
- Godot
- Assembly
- GodotSharp.dll
public struct Variant : IDisposable
- Implements
- Inherited Members
Properties
Obj
public object? Obj { get; }
Property Value
VariantType
public Variant.Type VariantType { get; }
Property Value
Methods
AsAabb()
public Aabb AsAabb()
Returns
AsBasis()
public Basis AsBasis()
Returns
AsBool()
public bool AsBool()
Returns
AsByte()
public byte AsByte()
Returns
AsByteArray()
public byte[] AsByteArray()
Returns
- byte[]
AsCallable()
public Callable AsCallable()
Returns
AsChar()
public char AsChar()
Returns
AsColor()
public Color AsColor()
Returns
AsColorArray()
public Color[] AsColorArray()
Returns
- Color[]
AsDouble()
public double AsDouble()
Returns
AsFloat32Array()
public float[] AsFloat32Array()
Returns
- float[]
AsFloat64Array()
public double[] AsFloat64Array()
Returns
- double[]
AsGodotArray()
public Array AsGodotArray()
Returns
AsGodotArray<T>()
public Array<T> AsGodotArray<T>()
Returns
- Array<T>
Type Parameters
T
AsGodotDictionary()
public Dictionary AsGodotDictionary()
Returns
AsGodotDictionary<TKey, TValue>()
public Dictionary<TKey, TValue> AsGodotDictionary<TKey, TValue>()
Returns
- Dictionary<TKey, TValue>
Type Parameters
TKeyTValue
AsGodotObject()
public GodotObject AsGodotObject()
Returns
AsGodotObjectArray<T>()
public T[] AsGodotObjectArray<T>() where T : GodotObject
Returns
- T[]
Type Parameters
T
AsInt16()
public short AsInt16()
Returns
AsInt32()
public int AsInt32()
Returns
AsInt32Array()
public int[] AsInt32Array()
Returns
- int[]
AsInt64()
public long AsInt64()
Returns
AsInt64Array()
public long[] AsInt64Array()
Returns
- long[]
AsNodePath()
public NodePath AsNodePath()
Returns
AsPlane()
public Plane AsPlane()
Returns
AsProjection()
public Projection AsProjection()
Returns
AsQuaternion()
public Quaternion AsQuaternion()
Returns
AsRect2()
public Rect2 AsRect2()
Returns
AsRect2I()
public Rect2I AsRect2I()
Returns
AsRid()
public Rid AsRid()
Returns
AsSByte()
public sbyte AsSByte()
Returns
AsSignal()
public Signal AsSignal()
Returns
AsSingle()
public float AsSingle()
Returns
AsString()
public string AsString()
Returns
AsStringArray()
public string[] AsStringArray()
Returns
- string[]
AsStringName()
public StringName AsStringName()
Returns
AsSystemArrayOfNodePath()
public NodePath[] AsSystemArrayOfNodePath()
Returns
- NodePath[]
AsSystemArrayOfRid()
public Rid[] AsSystemArrayOfRid()
Returns
- Rid[]
AsSystemArrayOfStringName()
public StringName[] AsSystemArrayOfStringName()
Returns
AsTransform2D()
public Transform2D AsTransform2D()
Returns
AsTransform3D()
public Transform3D AsTransform3D()
Returns
AsUInt16()
public ushort AsUInt16()
Returns
AsUInt32()
public uint AsUInt32()
Returns
AsUInt64()
public ulong AsUInt64()
Returns
AsVector2()
public Vector2 AsVector2()
Returns
AsVector2Array()
public Vector2[] AsVector2Array()
Returns
- Vector2[]
AsVector2I()
public Vector2I AsVector2I()
Returns
AsVector3()
public Vector3 AsVector3()
Returns
AsVector3Array()
public Vector3[] AsVector3Array()
Returns
- Vector3[]
AsVector3I()
public Vector3I AsVector3I()
Returns
AsVector4()
public Vector4 AsVector4()
Returns
AsVector4I()
public Vector4I AsVector4I()
Returns
As<T>()
public T As<T>()
Returns
- T
Type Parameters
T
CopyNativeVariant()
Constructs a new godot_variant from this instance. The caller is responsible of disposing the new instance to avoid memory leaks.
public godot_variant CopyNativeVariant()
Returns
CreateCopyingBorrowed(in godot_variant)
public static Variant CreateCopyingBorrowed(in godot_variant nativeValueToOwn)
Parameters
nativeValueToOwngodot_variant
Returns
CreateFrom(Aabb)
public static Variant CreateFrom(Aabb from)
Parameters
fromAabb
Returns
CreateFrom(Basis)
public static Variant CreateFrom(Basis from)
Parameters
fromBasis
Returns
CreateFrom(Callable)
public static Variant CreateFrom(Callable from)
Parameters
fromCallable
Returns
CreateFrom(Array)
public static Variant CreateFrom(Array from)
Parameters
fromArray
Returns
CreateFrom(Dictionary)
public static Variant CreateFrom(Dictionary from)
Parameters
fromDictionary
Returns
CreateFrom(Color)
public static Variant CreateFrom(Color from)
Parameters
fromColor
Returns
CreateFrom(GodotObject)
public static Variant CreateFrom(GodotObject from)
Parameters
fromGodotObject
Returns
CreateFrom(GodotObject[])
public static Variant CreateFrom(GodotObject[] from)
Parameters
fromGodotObject[]
Returns
CreateFrom(NodePath)
public static Variant CreateFrom(NodePath from)
Parameters
fromNodePath
Returns
CreateFrom(Plane)
public static Variant CreateFrom(Plane from)
Parameters
fromPlane
Returns
CreateFrom(Projection)
public static Variant CreateFrom(Projection from)
Parameters
fromProjection
Returns
CreateFrom(Quaternion)
public static Variant CreateFrom(Quaternion from)
Parameters
fromQuaternion
Returns
CreateFrom(Rect2)
public static Variant CreateFrom(Rect2 from)
Parameters
fromRect2
Returns
CreateFrom(Rect2I)
public static Variant CreateFrom(Rect2I from)
Parameters
fromRect2I
Returns
CreateFrom(Rid)
public static Variant CreateFrom(Rid from)
Parameters
fromRid
Returns
CreateFrom(Signal)
public static Variant CreateFrom(Signal from)
Parameters
fromSignal
Returns
CreateFrom(StringName)
public static Variant CreateFrom(StringName from)
Parameters
fromStringName
Returns
CreateFrom(Transform2D)
public static Variant CreateFrom(Transform2D from)
Parameters
fromTransform2D
Returns
CreateFrom(Transform3D)
public static Variant CreateFrom(Transform3D from)
Parameters
fromTransform3D
Returns
CreateFrom(Vector2)
public static Variant CreateFrom(Vector2 from)
Parameters
fromVector2
Returns
CreateFrom(Vector2I)
public static Variant CreateFrom(Vector2I from)
Parameters
fromVector2I
Returns
CreateFrom(Vector3)
public static Variant CreateFrom(Vector3 from)
Parameters
fromVector3
Returns
CreateFrom(Vector3I)
public static Variant CreateFrom(Vector3I from)
Parameters
fromVector3I
Returns
CreateFrom(Vector4)
public static Variant CreateFrom(Vector4 from)
Parameters
fromVector4
Returns
CreateFrom(Vector4I)
public static Variant CreateFrom(Vector4I from)
Parameters
fromVector4I
Returns
CreateFrom(bool)
public static Variant CreateFrom(bool from)
Parameters
frombool
Returns
CreateFrom(byte)
public static Variant CreateFrom(byte from)
Parameters
frombyte
Returns
CreateFrom(char)
public static Variant CreateFrom(char from)
Parameters
fromchar
Returns
CreateFrom(double)
public static Variant CreateFrom(double from)
Parameters
fromdouble
Returns
CreateFrom(short)
public static Variant CreateFrom(short from)
Parameters
fromshort
Returns
CreateFrom(int)
public static Variant CreateFrom(int from)
Parameters
fromint
Returns
CreateFrom(long)
public static Variant CreateFrom(long from)
Parameters
fromlong
Returns
CreateFrom(sbyte)
public static Variant CreateFrom(sbyte from)
Parameters
fromsbyte
Returns
CreateFrom(float)
public static Variant CreateFrom(float from)
Parameters
fromfloat
Returns
CreateFrom(Span<Color>)
public static Variant CreateFrom(Span<Color> from)
Parameters
Returns
CreateFrom(Span<NodePath>)
public static Variant CreateFrom(Span<NodePath> from)
Parameters
Returns
CreateFrom(Span<Rid>)
public static Variant CreateFrom(Span<Rid> from)
Parameters
Returns
CreateFrom(Span<StringName>)
public static Variant CreateFrom(Span<StringName> from)
Parameters
fromSpan<StringName>
Returns
CreateFrom(Span<Vector2>)
public static Variant CreateFrom(Span<Vector2> from)
Parameters
Returns
CreateFrom(Span<Vector3>)
public static Variant CreateFrom(Span<Vector3> from)
Parameters
Returns
CreateFrom(Span<byte>)
public static Variant CreateFrom(Span<byte> from)
Parameters
Returns
CreateFrom(Span<double>)
public static Variant CreateFrom(Span<double> from)
Parameters
Returns
CreateFrom(Span<int>)
public static Variant CreateFrom(Span<int> from)
Parameters
Returns
CreateFrom(Span<long>)
public static Variant CreateFrom(Span<long> from)
Parameters
Returns
CreateFrom(Span<float>)
public static Variant CreateFrom(Span<float> from)
Parameters
Returns
CreateFrom(Span<string>)
public static Variant CreateFrom(Span<string> from)
Parameters
Returns
CreateFrom(string)
public static Variant CreateFrom(string from)
Parameters
fromstring
Returns
CreateFrom(ushort)
public static Variant CreateFrom(ushort from)
Parameters
fromushort
Returns
CreateFrom(uint)
public static Variant CreateFrom(uint from)
Parameters
fromuint
Returns
CreateFrom(ulong)
public static Variant CreateFrom(ulong from)
Parameters
fromulong
Returns
CreateFrom<T>(Array<T>)
public static Variant CreateFrom<T>(Array<T> from)
Parameters
fromArray<T>
Returns
Type Parameters
T
CreateFrom<TKey, TValue>(Dictionary<TKey, TValue>)
public static Variant CreateFrom<TKey, TValue>(Dictionary<TKey, TValue> from)
Parameters
fromDictionary<TKey, TValue>
Returns
Type Parameters
TKeyTValue
CreateTakingOwnershipOfDisposableValue(in godot_variant)
public static Variant CreateTakingOwnershipOfDisposableValue(in godot_variant nativeValueToOwn)
Parameters
nativeValueToOwngodot_variant
Returns
Dispose()
public void Dispose()
From<T>(in T)
public static Variant From<T>(in T from)
Parameters
fromT
Returns
Type Parameters
T
ToString()
public override string ToString()
Returns
Operators
explicit operator Aabb(Variant)
public static explicit operator Aabb(Variant from)
Parameters
fromVariant
Returns
explicit operator Basis(Variant)
public static explicit operator Basis(Variant from)
Parameters
fromVariant
Returns
explicit operator Callable(Variant)
public static explicit operator Callable(Variant from)
Parameters
fromVariant
Returns
explicit operator Array(Variant)
public static explicit operator Array(Variant from)
Parameters
fromVariant
Returns
explicit operator Dictionary(Variant)
public static explicit operator Dictionary(Variant from)
Parameters
fromVariant
Returns
explicit operator Color(Variant)
public static explicit operator Color(Variant from)
Parameters
fromVariant
Returns
explicit operator Color[](Variant)
public static explicit operator Color[](Variant from)
Parameters
fromVariant
Returns
- Color[]
explicit operator GodotObject(Variant)
public static explicit operator GodotObject(Variant from)
Parameters
fromVariant
Returns
explicit operator NodePath(Variant)
public static explicit operator NodePath(Variant from)
Parameters
fromVariant
Returns
explicit operator NodePath[](Variant)
public static explicit operator NodePath[](Variant from)
Parameters
fromVariant
Returns
- NodePath[]
explicit operator Plane(Variant)
public static explicit operator Plane(Variant from)
Parameters
fromVariant
Returns
explicit operator Projection(Variant)
public static explicit operator Projection(Variant from)
Parameters
fromVariant
Returns
explicit operator Quaternion(Variant)
public static explicit operator Quaternion(Variant from)
Parameters
fromVariant
Returns
explicit operator Rect2(Variant)
public static explicit operator Rect2(Variant from)
Parameters
fromVariant
Returns
explicit operator Rect2I(Variant)
public static explicit operator Rect2I(Variant from)
Parameters
fromVariant
Returns
explicit operator Rid(Variant)
public static explicit operator Rid(Variant from)
Parameters
fromVariant
Returns
explicit operator Rid[](Variant)
public static explicit operator Rid[](Variant from)
Parameters
fromVariant
Returns
- Rid[]
explicit operator Signal(Variant)
public static explicit operator Signal(Variant from)
Parameters
fromVariant
Returns
explicit operator StringName(Variant)
public static explicit operator StringName(Variant from)
Parameters
fromVariant
Returns
explicit operator StringName[](Variant)
public static explicit operator StringName[](Variant from)
Parameters
fromVariant
Returns
explicit operator Transform2D(Variant)
public static explicit operator Transform2D(Variant from)
Parameters
fromVariant
Returns
explicit operator Transform3D(Variant)
public static explicit operator Transform3D(Variant from)
Parameters
fromVariant
Returns
explicit operator Vector2(Variant)
public static explicit operator Vector2(Variant from)
Parameters
fromVariant
Returns
explicit operator Vector2I(Variant)
public static explicit operator Vector2I(Variant from)
Parameters
fromVariant
Returns
explicit operator Vector2[](Variant)
public static explicit operator Vector2[](Variant from)
Parameters
fromVariant
Returns
- Vector2[]
explicit operator Vector3(Variant)
public static explicit operator Vector3(Variant from)
Parameters
fromVariant
Returns
explicit operator Vector3I(Variant)
public static explicit operator Vector3I(Variant from)
Parameters
fromVariant
Returns
explicit operator Vector3[](Variant)
public static explicit operator Vector3[](Variant from)
Parameters
fromVariant
Returns
- Vector3[]
explicit operator Vector4(Variant)
public static explicit operator Vector4(Variant from)
Parameters
fromVariant
Returns
explicit operator Vector4I(Variant)
public static explicit operator Vector4I(Variant from)
Parameters
fromVariant
Returns
explicit operator bool(Variant)
public static explicit operator bool(Variant from)
Parameters
fromVariant
Returns
explicit operator byte(Variant)
public static explicit operator byte(Variant from)
Parameters
fromVariant
Returns
explicit operator byte[](Variant)
public static explicit operator byte[](Variant from)
Parameters
fromVariant
Returns
- byte[]
explicit operator char(Variant)
public static explicit operator char(Variant from)
Parameters
fromVariant
Returns
explicit operator double(Variant)
public static explicit operator double(Variant from)
Parameters
fromVariant
Returns
explicit operator double[](Variant)
public static explicit operator double[](Variant from)
Parameters
fromVariant
Returns
- double[]
explicit operator short(Variant)
public static explicit operator short(Variant from)
Parameters
fromVariant
Returns
explicit operator int(Variant)
public static explicit operator int(Variant from)
Parameters
fromVariant
Returns
explicit operator int[](Variant)
public static explicit operator int[](Variant from)
Parameters
fromVariant
Returns
- int[]
explicit operator long(Variant)
public static explicit operator long(Variant from)
Parameters
fromVariant
Returns
explicit operator long[](Variant)
public static explicit operator long[](Variant from)
Parameters
fromVariant
Returns
- long[]
explicit operator sbyte(Variant)
public static explicit operator sbyte(Variant from)
Parameters
fromVariant
Returns
explicit operator float(Variant)
public static explicit operator float(Variant from)
Parameters
fromVariant
Returns
explicit operator float[](Variant)
public static explicit operator float[](Variant from)
Parameters
fromVariant
Returns
- float[]
explicit operator string(Variant)
public static explicit operator string(Variant from)
Parameters
fromVariant
Returns
explicit operator string[](Variant)
public static explicit operator string[](Variant from)
Parameters
fromVariant
Returns
- string[]
explicit operator ushort(Variant)
public static explicit operator ushort(Variant from)
Parameters
fromVariant
Returns
explicit operator uint(Variant)
public static explicit operator uint(Variant from)
Parameters
fromVariant
Returns
explicit operator ulong(Variant)
public static explicit operator ulong(Variant from)
Parameters
fromVariant
Returns
implicit operator Variant(Aabb)
public static implicit operator Variant(Aabb from)
Parameters
fromAabb
Returns
implicit operator Variant(Basis)
public static implicit operator Variant(Basis from)
Parameters
fromBasis
Returns
implicit operator Variant(Callable)
public static implicit operator Variant(Callable from)
Parameters
fromCallable
Returns
implicit operator Variant(Array)
public static implicit operator Variant(Array from)
Parameters
fromArray
Returns
implicit operator Variant(Dictionary)
public static implicit operator Variant(Dictionary from)
Parameters
fromDictionary
Returns
implicit operator Variant(Color)
public static implicit operator Variant(Color from)
Parameters
fromColor
Returns
implicit operator Variant(Color[])
public static implicit operator Variant(Color[] from)
Parameters
fromColor[]
Returns
implicit operator Variant(GodotObject)
public static implicit operator Variant(GodotObject from)
Parameters
fromGodotObject
Returns
implicit operator Variant(GodotObject[])
public static implicit operator Variant(GodotObject[] from)
Parameters
fromGodotObject[]
Returns
implicit operator Variant(NodePath)
public static implicit operator Variant(NodePath from)
Parameters
fromNodePath
Returns
implicit operator Variant(NodePath[])
public static implicit operator Variant(NodePath[] from)
Parameters
fromNodePath[]
Returns
implicit operator Variant(Plane)
public static implicit operator Variant(Plane from)
Parameters
fromPlane
Returns
implicit operator Variant(Projection)
public static implicit operator Variant(Projection from)
Parameters
fromProjection
Returns
implicit operator Variant(Quaternion)
public static implicit operator Variant(Quaternion from)
Parameters
fromQuaternion
Returns
implicit operator Variant(Rect2)
public static implicit operator Variant(Rect2 from)
Parameters
fromRect2
Returns
implicit operator Variant(Rect2I)
public static implicit operator Variant(Rect2I from)
Parameters
fromRect2I
Returns
implicit operator Variant(Rid)
public static implicit operator Variant(Rid from)
Parameters
fromRid
Returns
implicit operator Variant(Rid[])
public static implicit operator Variant(Rid[] from)
Parameters
fromRid[]
Returns
implicit operator Variant(Signal)
public static implicit operator Variant(Signal from)
Parameters
fromSignal
Returns
implicit operator Variant(StringName)
public static implicit operator Variant(StringName from)
Parameters
fromStringName
Returns
implicit operator Variant(StringName[])
public static implicit operator Variant(StringName[] from)
Parameters
fromStringName[]
Returns
implicit operator Variant(Transform2D)
public static implicit operator Variant(Transform2D from)
Parameters
fromTransform2D
Returns
implicit operator Variant(Transform3D)
public static implicit operator Variant(Transform3D from)
Parameters
fromTransform3D
Returns
implicit operator Variant(Vector2)
public static implicit operator Variant(Vector2 from)
Parameters
fromVector2
Returns
implicit operator Variant(Vector2I)
public static implicit operator Variant(Vector2I from)
Parameters
fromVector2I
Returns
implicit operator Variant(Vector2[])
public static implicit operator Variant(Vector2[] from)
Parameters
fromVector2[]
Returns
implicit operator Variant(Vector3)
public static implicit operator Variant(Vector3 from)
Parameters
fromVector3
Returns
implicit operator Variant(Vector3I)
public static implicit operator Variant(Vector3I from)
Parameters
fromVector3I
Returns
implicit operator Variant(Vector3[])
public static implicit operator Variant(Vector3[] from)
Parameters
fromVector3[]
Returns
implicit operator Variant(Vector4)
public static implicit operator Variant(Vector4 from)
Parameters
fromVector4
Returns
implicit operator Variant(Vector4I)
public static implicit operator Variant(Vector4I from)
Parameters
fromVector4I
Returns
implicit operator Variant(bool)
public static implicit operator Variant(bool from)
Parameters
frombool
Returns
implicit operator Variant(byte)
public static implicit operator Variant(byte from)
Parameters
frombyte
Returns
implicit operator Variant(byte[])
public static implicit operator Variant(byte[] from)
Parameters
frombyte[]
Returns
implicit operator Variant(char)
public static implicit operator Variant(char from)
Parameters
fromchar
Returns
implicit operator Variant(double)
public static implicit operator Variant(double from)
Parameters
fromdouble
Returns
implicit operator Variant(double[])
public static implicit operator Variant(double[] from)
Parameters
fromdouble[]
Returns
implicit operator Variant(short)
public static implicit operator Variant(short from)
Parameters
fromshort
Returns
implicit operator Variant(int)
public static implicit operator Variant(int from)
Parameters
fromint
Returns
implicit operator Variant(int[])
public static implicit operator Variant(int[] from)
Parameters
fromint[]
Returns
implicit operator Variant(long)
public static implicit operator Variant(long from)
Parameters
fromlong
Returns
implicit operator Variant(long[])
public static implicit operator Variant(long[] from)
Parameters
fromlong[]
Returns
implicit operator Variant(sbyte)
public static implicit operator Variant(sbyte from)
Parameters
fromsbyte
Returns
implicit operator Variant(float)
public static implicit operator Variant(float from)
Parameters
fromfloat
Returns
implicit operator Variant(float[])
public static implicit operator Variant(float[] from)
Parameters
fromfloat[]
Returns
implicit operator Variant(Span<Color>)
public static implicit operator Variant(Span<Color> from)
Parameters
Returns
implicit operator Variant(Span<NodePath>)
public static implicit operator Variant(Span<NodePath> from)
Parameters
Returns
implicit operator Variant(Span<Rid>)
public static implicit operator Variant(Span<Rid> from)
Parameters
Returns
implicit operator Variant(Span<StringName>)
public static implicit operator Variant(Span<StringName> from)
Parameters
fromSpan<StringName>
Returns
implicit operator Variant(Span<Vector2>)
public static implicit operator Variant(Span<Vector2> from)
Parameters
Returns
implicit operator Variant(Span<Vector3>)
public static implicit operator Variant(Span<Vector3> from)
Parameters
Returns
implicit operator Variant(Span<byte>)
public static implicit operator Variant(Span<byte> from)
Parameters
Returns
implicit operator Variant(Span<double>)
public static implicit operator Variant(Span<double> from)
Parameters
Returns
implicit operator Variant(Span<int>)
public static implicit operator Variant(Span<int> from)
Parameters
Returns
implicit operator Variant(Span<long>)
public static implicit operator Variant(Span<long> from)
Parameters
Returns
implicit operator Variant(Span<float>)
public static implicit operator Variant(Span<float> from)
Parameters
Returns
implicit operator Variant(Span<string>)
public static implicit operator Variant(Span<string> from)
Parameters
Returns
implicit operator Variant(string)
public static implicit operator Variant(string from)
Parameters
fromstring
Returns
implicit operator Variant(string[])
public static implicit operator Variant(string[] from)
Parameters
fromstring[]
Returns
implicit operator Variant(ushort)
public static implicit operator Variant(ushort from)
Parameters
fromushort
Returns
implicit operator Variant(uint)
public static implicit operator Variant(uint from)
Parameters
fromuint
Returns
implicit operator Variant(ulong)
public static implicit operator Variant(ulong from)
Parameters
fromulong