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.

Checking the stable version of the documentation...

Script

Успадковує: Resource < RefCounted < Object

Успадковано від: CSharpScript, GDScript, ScriptExtension

Клас зберігається як ресурс.

Опис

Клас зберігається як ресурс. Скрипт розширює функціональність всіх об'єктів, які миттєво переходять її.

Це базовий клас для всіх скрипти і не слід використовувати безпосередньо. Намагатися створити новий скрипт з цим класом призведе до помилки.

new метод скриптового підкласу створює новий екземпляр. Object.set_script() розширює існуючий об'єкт, якщо цей клас відповідає одному з базових класів скриптів.

Посібники

Властивості

String

source_code

Методи

bool

can_instantiate() const

Script

get_base_script() const

StringName

get_global_name() const

StringName

get_instance_base_type() const

Variant

get_property_default_value(property: StringName)

Variant

get_rpc_config() const

Dictionary

get_script_constant_map()

Array[Dictionary]

get_script_method_list()

Array[Dictionary]

get_script_property_list()

Array[Dictionary]

get_script_signal_list()

bool

has_script_method(method_name: StringName) const

bool

has_script_signal(signal_name: StringName) const

bool

has_source_code() const

bool

instance_has(base_object: Object) const

bool

is_abstract() const

bool

is_tool() const

Error

reload(keep_state: bool = false)

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

String source_code 🔗

  • void set_source_code(value: String)

  • String get_source_code()

Початковий код або порожній рядок, якщо вихідний код не доступний. При налаштуванні автоматично не перезавантажити клас.

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

bool can_instantiate() const 🔗

Повертає true, якщо скрипт може бути миттєвим.

Script get_base_script() const 🔗

Повернути скрипт безпосередньо успадкував цей скрипт.

StringName get_global_name() const 🔗

Повертає назву класу, пов’язану зі сценарієм, якщо вона є. В іншому випадку повертає порожній рядок.

Щоб дати сценарію глобальне ім’я, ви можете використати ключове слово class_name у GDScript і атрибут [GlobalClass] у C#.

class_name MyNode
extends Node

StringName get_instance_base_type() const 🔗

Повернення базового типу скрипта.

Variant get_property_default_value(property: StringName) 🔗

Повертає значення за замовчуванням вказаного майна.

Variant get_rpc_config() const 🔗

Повертає назви методів зіставлення Dictionary із їхньою конфігурацією RPC, визначеною цим сценарієм.

Dictionary get_script_constant_map() 🔗

Повертає словник, що містить постійні імена та їх значення.

Array[Dictionary] get_script_method_list() 🔗

Повертає список методів у цьому ``Script.

[b``Примітка:** Словники, що повертаються цим методом, відформатовані ідентично тим, що повертаються методом Object.get_method_list().

Array[Dictionary] get_script_property_list() 🔗

Повертає список властивостей у цьому Script.

Примітка: Словники, що повертаються цим методом, відформатовані ідентично тим, що повертаються Object.get_property_list().

Array[Dictionary] get_script_signal_list() 🔗

Повертає список сигналів, визначених у цьому Script.

Примітка: Словники, що повертаються цим методом, відформатовані ідентично тим, що повертаються Object.get_signal_list().

bool has_script_method(method_name: StringName) const 🔗

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

bool has_script_signal(signal_name: StringName) const 🔗

Повертає true, якщо скрипт, або базовий клас, визначає сигнал з вказаною назвою.

bool has_source_code() const 🔗

Повертає true, якщо скрипт містить вихідний коду..

Примітка: Якщо скрипт не має початкового коду, це не означає, що він не є недійсним або непристойним. Наприклад, GDScript, який був експортований з бінарною токенізацією, не має початкового коду, але все ще бджоли, як очікується, і може бути миттєвим. Це можна перевірити can_instantiate().

bool instance_has(base_object: Object) const 🔗

Застаріло: Compare this script with Object.get_script() instead.

true якщо base_object є екземпляром цього сценарію.

bool is_abstract() const 🔗

true, якщо скрипт є абстрактним скриптом. Анотація скрипта не має конструктора і не може бути миттєвим.

bool is_tool() const 🔗

Повертає true, якщо скрипт є скриптом інструменту. У редакторі можна запустити скрипт інструментів.

Error reload(keep_state: bool = false) 🔗

Перезавантажити виконання шаблону. Повертаємо код помилки.