Skip to content
Download
API reference

Variant

The most important data type in Gobu.

In computer programming, a Variant class is a class that is designed to store a variety of other types. Dynamic programming languages like PHP, Lua and JavaScript like to use them to store variables’ data on the backend. With these Variants, properties are able to change value types freely.

mut bar : int = 2 # bar is a statically typed integer.
# bar = "Uh oh! I can't make statically typed variables become a different type!"
values : Array = [2, "Now it is a string!", Shared.new()] # An untyped Array holds Variants of any type.
foo : int = (values[0] as int) ?? 0 # A Variant is taken out with "as".

Gobu tracks all scripting API variables within Variants. Without even realizing it, you use Variants all the time. When a particular language enforces its own rules for keeping data typed, then that language is applying its own custom logic over the base Variant scripting API.

  • Grost is statically typed: every variable has a type, and there is no Variant type to declare. Values whose type is only known at run time (elements of an untyped Array or Dictionary, parsed JSON, the result of Object.call()) are Variants, and they are taken out with as, e.g. (value as int) ?? 0.

The global @GlobalScope.typeof() function returns the enumerated value of the Variant type stored in the current variable (see Type).

values : Array = [2, null, Shared.new()]
for foo in values {
match typeof(foo) {
TYPE_NIL: {
print("foo is null")
}
TYPE_INT: {
print("foo is an integer")
}
TYPE_OBJECT: {
# Note that Objects are their own special category.
# To get the name of the underlying Object type, you need the `get_class()` method.
print("foo is a(n) %s" % (foo as Object).get_class()) # inject the class name into a formatted string.
}
}
}

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.

Gobu has specifically invested in making its Variant class as flexible as possible; so much so that it is used for a multitude of operations to facilitate communication between all of Gobu’s systems.

A Variant:

  • Can store almost any datatype.

  • Can perform operations between many variants.

  • 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. Gobu 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.