Integración con AngelScript

Las ventajas diferenciativas de AngelScript en relación a Lua y Python son principalmente dos:

. Su sintaxis es similar a C++
. No requiere de funciones proxy

Veamos como realizar la integración en sus pasos básicos:

1. Ejecutar un script desde C++

Como primer paso deberemos incluir la cabecera correspondiente para poder acceder al API de integración del sistema de script con nuestro programa C++:

[código C++]

| #include "angelscript.h"


Por otro lado, el enlace con la librería podemos hacerlo del siguiente modo:

[código C++]

| #ifdef _DEBUG
| #pragma comment(lib, "angelscriptd.lib")
| #else
| #pragma comment(lib, "angelscript.lib")


El paso siguiente será cargar el script en un buffer, para luego poder indicarle al motor de script que trabaje con él:

[código C++]

| FILE * fp = fopen("../../scripts/script1.as", "rb");
| int iLength = _filelength(_fileno(fp));
| char * pScriptBuffer = new char[iLength];
| fread(pScriptBuffer, iLength, 1, fp);
| fclose(fp);


Hasta aquí nada fuera de lo común, la única función que no solemos utilizar es _filelength que retorna el tamaño en bytes de un archivo (su prototipo se encuentra en io.h).

Ahora, obtendremos un puntero al motor de scripting con la siguiente línea:

[código C++]

| asIScriptEngine * engine = asCreateScriptEngine(ANGELSCRIPT_VERSION);


Ahora, le pasaremos el buffer donde cargamos el script al motor, junto con dos strings descriptivos del módulo al cual pertenece y la sección:

[código C++]

| engine->AddScriptSection("module", "section", pScriptBuffer, iLength);


Ahora, intentaremos compilar el script:

[código C++]

| int res = engine->Build("module");
| if (res == -1)
| {
| // ...
| }


El siguiente paso será obtener un identificador de la función que deseamos ejecutar dentro del script:

[código C++]

| asIScriptContext *context = 0;
| engine->CreateContext(&context);
| int functionID = engine->GetFunctionIDByDecl("module", "void DoSomething()");
|
| context->Prepare(functionID);


Ahora sí, podremos ejecutar la función dentro del script:

[código C++]

| int r = context->Execute();
| if(r == asEXECUTION_EXCEPTION)
| {
| // ...
| }


Por último, liberamos el contexto que creamos con la función CreateContext líneas atrás:

[código C++]

| context->Release();


El script que llamamos script1.as posee el siguiente código:

[código AngelScript]

| void DoSomething()
| {
| }


2. Ejecutar una función de un script desde C++ pasando un parámetro

Veamos como interactuar con un script. Es posible con el API de AngelScript registrar una variable global desde C++ para que luego un script pueda utilizarla como si la hubiese declarado él mismo.

Si quisiéramos, por ejemplo, declarar una variable global entera deberíamos escribir:

[código C++]

| int iContador = 0;
| engine->RegisterGlobalProperty("int iContador", &iContador);


Estas líneas debemos introducirlas luego de obtener el puntero al motor de scripting pero antes de compilar el script (de otro modo existirá un error de compilación).

El script podría poseer el siguiente código relacionado:

[código AngelScript]

| void DoSomething()
| {
| iContador = 10;
| }


Ahora, podremos recuperar el valor fijado por el script accediendo directamente a dicha variable (recordemos que la declaramos en C++):
cout << “el valor de counter es: ” << iContador << endl;

3. Ejecutar una función C++ desde un script

Hasta el momento pudimos apreciar que ejecutar un simple script lleva un poco más de código (debido a la creación del contexto, preparación y compilación) que con Lua o Python pero acá empieza lo bueno. Para ejecutar una función desde angelscript no debemos estar creando funciones proxy, simplemente registramos nuestra función real

Supongamos que deseamos ejecutar la siguiente función:

[código C++]

| void Print(int value)
| {
| printf("%d", value);
| }


Deberemos registrar la función de la siguiente manera:

[código C++]

| engine->RegisterGlobalFunction("void Print(int)", asFUNCTION(Print), asCALL_CDECL);


Si en cambio nuestra función es:

[código C++]

| void Foo(int value, float value2, float value3)
| {
| }


Entonces deberemos registrarla del siguiente modo:

[código C++]

| engine->RegisterGlobalFunction("void Foo(int, float, float)", asFUNCTION(Foo), asCALL_CDECL);


Un script puede, ahora, hacer uso de cualquier de las funciones registradas del siguiente modo:

[código AngelScript]

| void DoSomething()
| {
| Print(43240);
| }


4. Ejecutar el método de una clase desde un script

Registrar propiedades de clases o métodos también se hace de manera directa. Sólo debemos tener en cuenta ciertas restricciones en el uso de método virtuales.

Partiendo de la siguiente clase:

[código C++]

| class ClaseFoo
| {
| public:
| int valor;
|
| void SetValor(int iVal)
| {
| valor = iVal;
| }
| };


Para registrar la propiedad valor y el método SetValor deberemos escribir:

[código C++]

| // Registro la clase
| engine->RegisterObjectType("ClaseFoo", sizeof(ClaseFoo), asOBJ_CLASS);
| // Registro la propiedad
| engine->RegisterObjectProperty("ClaseFoo", "int valor", offsetof(ClaseFoo, valor));
| // Registro el método
| engine->RegisterObjectMethod("ClaseFoo", "void SetValor(int)", asMETHOD(ClaseFoo, SetValor), asCALL_THISCALL);


A partir de allí un script podrá acceder a esta clase del siguiente modo:

[código C++]

| void DoSomething()
| {
| ClaseFoo foo;
|
| foo.valor = 10;
| foo.SetValor(20);
| }


Conclusión

El objetivo de este documento fue introducir el uso de los sistemas de scripts mas populares del momento, ejemplificar su uso básico e introducir al uso de herramientas complementarias para su integración.

Integrar cualquier sistema de scripts a nuestro motor de juegos o a un programa C++ puede ser muy beneficioso pero decidir cuál o de que forma integrarlo es la decisión difícil.

En la parte 2 de este tutorial veremos que herramientas existen en la red para ayudarnos a integrar estos motores de scripts en nuestro código que suele ser la parte mas trabajosa.

Pages: 1 2 3 4 5 6

Comentarios (3)