Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

EditorProperty

Успадковує: Container < Control < CanvasItem < Node < Object

Користувацький елемент керування для редагування властивостей, який можна додати до EditorInspector.

Опис

Користувацький елемент керування для редагування властивостей, який можна додати до EditorInspector. Його додають через EditorInspectorPlugin.

Властивості

bool

checkable

false

bool

checked

false

bool

deletable

false

bool

draw_background

true

bool

draw_label

true

bool

draw_warning

false

FocusMode

focus_mode

3 (overrides Control)

bool

keying

false

String

label

""

float

name_split_ratio

0.5

bool

read_only

false

bool

selectable

true

bool

use_folding

false

Методи

void

_set_read_only(read_only: bool) virtual

void

_update_property() virtual

void

add_focusable(control: Control)

void

deselect()

void

emit_changed(property: StringName, value: Variant, field: StringName = &"", changing: bool = false)

Object

get_edited_object()

StringName

get_edited_property() const

bool

is_selected() const

void

select(focusable: int = -1)

void

set_bottom_editor(editor: Control)

void

set_label_reference(control: Control)

void

set_object_and_property(object: Object, property: StringName)

void

update_property()


Сигнали

multiple_properties_changed(properties: PackedStringArray, value: Array) 🔗

Визначте, якщо ви хочете одночасно кілька властивостей. Не використовуйте, якщо додано редакторPlugin._parse_property().


object_id_selected(property: StringName, id: int) 🔗

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


property_can_revert_changed(property: StringName, can_revert: bool) 🔗

Випробувано, коли ревертабельність (тобто, чи має значення невидимості і, таким чином, відображається значок реверта) майна.


property_changed(property: StringName, value: Variant, field: StringName, changing: bool) 🔗

Не випромінюйте це вручну, натомість використовуйте метод emit_changed().


property_checked(property: StringName, checked: bool) 🔗

Випробувано при перевірці майна. Використовується внутрішньо.


property_deleted(property: StringName) 🔗

При видаленні майнового майна. Використовується внутрішньо.


property_favorited(property: StringName, favorited: bool) 🔗

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


property_keyed(property: StringName) 🔗

Визначте, якщо ви хочете додати цю вартість як ключ анімації (перевірка для клавіатури ввімкнено першим).


property_keyed_with_value(property: StringName, value: Variant) 🔗

Визначте це, якщо ви хочете створити нерухомість з одним значенням.


property_overridden() 🔗

Видається, коли запитується перевизначення налаштувань для поточного проєкту.


property_pinned(property: StringName, pinned: bool) 🔗

Визначте, якщо ви хочете відмітити (або немарку) значення майна, що зберігається незалежно від значення за замовчуванням.

Значення за замовчуванням є одним майном буде отримувати, коли вершина просто миттєво і може прийти з позиційного сцени в ланцюжку спадкування / інтенсифікації, скрипт або вбудований клас.


resource_selected(path: String, resource: Resource) 🔗

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


selected(path: String, focusable_idx: int) 🔗

Випробувано при виборі. Використовується внутрішньо.


Описи властивостей

bool checkable = false 🔗

  • void set_checkable(value: bool)

  • bool is_checkable()

Використовується інспектором, встановленим на true при перевірці майна.


bool checked = false 🔗

  • void set_checked(value: bool)

  • bool is_checked()

Використовується інспектором, встановленим на true при перевірці майна.


bool deletable = false 🔗

  • void set_deletable(value: bool)

  • bool is_deletable()

Використовується інспектором, встановленим на true, коли майно може бути видалено користувачем.


bool draw_background = true 🔗

  • void set_draw_background(value: bool)

  • bool is_draw_background()

Використовується інспектором, має значення true, коли малюється фон властивості.


bool draw_label = true 🔗

  • void set_draw_label(value: bool)

  • bool is_draw_label()

Використовується інспектором, має значення true під час малювання мітки властивості.


bool draw_warning = false 🔗

  • void set_draw_warning(value: bool)

  • bool is_draw_warning()

Використовується інспектором, встановленим на true, коли властивість намальовується за кольором попередження редактора. Використовується для редагування властивостей дітей.


bool keying = false 🔗

  • void set_keying(value: bool)

  • bool is_keying()

Використовується інспектором, встановленим на true, коли властивість може додати ключі для анімації.


String label = "" 🔗

  • void set_label(value: String)

  • String get_label()

Встановіть цю властивість для зміни етикетки (якщо ви хочете показати один).


float name_split_ratio = 0.5 🔗

  • void set_name_split_ratio(value: float)

  • float get_name_split_ratio()

Співвідношення розподілу простору між міткою та полем редагування.


bool read_only = false 🔗

  • void set_read_only(value: bool)

  • bool is_read_only()

Використовується інспектором, встановленим на true при прочитуванні майна.


bool selectable = true 🔗

  • void set_selectable(value: bool)

  • bool is_selectable()

Використовується інспектором, має значення true, якщо властивість доступна для вибору.


bool use_folding = false 🔗

  • void set_use_folding(value: bool)

  • bool is_using_folding()

Використовується інспектором, має значення true, коли властивість використовує згортання.


Описи методів

void _set_read_only(read_only: bool) virtual 🔗

Зателефоновано при зміні читаного статусу майна. Може використовуватися для зміни користувацького контролю в режимі читання або модифікаційного стану.


void _update_property() virtual 🔗

Коли ця віртуальна функція називається, ви повинні оновити редактор.


void add_focusable(control: Control) 🔗

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


void deselect() 🔗

Малювати властивість як невибрану. Використовується інспектором.


void emit_changed(property: StringName, value: Variant, field: StringName = &"", changing: bool = false) 🔗

При зміні одного або декількох властивостей, це необхідно назвати. field використовується в разі, якщо ваш редактор може змінювати поля окремо (наприклад, Vector3.x). changing аргумент дозволяє уникнути запиту редактора цього майна, щоб бути оновленим (Зберегти як false if unsure).


Object get_edited_object() 🔗

Повертає відредагований об'єкт.

Примітка: Цей метод може повернути null, якщо редактор ще не пов'язано з властивістю. Однак у _update_property() та _set_read_only() це значення гарантовано буде відмінним від null.


StringName get_edited_property() const 🔗

Повертає відредаговану властивість. Якщо ваш редактор призначений для однієї властивості (доданої через EditorInspectorPlugin._parse_property()), тоді цей метод поверне цю властивість.

Примітка: Цей метод може повернути null, якщо редактор ще не пов'язаний з властивістю. Однак у _update_property() та _set_read_only() це значення гарантовано буде відмінним від null.


bool is_selected() const 🔗

Повертає true, якщо властивість намальована як вибрана. Використовується інспектором.


void select(focusable: int = -1) 🔗

Намалювати властивість як вибрано. Використовується інспектором.


void set_bottom_editor(editor: Control) 🔗

Поставить editor контроль за міткою майна. Контроль необхідно попередньо додавати за допомогою Node.add_child().


void set_label_reference(control: Control) 🔗

Використовується інспектором, установлюється на елемент керування, який використовуватиметься як еталон для розрахунку розміру етикетки.


void set_object_and_property(object: Object, property: StringName) 🔗

Призначає об’єкт і властивість для редагування.


void update_property() 🔗

Примусово оновлює відображення властивостей.