Експорт в GDScript

Вступ до експорту

У Godot члени класу можуть експортуватися. Це означає, що їх значення зберігається разом із ресурсом (наприклад, сценою), до якого вони приєднані. Вони також будуть доступні для редагування в редакторі властивостей. Експорт здійснюється за допомогою ключового слова export:

extends Button

export var number = 5 # Value will be saved and visible in the property editor.

Експортована змінна повинна бути ініціалізована до постійного виразу, або мати підказку щодо експорту, у вигляді аргументу до ключового слова export (дивіться розділ Приклади нижче).

Однією з основних переваг експорту змінних є те, що їх можна побачити та редагувати у редакторі. Таким чином, художники та розробники ігор можуть змінювати значення, які згодом впливають на роботу програми. Для цього передбачений спеціальний синтаксис експорту.

Примітка

Експорт властивостей також можна виконати іншими мовами, такими як C#. Синтаксис змінюється залежно від мови.

Приклади

# If the exported value assigns a constant or constant expression,
# the type will be inferred and used in the editor.

export var number = 5

# Export can take a basic data type as an argument, which will be
# used in the editor.

export(int) var number

# Export can also take a resource type to use as a hint.

export(Texture) var character_face
export(PackedScene) var scene_file
# There are many resource types that can be used this way, try e.g.
# the following to list them:
export(Resource) var resource

# Integers and strings hint enumerated values.

# Editor will enumerate as 0, 1 and 2.
export(int, "Warrior", "Magician", "Thief") var character_class
# Editor will enumerate with string names.
export(String, "Rebecca", "Mary", "Leah") var character_name

# Named enum values

# Editor will enumerate as THING_1, THING_2, ANOTHER_THING.
enum NamedEnum {THING_1, THING_2, ANOTHER_THING = -1}
export(NamedEnum) var x

# Strings as paths

# String is a path to a file.
export(String, FILE) var f
# String is a path to a directory.
export(String, DIR) var f
# String is a path to a file, custom filter provided as hint.
export(String, FILE, "*.txt") var f

# Using paths in the global filesystem is also possible,
# but only in scripts in "tool" mode.

# String is a path to a PNG file in the global filesystem.
export(String, FILE, GLOBAL, "*.png") var tool_image
# String is a path to a directory in the global filesystem.
export(String, DIR, GLOBAL) var tool_dir

# The MULTILINE setting tells the editor to show a large input
# field for editing over multiple lines.
export(String, MULTILINE) var text

# Limiting editor input ranges

# Allow integer values from 0 to 20.
export(int, 20) var i
# Allow integer values from -10 to 20.
export(int, -10, 20) var j
# Allow floats from -10 to 20 and snap the value to multiples of 0.2.
export(float, -10, 20, 0.2) var k
# Allow values 'y = exp(x)' where 'y' varies between 100 and 1000
# while snapping to steps of 20. The editor will present a
# slider for easily editing the value.
export(float, EXP, 100, 1000, 20) var l

# Floats with easing hint

# Display a visual representation of the 'ease()' function
# when editing.
export(float, EASE) var transition_speed

# Colors

# Color given as red-green-blue value (alpha will always be 1).
export(Color, RGB) var col
# Color given as red-green-blue-alpha value.
export(Color, RGBA) var col

# Nodes

# Another node in the scene can be exported as a NodePath.
export(NodePath) var node_path
# Do take note that the node itself isn't being exported -
# there is one more step to call the true node:
var node = get_node(node_path)

# Resources

export(Resource) var resource
# In the Inspector, you can then drag and drop a resource file
# from the FileSystem dock into the variable slot.

# Opening the inspector dropdown may result in an
# extremely long list of possible classes to create, however.
# Therefore, if you specify an extension of Resource such as:
export(AnimationNode) var resource
# The drop-down menu will be limited to AnimationNode and all
# its inherited classes.

Слід зазначити, що навіть якщо скрипт не запущений в редакторі, експортовані властивості можна редагувати. Це може бути використано спільно зі скриптом в режимі "інструмент".

Експорт бітових прапорців

Цілі числа, що використовуються як бітові позначки, можуть зберігати декілька true/false (булевих) значень в одній властивості. За допомогою підказки щодо експорту int, FLAGS, ..., їх можна встановити з редактора:

# Set any of the given flags from the editor.
export(int, FLAGS, "Fire", "Water", "Earth", "Wind") var spell_elements = 0

