Variant

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.Variant
Namespace	Electron2D
Kind	struct
Category	Math and Data

Overview

Stores one value from the closed Electron2D 0.1.0 Preview Variant type set.

Syntax

public struct Electron2D.Variant : System.IEquatable<Electron2D.Variant>

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: Variant

Closed 0.1 value carrier for nil, primitives, enum-as-int, 2D math, identity handles, Object-derived values, Callable and Electron2D collections.

Remarks

Electron2D.Variant is the Electron2D dynamic value carrier used by engine APIs that cannot be represented as a single static C# type. It is a value type; default(Variant) represents Electron2D.Variant.Type.Nil.

Electron2D 0.1.0 Preview intentionally supports a closed preview set: primitive values, 2D math types, identity handles, Electron2D.Object instances, Electron2D.Callable, and Electron2D collections. 3D types, packed arrays, Signal, editor-only values, and arbitrary CLR objects are not part of this release contract.

Thread Safety

Independent Variant values are safe to read from any thread. If a Variant stores a mutable collection, thread safety follows that collection instance.

Since

This type is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
Obj	Property	Gets the boxed value stored in this variant.
VariantType	Property	Gets the type stored in this variant.
As()	Method	Converts this variant to a supported C# type.
AsArray()	Method	Reads the stored Electron2D array reference.
AsBool()	Method	Reads the stored Boolean value.
AsCallable()	Method	Reads the stored Electron2D.Callable value.
AsColor()	Method	Reads the stored Electron2D.Color value.
AsDictionary()	Method	Reads the stored Electron2D dictionary reference.
AsDouble()	Method	Reads the stored 64-bit floating-point value.
AsInt32()	Method	Reads the stored integer value as a signed 32-bit integer.
AsInt64()	Method	Reads the stored signed 64-bit integer value.
AsNodePath()	Method	Reads the stored Electron2D.NodePath value.
AsObject()	Method	Reads the stored object reference.
AsRect2()	Method	Reads the stored Electron2D.Rect2 value.
AsRect2I()	Method	Reads the stored Electron2D.Rect2I value.
AsRid()	Method	Reads the stored Electron2D.Rid value.
AsString()	Method	Reads the stored string value.
AsStringName()	Method	Reads the stored Electron2D.StringName value.
AsTransform2D()	Method	Reads the stored Electron2D.Transform2D value.
AsVector2()	Method	Reads the stored Electron2D.Vector2 value.
AsVector2I()	Method	Reads the stored Electron2D.Vector2I value.
CreateFrom(System.Object)	Method	Creates a Variant from any supported Electron2D 0.1.0 Preview value.
Equals(Electron2D.Variant)	Method	Tests two variants for equality.
Equals(System.Object)	Method	Tests whether an object is an equal Variant.
From(T)	Method	Creates a Variant from a supported value while preserving generic call sites.
GetHashCode()	Method	Returns a hash code for this Variant.
IsNil()	Method	Returns whether this variant stores Electron2D.Variant.Type.Nil.
ToString()	Method	Returns a diagnostic string representation of the stored value.
op_Equality(Electron2D.Variant, Electron2D.Variant)	Method	Tests two variants for equality.
op_Implicit(System.Boolean)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.Byte)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.Double)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Callable)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Collections.Array)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Collections.Dictionary)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Color)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.NodePath)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Object)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Rect2)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Rect2I)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Rid)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.StringName)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Transform2D)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Vector2)	Method	Converts a Boolean value to a Variant.
op_Implicit(Electron2D.Vector2I)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.Int16)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.Int32)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.Int64)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.SByte)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.Single)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.String)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.UInt16)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.UInt32)	Method	Converts a Boolean value to a Variant.
op_Implicit(System.UInt64)	Method	Converts a Boolean value to a Variant.
op_Inequality(Electron2D.Variant, Electron2D.Variant)	Method	Tests two variants for inequality.

Member Details

Obj

Kind: Property

public System.Object Obj { get; }

Summary

Gets the boxed value stored in this variant.

Remarks

Numeric values are normalized before boxing: integer-compatible values are boxed as System.Int64 and floating-point values are boxed as System.Double.

