Script
Класс, хранящийся как ресурс.
Класс, хранящийся как ресурс.
Класс, хранящийся как ресурс. Скрипт расширяет функциональность всех объектов, которые его инстанцируют.
Это базовый класс для всех скриптов, и его не следует использовать напрямую. Попытка создать новый скрипт с этим классом приведет к ошибке.
Метод new подкласса скрипта создает новый экземпляр. ReckfellObject.SetScript расширяет существующий объект, если класс этого объекта соответствует одному из базовых классов скрипта.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Свойства1
SourceCodeСвойство
public string SourceCode { get; set; }Исходный код скрипта или пустая строка, если исходный код недоступен. Если установлено, реализация класса не перезагружается автоматически.
Методы19
CanInstantiatebool
public bool CanInstantiate();Возвращает true, если скрипт может быть создан.
boolGetBaseScriptScript
public Script GetBaseScript();Возвращает скрипт, напрямую унаследованный данным скриптом.
ScriptGetGlobalNameStringName
public StringName GetGlobalName();Возвращает название класса, связанное с скриптом, если он есть. Возвращает пустую строчку в противном случае.
Чтобы дать скрипту глобальное название, вы можете использовать class_name Ключевые слова в C# и GlobalClass атрибут в C#.
using Reckfell;
[GlobalClass]
public partial class MyNode : Entity
{
}StringNameGetInstanceBaseTypeStringName
public StringName GetInstanceBaseType();Возвращает базовый тип скрипта.
StringNameGetPropertyDefaultValueVariant
public Variant GetPropertyDefaultValue(StringName property);Возвращает значение по умолчанию указанного свойства.
Примечание: В C# и C# этот метод возвращает null за пределами редактора.
| Имя | Тип | По умолчанию |
|---|---|---|
property | StringName | — |
VariantGetRpcConfigVariant
public Variant GetRpcConfig();Возвращает Reckfell.Collections.Dictionary, сопоставляющий имена методов с их конфигурацией RPC, определенной этим скриптом.
VariantGetScriptConstantMapReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary GetScriptConstantMap();Возвращает словарь, содержащий имена констант и их значения.
Reckfell.Collections.DictionaryGetScriptMethodListReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetScriptMethodList();Возвращает список методов в этом Script.
Примечание: Словари, возвращаемые этим методом, отформатированы так же, как и возвращаемые ReckfellObject.GetMethodList.
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>GetScriptPropertyListReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetScriptPropertyList();Возвращает список свойств в этом Script.
Примечание: Словари, возвращаемые этим методом, отформатированы так же, как и возвращаемые ReckfellObject.GetPropertyList.
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>GetScriptSignalListReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetScriptSignalList();Возвращает список сигналов, определенных в этом Script.
Примечание: Словари, возвращаемые этим методом, имеют тот же формат, что и словари, возвращаемые ReckfellObject.GetSignalList.
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>GetSourceCodestring
public string GetSourceCode();stringHasScriptMethodbool
public bool HasScriptMethod(StringName methodName);Возвращает true, если скрипт или базовый класс определяет метод с указанным именем.
| Имя | Тип | По умолчанию |
|---|---|---|
methodName | StringName | — |
boolHasScriptSignalbool
public bool HasScriptSignal(StringName signalName);Возвращает true, если скрипт или базовый класс определяет сигнал с указанным именем.
| Имя | Тип | По умолчанию |
|---|---|---|
signalName | StringName | — |
boolHasSourceCodebool
public bool HasSourceCode();Returns (Возврат) true если в скрипте содержится непустый исходный код.
Примечание: Если в скрипте нет исходного кода, это не означает, что он является недействительным или непригодным для использования. Script.CanInstantiate.
boolInstanceHasbool · Устарело
public bool InstanceHas(ReckfellObject baseObject);Возвращает true, если base_object является экземпляром этого скрипта.
| Имя | Тип | По умолчанию |
|---|---|---|
baseObject | ReckfellObject | — |
boolIsAbstractbool
public bool IsAbstract();Возвращает true, если скрипт является абстрактным. Абстрактный скрипт не имеет конструктора и не может быть создан.
boolIsToolbool
public bool IsTool();Возвращает true, если скрипт является скриптом инструмента. Скрипт инструмента может быть запущен в редакторе.
boolReloadError
public Error Reload(bool keepState = false);Перезагружает реализацию класса скрипта. Возвращает код ошибки.
| Имя | Тип | По умолчанию |
|---|---|---|
keepState | bool | false |
ErrorSetSourceCodevoid
public void SetSourceCode(string source);| Имя | Тип | По умолчанию |
|---|---|---|
source | string | — |