Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

La classe Variant

À propos

Variant is the most important datatype in Godot. A Variant takes up only 24 bytes on 64-bit platforms (20 bytes on 32-bit platforms) 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 generally moving data around.

Un Variant peu :

  • Store almost any datatype.

  • Effectuer des opérations entre plusieurs "Variants" (GDScript utilise le type Variant comme type de données atomique/natif).

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

  • Be used to convert safely between datatypes.

  • Be used to abstract calling methods and their arguments (Godot exports all its functions through variants).

  • Être utilisé pour différer les appels (de fonction) ou déplacer des données entre les threads.

  • Être sérialisé en binaire et stocké sur le disque, ou transféré via le réseau.

  • Être sérialisé en texte et utilisé pour imprimer des valeurs et des paramètres modifiables.

  • Utilisable comme une variable (propriété) exportée, afin que l'éditeur puisse la modifier de façon universelle.

  • Être utilisé dans les dictionnaires, les tableaux, les parseurs , etc.

Fondamentalement, grâce à la classe Variant, écrire Godot lui-même était une tâche beaucoup plus facile, car elle permet des constructions très dynamiques, non triviales en C ++, avec peu d'effort. Devenez un ami des Variants dès aujourd'hui.

Note

All types within Variant except Nil and Object cannot be null and must always store a valid value. These types within Variant are therefore called non-nullable types.

One of the Variant types is Nil which can only store the value null. Therefore, it is possible for a Variant to contain the value null, even though all Variant types excluding Nil and Object are non-nullable.

References

List of variant types

These types are available in Variant:

Type

Notes

Nil (can only store null)

Nullable type

bool

int

float

String

Vector2

Vector2i

Rect2

2D counterpart of AABB

Rect2i

Vector3

Vector3i

Transform2D

Vector4

Vector4i

Plane

Quaternion

AABB

3D counterpart of Rect2

Basis

Transform3D

Projection

Color

StringName

NodePath

RID

Object

Nullable type

Callable

Signal

Dictionary

Array

PackedByteArray

PackedInt32Array

PackedInt64Array

PackedFloat32Array

PackedFloat64Array

PackedStringArray

PackedVector2Array

PackedVector3Array

PackedColorArray

PackedVector4Array

Containers: Array and Dictionary

Both Array and Dictionary 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 or 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.

References