Value

The current obj value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

VariantType

Kind: Property

public Electron2D.Variant.Type VariantType { get; }

Summary

Gets the type stored in this variant.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current variant type value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

As()

Kind: Method

public T As()()

Summary

Converts this variant to a supported C# type.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Type Parameters

• T: The requested C# type.

Returns

The stored value converted to T.

Exceptions

• System.InvalidCastException: Thrown when the stored Variant type does not match T.
• System.ArgumentException: Thrown when T is not a supported Variant target type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsArray()

Kind: Method

public Electron2D.Collections.Array AsArray()()

Summary

Reads the stored Electron2D array reference.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored Electron2D.Collections.Array instance.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Array.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsBool()

Kind: Method

public System.Boolean AsBool()()

Summary

Reads the stored Boolean value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored System.Boolean value.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Bool.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsCallable()

Kind: Method

public Electron2D.Callable AsCallable()()

Summary

Reads the stored Electron2D.Callable value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored callable.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Callable.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsColor()

Kind: Method

public Electron2D.Color AsColor()()

Summary

Reads the stored Electron2D.Color value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored color.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Color.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsDictionary()

Kind: Method

public Electron2D.Collections.Dictionary AsDictionary()()

Summary

Reads the stored Electron2D dictionary reference.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored Electron2D.Collections.Dictionary instance.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Dictionary.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsDouble()

Kind: Method

public System.Double AsDouble()()

Summary

Reads the stored 64-bit floating-point value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored System.Double value.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Float.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsInt32()

Kind: Method

public System.Int32 AsInt32()()

Summary

Reads the stored integer value as a signed 32-bit integer.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored integer converted to System.Int32.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Int or the value does not fit in System.Int32.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsInt64()

Kind: Method

public System.Int64 AsInt64()()

Summary

Reads the stored signed 64-bit integer value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored System.Int64 value.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Int.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsNodePath()

Kind: Method

public Electron2D.NodePath AsNodePath()()

Summary

Reads the stored Electron2D.NodePath value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored node path.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.NodePath.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsObject()

Kind: Method

public Electron2D.Object AsObject()()

Summary

Reads the stored object reference.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored Electron2D.Object or derived instance.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Object.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsRect2()

Kind: Method

public Electron2D.Rect2 AsRect2()()

Summary

Reads the stored Electron2D.Rect2 value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored rectangle.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Rect2.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsRect2I()

Kind: Method

public Electron2D.Rect2I AsRect2I()()

Summary

Reads the stored Electron2D.Rect2I value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored integer rectangle.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Rect2I.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsRid()

Kind: Method

public Electron2D.Rid AsRid()()

Summary

Reads the stored Electron2D.Rid value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored resource identifier.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Rid.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsString()

Kind: Method

public System.String AsString()()

Summary

Reads the stored string value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored string.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.String.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsStringName()

Kind: Method

public Electron2D.StringName AsStringName()()

Summary

Reads the stored Electron2D.StringName value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored string name.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.StringName.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsTransform2D()

Kind: Method

public Electron2D.Transform2D AsTransform2D()()

Summary

Reads the stored Electron2D.Transform2D value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored transform.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Transform2D.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsVector2()

Kind: Method

public Electron2D.Vector2 AsVector2()()

Summary

Reads the stored Electron2D.Vector2 value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored vector.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Vector2.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

AsVector2I()

Kind: Method

public Electron2D.Vector2I AsVector2I()()

Summary

Reads the stored Electron2D.Vector2I value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The stored integer vector.

Exceptions

• System.InvalidCastException: Thrown when this variant is not Electron2D.Variant.Type.Vector2I.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

CreateFrom(System.Object)

Kind: Method

public static Electron2D.Variant CreateFrom(System.Object)(System.Object value)

Summary

Creates a Variant from any supported Electron2D 0.1.0 Preview value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• value: The value to store.

Returns

A Variant containing value.

Exceptions

