[PythonAPI] Методы для работы с Flash

[MedvedevTD]

 

PythonAPI - Flash

Методы "Flash" предназначены для работы с Flash-частью мода (Main.swf файлом)

 

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

flash

• flash.call(methodName, args = None)
• flash.addExternalCallback(command, function)
• flash.removeExternalCallback(command = None, function = None)
• flash.loadFlashMod(modName)
• flash.loadPyMod(modName)
• flash.reloadMod(modName, needToReloadPy = False)
• flash.unloadMod(modName, needToUnloadPy = False)
• flash.getModsStatus()
• flash.setUbMarkup( xml_url, swf_url, rootElement )
• flash.setUbData(data)

 

---

flash.call(name, args)

Данный метод вызывает коллбек, который позволяет вызвать функцию в Flash файле мода.

Принимает аргументы:

• name - имя, ключ коллбека, на который должна быть подписана функция во Flash части
• args - list содержащий передаваемые параметры (или пустой, без параметров), который будет передан вызываемой функции для дальнейшей обработки

 

 

---

falsh.addExternalCallback(name, func)

Данный метод добавляет коллбэк, который подписывает и вызывает функцию обработчик "func" в Python части мода, эта функция принимает вызов из Flash части мода аналогично предыдущему методу.

Входные аргументы:

• name - имя, ключ коллбека
• func - функция-обработчик коллбека

 

 

---

flash.removeExternalCallback(name, func)

Данный метод удаляет коллбэк с идентификатором "name" для функции-обработчика "func".

Входные параметры функции:

• name - имя, ключ коллбека
• func - функция-обработчик коллбека

Примечание: При вызове данной функции без параметров будет полностью очищен список функций-обработчиков для текущего мода.

 

---

flash.loadFlashMod(modName)

Данный метод загружает Flash-часть мода, если она не была загружена ранее, либо была выгружена.

Входной аргумент "modName" - название мода (название папки с модом).

 

---

flash.loadPyMod(modName)

Данный метод загружает Python-часть мода, если она не была загружена ранее, либо была выгружена. Данный метод так же загрузит Flash-часть мода.

Входной аргумент modName - название мода.

 

---

flash.reloadMod(modName, needToReloadPy)

Данный метод перезагружает мод.

Входные аргументы:

• modName - имя, идентификатор мода
• needToReloadPy - требуется ли перезагружать Python-часть мода (False - предустановленное базовое значение аргумента)

 

 

---

flash.unloadMod(modName, needToUnloadPy)

Данный метод выгружает (отключает) мод.

Входные аргументы функции:

• modName - имя, название мода
• needToUnloadPy - требуется ли выгрузить Python-часть мода (False - базовое значение аргумента)

 

---

flash.getModsStatus()

Данный метод возвращает dict, в котором ключи - названия модов, значения - их статусы загрузки (True/False)

 

 

---

flash.setUbMarkup(xml_url, swf_url, rootElement)

Данный метод загружает пользовательский *.xml файл с разметкой unbound.

Входные аргументы метода:

• xml_url <type 'str'> - пуьт к *.xml файлу с разметкой
• swf_url <type 'str'> - пуьт к *.swf файлу с скомпилированными выражениями
• rootElement <type 'str'> - название root элемента для загрузки

 

---

flash.detUbData(data)

Данный метод передает данные в скоуп элемента.

Входные аргументы метода:

• data <type 'dict'> - словарь, в котором ключ - название переменной, значение - значение переменной
  Для получения данных в scoup необходимо объявить контроллер "lesta.api.UbModController" в *.xml файле с разметкой