Разработка → Cocos2d-x: Используем собственный C++ класс в Lua

из песочницы
denis_p 28 октября 2014 в 09:58 5,6k
Всем доброго времени суток.

Так уж сложилось, что про использование cocos2d-x Lua в природе существует довольно мало информационных материалов, даже с учётом англоязычных источников. Поэтому во многом приходится разбираться самому, копаясь в чужом коде и читая (часто не особо содержательную) документацию.

В этой статье я хочу хотя бы частично исправить эту несправедливость и рассказать о расширении стандартного функционала доступного в cocos2d-x Lua с помощью нативных классов.

С этой задачей я столкнулся, можно сказать, лицом к лицу после осознания собственных скудных знаний Lua. Тогда же и созрело решение часть игровой логики написать на старом добром C++.

Итак, кому интересен данный процесс прошу под кат.

В качестве отправной точки примем то, что у вас установлена и настроена CocosCode IDE. Если нет, то об этом есть неплохая статья на русском вот здесь.

1. Создаём наш С++ класс


Начнём с создания класса, который мы будем подключать к Lua.

MyClass.hpp
#ifndef MyClass_hpp
#define MyClass_hpp

#include "cocos2d.h"
#include <string>
using std::string;
namespace cocos2d {

class MyClass : public cocos2d::Ref
{
public:
    MyClass();
    ~MyClass();
    bool init();
    string myFunction();
    CREATE_FUNC(MyClass);
};

} //namespace cocos2d

#endif

Здесь следует обратить внимание на то, что наш класс должен быть наследником от Ref, что вызвано особенностями управления памятью в cocos2d-x.

MyClass.cpp
#include "MyClass.hpp"
using namespace cocos2d;

MyClass::MyClass() {}

MyClass::~MyClass() {}

bool MyClass::init()
{
    return true;
}

string MyClass::myMethod() 
{
    return "Hello, Habrahabr!";
}

Файлы с нашим классом мы помещаем в директорию «myclass», которую создаём в /framework/cocos2d-x/cocos/ (внутри проекта). Если у вас нет папки framework, то в CocosCode нужно выполнить следующее:
Клацнуть правой кнопкой мыши на проект -> Cocos Tools -> Add Native Code Support

2. Создаём Lua обёртку для нашего класса


Для этого в папке /frameworks/cocos2d-x/tools/tolua создадим следующий файл:
cocos2dx_myclass.ini
[cocos2dx_myclass]
# the prefix to be added to the generated functions. You might or might not use this in your own
# templates
prefix = cocos2dx_myclass

# create a target namespace (in javascript, this would create some code like the equiv. to `ns = ns || {}`)
# all classes will be embedded in that namespace
target_namespace =

android_headers = -I%(androidndkdir)s/platforms/android-14/arch-arm/usr/include -I%(androidndkdir)s/sources/cxx-stl/gnu-libstdc++/4.7/libs/armeabi-v7a/include -I%(androidndkdir)s/sources/cxx-stl/gnu-libstdc++/4.7/include -I%(androidndkdir)s/sources/cxx-stl/gnu-libstdc++/4.8/libs/armeabi-v7a/include -I%(androidndkdir)s/sources/cxx-stl/gnu-libstdc++/4.8/include
android_flags = -D_SIZE_T_DEFINED_

clang_headers = -I%(clangllvmdir)s/lib/clang/3.3/include
clang_flags = -nostdinc -x c++ -std=c++11

cocos_headers = -I%(cocosdir)s/cocos -I%(cocosdir)s/myclass -I%(cocosdir)s/cocos/base -I%(cocosdir)s/cocos/platform/android
cocos_flags = -DANDROID

cxxgenerator_headers =

# extra arguments for clang
extra_arguments = %(android_headers)s %(clang_headers)s %(cxxgenerator_headers)s %(cocos_headers)s %(android_flags)s %(clang_flags)s %(cocos_flags)s %(extra_flags)s

# what headers to parse
headers = %(cocosdir)s/cocos/myclass/MyClass.hpp

# what classes to produce code for. You can use regular expressions here. When testing the regular
# expression, it will be enclosed in "^$", like this: "^Menu*$".
classes = MyClass.*

# what should we skip? in the format ClassName::[function function]
# ClassName is a regular expression, but will be used like this: "^ClassName$" functions are also
# regular expressions, they will not be surrounded by "^$". If you want to skip a whole class, just
# add a single "*" as functions. See bellow for several examples. A special class name is "*", which
# will apply to all class names. This is a convenience wildcard to be able to skip similar named
# functions from all classes.

skip =

rename_functions =

rename_classes =

# for all class names, should we remove something when registering in the target VM?
remove_prefix =

# classes for which there will be no «parent» lookup
classes_have_no_parents =

# base classes which will be skipped when their sub-classes found them.
base_classes_to_skip =

# classes that create no constructor
# Set is special and we will use a hand-written constructor
abstract_classes =

# Determining whether to use script object(js object) to control the lifecycle of native(cpp) object or the other way around. Supported values are 'yes' or 'no'.
script_control_cpp = no

Вдаваться в подробности содержимого этого файла я не буду, об этом можно прочесть здесь.

Теперь нам нужно добавить только что созданный ini файл в сценарий генерации Lua обёрток. Для этого откроем genbindings.py и добавим перед закрывающей фигурной скобкой следующую строку:

