[FlashAPI] Создание Flash части мода

[MatroseFuchs]

FlashAPI

Для создания Flash части мода нам потребуется редактор под ActionScript 3, подойдут такие как "FlashDevelop", "Adobe Flash Professional", "Adobe Flash Builder" и др.

Создадим новый AS3 проект, главный файл назавем "Main", он будет иметь расширение "*.as", и в зависимости от выбранной IDE (редактора) добавим к проекту внешнюю SWC-библиотеку, актуальную версию которой можно будет взять из наших ресурсов.

 

(пример добавления в Flash Builder)

 

Далее в созданном проекте в файле "Main.as" доработаем скрипт для заготовки под наш мод.

 

 

Теперь мы можем создать Flash часть мода. Как мы видим, наш главный класс имеет базовый класс "ModBase", который содержится в добавленной библиотеке, без этого класса наш Flash файл мода работать не будет.

[MatroseFuchs]

FlashAPI - DataBridgeModule

Методы "Data Bridge Module" позволяют моду передавать или получать данные в/из Python части мода.

 

Доступные методы:

gameAPI.data

• gameAPI.data.call(methodName:String, params:Array):void
• gameAPI.data.addCallBack(methodName:String, func:Function):void
• gameAPI.data.removeCallBack(methodName:String = null, callBack:Function = null):void

gameAPI.data.call(methodName:String, params:Array)

Метод позволяет передать информацию в Python часть мода.
Входные параметры:

• "methodName" - имя, ключ коллбэка, на который подписана функция в Python (в Python - falsh.addExternalCallback(name, func), где "name" соответствует "methodName")
• "params" - список (Array) передаваемых параметров.

---

gameAPI.data.addCallBack(methodName:String, func:Function)

Метод добавляет коллбэк для получения информации из Python'a (в Python - flash.call(name, args)), на который подписана функция во Flash.
Входные параметры:

• "methodName" - имя, ключ коллбэка, на который подписана функция во Flash части мода (Main.swf-файл)
• "func" - функция-обработчик коллбэка

---

gameAPI.data.removeCallBack(methodName:String = null, callBack:Function = null)

Метод удаляет коллбэк, на который подписана функция во Flash.
Входные параметры:

• "methodName" - имя, ключ коллбэка, на который подписана функция во Flash части мода (Main.swf-файл)
• "callBack" - функция-обработчик коллбэка

[MatroseFuchs]

FlashAPI - StageModule

Методы "StageModule" предоставляют возможность работать со сценой "Stage".

 

Доступные методы:

gameAPI.stage

• gameAPI.stage.addChild(child:displayObject)
• gameAPI.stage.addChildAt(child:displayObject, index:int)
• gameAPI.stage.removeChild(child:displayObject)
• gameAPI.stage.removeChildAt(index:int)
• gameAPI.stage.width()
• gameAPI.stage.height()

gameAPI.stage.addChild(child:displayObject)

Работает аналогично методу "addChild", добавляет экземпляр "displayObject" на сцену "Stage" для визуализации объекта.
Входной аргумент "child" - создаваемый графический объект Flash-а.

---

gameAPI.stage.addChildAt(child:displayObject, index:int)

Аналогично методу "addChildAt", добавляет DispalyObject на определенный слой Stage'a.
Входные аргументы: "child" - создаваемый графический объект Flash-а; index - порядковый номер слоя, на который должен быть добавлен DisplayObject.

---

gameAPI.stage.removeChild(child:displayObject)

Метод удаляет DispalyObject со Stage.
Входной аргумент "child" - DisplayObject, который должен быть удален со Stage.

---

gameAPI.stage.removeChildAt(index:int)

Метод удаляет выбранный слой со Stage.
Входной аргумент "index" - порядковый номер слоя, с которого должен быть удален DisplayObject.

---

gameAPI.stage.width()

Метод возвращает ширину сцены Stage.
Возвращаемое значение имеет тип данных "Number".

---

gameAPI.stage.height()

Метод возвращает высоту Stage
Возвращаемое значение имеет тип данных "Number".