Script

public string SourceCode { get; set; }

The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically.

public bool CanInstantiate();

Returns true if the script can be instantiated.

public Script GetBaseScript();

Returns the script directly inherited by this script.

public StringName GetGlobalName();

Returns the class name associated with the script, if there is one. Returns an empty string otherwise. To give the script a global name, you can use the class_name keyword in C# and the GlobalClass attribute in C#.

using Reckfell;

[GlobalClass]
public partial class MyNode : Entity
{
}

public StringName GetInstanceBaseType();

Returns the script's base type.

public Variant GetPropertyDefaultValue(StringName property);

Returns the default value of the specified property. Note: In C# and C#, this method returns null outside of editor builds.

public Variant GetRpcConfig();

Returns a Reckfell.Collections.Dictionary mapping method names to their RPC configuration defined by this script.

public Reckfell.Collections.Dictionary GetScriptConstantMap();

Returns a dictionary containing constant names and their values.

public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetScriptMethodList();

Returns the list of methods in this Script. Note: The dictionaries returned by this method are formatted identically to those returned by ReckfellObject.GetMethodList.

public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetScriptPropertyList();

Returns the list of properties in this Script. Note: The dictionaries returned by this method are formatted identically to those returned by ReckfellObject.GetPropertyList.

public Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetScriptSignalList();

Returns the list of signals defined in this Script. Note: The dictionaries returned by this method are formatted identically to those returned by ReckfellObject.GetSignalList.

public bool HasScriptMethod(StringName methodName);

Returns true if the script, or a base class, defines a method with the given name.

public bool HasScriptSignal(StringName signalName);

Returns true if the script, or a base class, defines a signal with the given name.

public bool HasSourceCode();

Returns true if the script contains non-empty source code. Note: If a script does not have source code, this does not mean that it is invalid or unusable. For example, a Script.CanInstantiate.

public bool InstanceHas(ReckfellObject baseObject);

Returns true if base_object is an instance of this script.

public bool IsAbstract();

Returns true if the script is an abstract script. An abstract script does not have a constructor and cannot be instantiated.

public bool IsTool();

Returns true if the script is a tool script. A tool script can run in the editor.

public Error Reload(bool keepState = false);

Reloads the script's class implementation. Returns an error code.