cmd_args = {'cocos2dx.ini' : ('cocos2d-x', 'lua_cocos2dx_auto'), \
                    'cocos2dx_extension.ini' : ('cocos2dx_extension', 'lua_cocos2dx_extension_auto'), \
                    'cocos2dx_ui.ini' : ('cocos2dx_ui', 'lua_cocos2dx_ui_auto'), \
                    'cocos2dx_studio.ini' : ('cocos2dx_studio', 'lua_cocos2dx_studio_auto'), \
                    'cocos2dx_spine.ini' : ('cocos2dx_spine', 'lua_cocos2dx_spine_auto'), \
                    'cocos2dx_physics.ini' : ('cocos2dx_physics', 'lua_cocos2dx_physics_auto'), \
                    'cocos2dx_experimental_video.ini' : ('cocos2dx_experimental_video', 'lua_cocos2dx_experimental_video_auto'), \
                    'cocos2dx_experimental.ini' : ('cocos2dx_experimental', 'lua_cocos2dx_experimental_auto'), \
                    'cocos2dx_controller.ini' : ('cocos2dx_controller', 'lua_cocos2dx_controller_auto'), \
                    'cocos2dx_myclass.ini' : ('cocos2dx_myclass', 'lua_cocos2dx_myclass_auto') \
                    }

Запускаем genbindings.py. В случае успешного проведения всех описанных выше манипуляций, у нас должны появиться следующие файлы (в директории /frameworks/cocos2d-x/cocos/scripting/lua-binding):

  • lua_cocos2dx_myclass_auto.hpp
  • lua_cocos2dx_myclass_auto.cpp
  • ./api/MyClass.lua

Теперь у нас есть всё необходимое для подключения нашего класса к Lua. Этот процесс состоит из двух однотипных процедур: одна для iOS, другая для Android.

3.1. Подключение файлов к iOS


Открываем проект приложения. Первым делом, добавим С++ исходники к cocos2d_libs:



Теперь добавляем сгенерированные файлы к cocos2d_lua_bindings:



Не забудем также задать путь к заголовочным файлам в cocos2d_lua_bindings -> Build Settings -> User Header Search Paths



Пользуясь удобным случаем, зарегистрируем наш класс в AppDelegate.cpp:

...

#include "ConfigParser.h"

// Это наш сгенерированный заголовочный файл
#include "lua_cocos2dx_myclass_auto.hpp"

using namespace CocosDenshion;

bool AppDelegate::applicationDidFinishLaunching()
{
    ...
   
    // set FPS. the default value is 1.0/60 if you don't call this
    director->setAnimationInterval(1.0 / 60);
   
    auto engine = LuaEngine::getInstance();
    ScriptEngineManager::getInstance()->setScriptEngine(engine);

    LuaStack* stack = engine->getLuaStack();
    stack->setXXTEAKeyAndSign("2dxLua", strlen("2dxLua"), "XXTEA", strlen("XXTEA"));
    
    // А тут мы регистрируем наш класс
    register_all_cocos2dx_myclass(stack->getLuaState());
    
#if (COCOS2D_DEBUG>0)
    if (startRuntime())
        return true;
#endif

    engine->executeScriptFile(ConfigParser::getInstance()->getEntryFile().c_str());
    return true;
}
...

На этом наши приключения с iOS заканчиваются.

3.2. Подключение файлов к Android


Здесь по сути всё аналогично предыдущему разделу. Нужно подключить исходники класса к cocos2d-x проекту и сгенерированные файлы к cocos2dx_lua проекту. Разница только в том, что дело придется иметь с текстовыми файлами Android.mk.

Добавляем файлы нашего класса в проект кокоса. Для этого вносим несколько дополнений в файл /frameworks/cocos2d-x/cocos/Android.mk

Здесь (указываем *.cpp файлы):



И вот здесь (указываем путь к заголовочным файлам):



Теперь осталось подключить сгенерированные файлы к cocos2d_lua. Для этого нужно отредактировать файл /frameworks/cocos2d-x/cocos/scripting/lua-bindings/Android.mk

Тут (указываем *.cpp файл):



И ещё вот тут (указываем путь к заголовочному файлу):



4. Обновляем среду выполнения


В принципе, всё уже будет работать, если запускать проект в XCode или Eclipse. Чтобы всё работало и в CocosCode IDE, нужно пересобрать среду выполнения. Для этого щёлкаем правой кнопкой мыши на проект -> Cocos Tools -> Build Custom Runtimes. Вот и всё.

5. Запускаем, радуемся


Не вижу особого смысла показывать результаты в виде скриншотов одной единственной строки в консоле. Тем не менее, вывод будет таким:

[Lua Debug]: Hello, Habrahabr!

Аналогичным образом с помощью binding-generator-a можно добавлять свои классы и в cocos2d-js. Следует однако предупредить, что на нормальный запуск самого генератора мне пришлось потратить добрые пару часов. Возился с несоответствием разных необходимых библиотек. Если всё делать как написано, то проблем быть не должно (указания по настройке генератора можно найти вот здесь).

P.S.


На мой взгляд, «подвязка» движка к скриптовым языкам в некоторых случаях может здорово упростить жизнь. Не знаю, упростила ли она жизнь мне в конечном итоге, но интересный опыт я приобрел.
Проголосовать:
+14
Сохранить: