reckfellENGINE

EditorScript

Base script that can be used to add extension functions to the editor.

On this page
class EditorScriptReckfellSharpEditorInherits RefCounted

Base script that can be used to add extension functions to the editor.

Scripts extending this class and implementing its EditorScript._Run method can be executed from the Script Editor's File > Run menu option (or by pressing EditorPlugins instead. If a script extending this class also has a global class name, it will be included in the editor's command palette. Note: Extending scripts need to have tool mode enabled. Example: Running the following script prints "Hello from the Reckfell Editor!":

C#
using Reckfell;

[Tool]
public partial class HelloEditor : EditorScript
{
    public override void _Run()
    {
        ReckfellApi.Print("Hello from the Reckfell Editor!");
    }
}

Note: EditorScript is RefCounted, meaning it is destroyed when nothing references it. This can cause errors during asynchronous operations if there are no references to the script.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

EditorScriptConstructor
# EditorScript
C#
public EditorScript();

Methods4

AddRootEntityvoid · Deprecated
# AddRootEntity
C#
public void AddRootEntity(Entity node);

Makes node root of the currently opened scene. Only works if the scene is empty. If the node is a scene instance, an inheriting scene will be created.

Parameters
NameTypeDefault
nodeEntity—
GetEditorInterfaceEditorInterface · Deprecated
# GetEditorInterface
C#
public EditorInterface GetEditorInterface();

Returns the EditorInterface singleton instance.

Returns EditorInterface
GetSceneEntity · Deprecated
# GetScene
C#
public Entity GetScene();

Returns the edited (current) scene's root Entity. Equivalent of EditorInterface.GetEditedSceneRoot.

Returns Entity
_Runvoid
# _Run
C#
public virtual void _Run();

This method is executed by the Editor when File > Run is used.

Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.