AngelScript

Datatypes in AngelScript and C++

# Primitives

Primitives in AngelScript have direct matches in C++.

AngelScript | C++ | Size (bits)
void | void | 0
int8 | signed char | 8
int16 | signed short | 16
int | signed int (*) | 32
int64 | signed int64_t | 64
uint8 | unsigned char | 8
uint16 | unsigned short | 16
uint | unsigned int (*) | 32
uint64 | unsigned uint64_t | 64
float | float | 32
double | double | 64
bool | bool | 8 (**)

(*) An int can actually be of varying size on different platforms in C++, but most commonly it is 32 bits long. AngelScript will always assume 32 bits though.

(**) On 32 bit PowerPC platforms the bool type commonly have the size of 32 bit, when compiled on such platforms AngelScript also uses 32 bits for the bool type

# Strings

AngelScript expects the application to register its own string type, so the string types should match perfectly.

The char* string type that is so convenient in C++ is however very difficult to use in a scripted environment where you do not have full control over how it is used. For that reason it is recommended that you wrap any functions that use the char* string type so that the string is properly converted to an object that can be safely handled by both the application and the script engine, e.g. std::string or another class of your preference.

# Arrays

AngelScript also expects the application to register the type that should be used for dynamic arrays. Normally this is done by registering the array template object add-on, but the application is free to do it differently.

It is also possible to have different object types for different array types, so the application can match the array type exactly with the types used in C++.

# Object handles

The AngelScript object handles are reference counted pointers to objects. This means that for object handles to work, the object must have some way of counting references, for example an AddRef/Release method pair.

When AngelScript passes an object handle by value to a function it increases the reference count to count for the argument instance, thus the function is responsible for releasing the reference once it is finished with it. In the same manner AngelScript expects any handle returned from a function to already have the reference accounted for.

However, when registering functions/methods with AngelScript the application can tell the library that it should automatically take care of releasing the handle references once a function return, likewise for returned handles. This is done by adding a + sign to the @ type modifier. When doing this an object handle can be safely passed to a C++ function that expects a normal pointer, but don't release it afterwards.

See Also
  Object handles

# Script classes and interfaces

All script classes and interfaces are seen as the asIScriptObject type by the application. The asIScriptObject interface has methods to determine the actual type of the script class or interface, as well as to interact with the actual object instance.

See Also
  Using script classes

# Function pointers

All script function pointers are seen as the asIScriptFunction type by the application. The asIScriptFunction type has methods to obtain the name of the function and the parameter and return types, etc.

# Parameter references

Because AngelScript needs to guarantee validity of pointers at all times, it doesn't always pass references to the true object to the function parameter. Instead it creates a copy of the object, whose reference is passed to the function, and if the reference is marked to return a value, the clone is copied back to the original object (if it still exists) once the function returns.

Because of this, AngelScript's parameter references are mostly compatible with C++ references, or pointers, except that the address normally shouldn't be stored for later use, since the object may be destroyed once the function returns.

If it is necessary to store the address of the object, then object handles should be used instead.

Reference | Description
&in | A copy of the value is always taken and the reference to the copy is passed to the function. For script functions this is not useful, but it is maintained for compatibility with application registered functions.
const &in | If the life time of the value can be guaranteed to be valid during the execution of the function, the reference to the true object is passed to the function, otherwise a copy is made.
&out | A reference to an unitialized value is passed to the function. When the function returns the value is copied to the true reference. The argument expression is evaluated only after the function call. This is the best way to have functions return multiple values.
const &out | Useless as the function wouldn't be able to modify the value.
&inout | The true reference is always passed to the function. If the life time of the value cannot be guaranteed, a compile time error is generated and the script writer will have to copy the value to a local variable first. Objects that support object handles are best suitable for this type as they can always be guaranteed.
const &inout | The reference cannot be changed by the function.

If the application wants parameter references that work like they do in C++, then the engine property asEP_ALLOW_UNSAFE_REFERENCES can be set. When this is done, the parameter references can be declared without the `in`, `out`, or `inout`. The parameter references declared without any of the keywords will always pass the address to the original value, and will not have any restrictions to the expressions that can be used. The parameter references with the `in` and `out` keywords will still work like before, but the references with the `inout` keyword will have the restrictions removed so that they work just like normal C++ references.

The application writer and script writer has to be aware that it is possible to write scripts that access invalid references when the library is compiled in this mode, just like it is possible to do so in C++.