Ви повинні надати опис рядка для кожної позначки. У цьому прикладі Fire має значення 1, Water - 2, Earth - 4 і Wind відповідає значенню 8. Зазвичай константи слід визначати відповідно (наприклад const ELEMENT_WIND = 8 тощо).

Також передбачені підказки щодо експорту для фізики та шарів візуалізації, визначених у параметрах проєкту:

export(int, LAYERS_2D_PHYSICS) var layers_2d_physics
export(int, LAYERS_2D_RENDER) var layers_2d_render
export(int, LAYERS_3D_PHYSICS) var layers_3d_physics
export(int, LAYERS_3D_RENDER) var layers_3d_render

Використання бітових значень вимагає певного розуміння побітових операцій. Якщо ви сумніваєтесь, використовуйте замість них логічні змінні.

Експорт масивів

Експортовані масиви можуть мати ініціалізатори, але вони повинні бути постійними виразами.

Якщо експортований масив задає тип, який успадковується від Ресурса, значення масиву можна встановити в інспекторі, перетягуючи одночасно кілька файлів із панелі Файлова система.

# Default value must be a constant expression.

export var a = [1, 2, 3]

# Exported arrays can specify type (using the same hints as before).

export(Array, int) var ints = [1, 2, 3]
export(Array, int, "Red", "Green", "Blue") var enums = [2, 1, 0]
export(Array, Array, float) var two_dimensional = [[1.0, 2.0], [3.0, 4.0]]

# You can omit the default value, but then it would be null if not assigned.

export(Array) var b
export(Array, PackedScene) var scenes

# Arrays with specified types which inherit from resource can be set by
# drag-and-dropping multiple files from the FileSystem dock.

export(Array, Texture) var textures
export(Array, PackedScene) var scenes

# Typed arrays also work, only initialized empty:

export var vector3s = PoolVector3Array()
export var strings = PoolStringArray()

# Default value can include run-time values, but can't
# be exported.

var c = [a, 2, 3]

Встановлення експортованих змінних зі скрипту інструмента

При зміні значення експортованої змінної зі скрипту в Режим інструмента, значення в інспекторі не оновлюється автоматично. Щоб оновити його, викликайте property_list_changed_notify() після встановлення значення експортованої змінної.

Розширений експорт

Не кожен вид експорту можна забезпечити на рівні самої мови, щоб уникнути зайвої складності проєктування. Далі описуються деякі більш-менш загальні функції експорту, які можна реалізувати за допомогою API низького рівня.

Перш ніж читати далі, ви повинні ознайомитися з тим, як обробляються властивості та як їх можна налаштувати за допомогою методів _set(), _get(), та _get_property_list(), як описано в Доступ до даних або логіки від об’єкта.

Дивись також

Для прив'язки властивостей, що використовуються в вищезгаданих методах в C++, дивіться Binding properties using _set/_get/_get_property_list.

Попередження

Скрипт повинен працювати в режимі tool, щоб вищезазначені методи могли працювати з редактора.

Додавання скрипту категорій

Для кращого візуального розрізнення властивостей в інспектор може бути вбудована спеціальна категорія скрипту, щоб діяти як розділювач. Script Variables є одним із прикладів вбудованої категорії.

func _get_property_list():
    var properties = []
    properties.append(
        {
            name = "Debug",
            type = TYPE_NIL,
            usage = PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_SCRIPT_VARIABLE
        }
    )
    return properties
  • name це назва категорії, яка буде додана до інспектора;

  • PROPERTY_USAGE_CATEGORY вказує на те, що властивість слід розглядати як категорію скрипта, тому тип TYPE_NIL можна ігнорувати, оскільки він фактично не використовуватиметься для логіки скрипта, але його все одно потрібно визначити.

Групування властивостей

Список властивостей з подібними назвами можна згрупувати.

func _get_property_list():
    var properties = []
    properties.append({
            name = "Rotate",
            type = TYPE_NIL,
            hint_string = "rotate_",
            usage = PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SCRIPT_VARIABLE
    })
    return properties
  • name це назва групи, яка буде відображатися як розбірний список властивостей;

  • кожна наступна властивість додана після властивості групи, буде згорнуто та скорочено відповідно до префікса, визначеного за допомогою ключа hint_string. Наприклад, у цьому випадку rotate_speed буде скорочено до speed.

  • PROPERTY_USAGE_GROUP вказує на те, що властивість слід розглядати як групу скриптів, тому тип TYPE_NIL можна ігнорувати, оскільки він фактично не використовуватиметься для логіки скрипта, але його все одно потрібно визначити.