• System.ArgumentException: Thrown when value is not part of the closed Variant type set.
• System.ArgumentOutOfRangeException: Thrown when an unsigned 64-bit integer cannot be represented by the signed 64-bit Variant integer type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

Equals(Electron2D.Variant)

Kind: Method

public System.Boolean Equals(Electron2D.Variant)(Electron2D.Variant other)

Summary

Tests two variants for equality.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• other: The variant to compare with this value.

Returns

true if both variants have the same type and value; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

Equals(System.Object)

Kind: Method

public System.Boolean Equals(System.Object)(System.Object obj)

Summary

Tests whether an object is an equal Variant.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• obj: The object to compare with this value.

Returns

true when obj is an equal Variant; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

From(T)

Kind: Method

public static Electron2D.Variant From(T)(T value)

Summary

Creates a Variant from a supported value while preserving generic call sites.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• value: The value to store.

Type Parameters

• T: The static C# type of the value.

Returns

A Variant containing value.

Exceptions

• System.ArgumentException: Thrown when T or the runtime value is not part of the closed Variant type set.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

GetHashCode()

Kind: Method

public System.Int32 GetHashCode()()

Summary

Returns a hash code for this Variant.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

A hash code suitable for dictionary keys.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

IsNil()

Kind: Method

public System.Boolean IsNil()()

Summary

Returns whether this variant stores Electron2D.Variant.Type.Nil.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

true for nil variants; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

ToString()

Kind: Method

public System.String ToString()()

Summary

Returns a diagnostic string representation of the stored value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

A string representation of this Variant.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Equality(Electron2D.Variant, Electron2D.Variant)

Kind: Method

public static System.Boolean op_Equality(Electron2D.Variant, Electron2D.Variant)(Electron2D.Variant left, Electron2D.Variant right)

Summary

Tests two variants for equality.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left variant.
• right: The right variant.

Returns

true if both variants are equal; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Boolean)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Boolean)(System.Boolean value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Byte)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Byte)(System.Byte value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Double)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Double)(System.Double value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Callable)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Callable)(Electron2D.Callable value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Collections.Array)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Collections.Array)(Electron2D.Collections.Array value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Collections.Dictionary)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Collections.Dictionary)(Electron2D.Collections.Dictionary value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Color)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Color)(Electron2D.Color value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.NodePath)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.NodePath)(Electron2D.NodePath value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Object)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Object)(Electron2D.Object value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Rect2)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Rect2)(Electron2D.Rect2 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Rect2I)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Rect2I)(Electron2D.Rect2I value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Rid)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Rid)(Electron2D.Rid value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.StringName)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.StringName)(Electron2D.StringName value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Transform2D)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Transform2D)(Electron2D.Transform2D value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Vector2)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Vector2)(Electron2D.Vector2 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(Electron2D.Vector2I)

Kind: Method

public static Electron2D.Variant op_Implicit(Electron2D.Vector2I)(Electron2D.Vector2I value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Int16)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Int16)(System.Int16 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Int32)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Int32)(System.Int32 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Int64)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Int64)(System.Int64 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.SByte)

Kind: Method

public static Electron2D.Variant op_Implicit(System.SByte)(System.SByte value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.Single)

Kind: Method

public static Electron2D.Variant op_Implicit(System.Single)(System.Single value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.String)

Kind: Method

public static Electron2D.Variant op_Implicit(System.String)(System.String value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.UInt16)

Kind: Method

public static Electron2D.Variant op_Implicit(System.UInt16)(System.UInt16 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.UInt32)

Kind: Method

public static Electron2D.Variant op_Implicit(System.UInt32)(System.UInt32 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Implicit(System.UInt64)

Kind: Method

public static Electron2D.Variant op_Implicit(System.UInt64)(System.UInt64 value)

Summary

Converts a Boolean value to a Variant.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant

op_Inequality(Electron2D.Variant, Electron2D.Variant)

Kind: Method

public static System.Boolean op_Inequality(Electron2D.Variant, Electron2D.Variant)(Electron2D.Variant left, Electron2D.Variant right)

Summary

Tests two variants for inequality.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left variant.
• right: The right variant.

Returns

true if the variants are different; otherwise, false.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Variant