This translation is community contributed and may not be up to date. We only maintain the English version of the documentation. Read this manual in English
Редактор Defold обеспечивает автоматическое заполнение предложений для всех функций API Defold и генерирует предложения для модулей Lua, необходимых для ваших скриптов. Однако редактор не может автоматически предоставлять предложения по автозаполнению для функций, предоставляемых родными расширениями. Родное расширение может предоставить определение API в отдельном файле, чтобы обеспечить автоматическое заполнение предложений также для API расширения
Файл определения API скрипта имеет расширение .script_api
. Он должен быть в формате YAML и находиться вместе с файлами расширения. Ожидаемый формат определения API скрипта следующий:
- name: The name of the extension
type: table
desc: Extension description
members:
- name: Name of the first member
type: Member type
desc: Member description
# если тип члена - "function"
parameters:
- name: Name of the first parameter
type: Parameter type
desc: Parameter description
- name: Name of the second parameter
type: Parameter type
desc: Parameter description
# если тип члена - "function"
returns:
- name: Name of first return value
type: Return value type
desc: Return value description
examples:
- desc: First example of member usage
- desc: Second example of member usage
- name: Name of the second member
...
Типы могут быть любыми из table, string, boolean, number, function
. Если значение может иметь несколько типов, оно записывается как [type1, type2, type3]
.
В настоящее время типы не отображаются в редакторе. Рекомендуется все же предоставить их, чтобы они были доступны, когда редактор будет поддерживать отображение информации о типах.
Примеры использования приведены в следующих проектах:
Did you spot an error or do you have a suggestion? Please let us know on GitHub!
GITHUB