The most important data type in Godot.
    public static class Variant

A Variant takes up only 20 bytes and can store almost any engine datatype inside of it. Variants are rarely used to hold information for long periods of time. Instead, they are used mainly for communication, editing, serialization and moving data around.

A Variant:

  • Can store almost any datatype.

  • Can perform operations between many variants. GDScript uses Variant as its atomic/native datatype.

  • Can be hashed, so it can be compared quickly to other variants.

  • Can be used to convert safely between datatypes.

  • Can be used to abstract calling methods and their arguments. Godot exports all its functions through variants.

  • Can be used to defer calls or move data between threads.

  • Can be serialized as binary and stored to disk, or transferred via network.

  • Can be serialized to text and use it for printing values and editable settings.

  • Can work as an exported property, so the editor can edit it universally.

  • Can be used for dictionaries, arrays, parsers, etc.

Containers (Array and Dictionary): Both are implemented using variants. A Dictionary can match any datatype used as key to any other datatype. An Array just holds an array of Variants. Of course, a Variant can also hold a Dictionary and an Array inside, making it even more flexible.

Modifications to a container will modify all references to it. A Mutex should be created to lock it if multi-threaded access is desired.

Inheritance Chain

Inner Types

Operator

Name Value Description
Equal    
NotEqual    
Less    
LessEqual    
Greater    
GreaterEqual    
Add    
Subtract    
Multiply    
Divide    
Negate    
Positive    
Module    
StringConcat    
ShiftLeft    
ShiftRight    
BitAnd    
BitOr    
BitXor    
BitNegate    
And    
Or    
Xor    
Not    
In    
Max    

Type

Name Value Description
Nil    
Bool    
Int    
Real    
String    
Vector2    
Rect2    
Vector3    
Transform2d    
Plane    
Quat    
Aabb    
Basis    
Transform    
Color    
NodePath    
Rid    
Object    
Dictionary    
Array    
RawArray    
IntArray    
RealArray    
StringArray    
Vector2Array    
Vector3Array    
ColorArray    
Max    
Tags: