Novelty scripting reference > Types > Variant

Variant

Polymophic type. Used primarily for storing game variables.
Compatible with bool, int, float, double, string, Vector2, Vector3 and Vector4.

Remarks: Has implicit assignment for all compatible types, but can only be retrieved using explicit casting methods.

Related articles:
Variant var;
var = 1.0f;
float f = var.AsFloat();
var = Vector2(1,2);
Vector2 v = var.AsVector2();

$Points = 100;
Print("Points = " + $Points.AsString());

Warning: Variants will morph depending on which type is assigned to it. This can cause data loss in some cases.

Variant var = "Hello.";       // var is "Hello."
var = Vector3(1,2,3);         // var is (1,2,3)
var *= 2.0f;                  // var is (2,4,6)
var += Vector2(1,2);          // var is (3,6)
var -= 2;                     // var is (1)
var += "3,1";                 // var is (13,1)

Constructors

Variant()
Variant(const Variant& Other)
Variant(bool Value)
Variant(int Value)
Variant(float Value)
Variant(double Value)
Variant(const string& Value)
Variant(const Vector2& Other)
Variant(const Vector3& Other)
Variant(const Vector4& Other)


Methods

int AsString()
Returns value as a string.

int AsBool()
Returns value as a boolean.
This returns true unless variant is zero, "" or "false".

int AsInt()
Returns value as an integer.

int AsFloat()
Returns value as a float.

int AsDouble()
Returns value as a double.

int AsVector2()
Returns value as a Vector2.

int AsVector3()
Returns value as a Vector3.

int AsVector4()
Returns value as a Vector4.


Back to top