PluginHost

The editor seen from a C# plugin: registrations (commands, panels, settings pages, services, importers, exporters, asset types, viewport tools, automation steps, component types), the document scene, selection, undoable transactions, editor tasks, notifications, logging, per-user settings and paths. Calls run on the editor's main thread unless documented otherwise (Log, Post). Registrations stay until the plugin is unloaded or reloaded, or until Unregister. Everything not wrapped here is reachable through Raw (the C tables of kroys/kroys_plugin.h).

public sealed class SceneStats : EditorPlugin
{
    public override void OnLoad()
    {
        Host.AddCommand(new CommandOptions("Count", "Count Entities") { Menu = "Stats" }, () =>
        {
            int count = Host.Document?.Entities.Count ?? 0;
            Host.Notify(Severity.Info, "Scene", $"{count} entities, {Host.Selection.Count} selected");
        });

        // Slow work on a worker thread, with progress in the Tasks panel; the completion runs on the main thread.
        Host.AddCommand(new CommandOptions("Scan", "Scan Content") { Menu = "Stats" }, () =>
            Host.RunTask("Scan content", progress =>
            {
                string[] files = Directory.GetFiles(Host.ContentFolder, "*", SearchOption.AllDirectories);
                progress.Report(1.0f, $"{files.Length} files");
            }, (succeeded, message) => Host.Log($"scan finished: {message}")));
    }

    public override void OnUnload() => Host.Log("Stats unloading (registrations are removed for you)");
}

public KroysHost* Raw { get; }
public nint Context { get; }
public string Id { get; }
public Version SdkVersion { get; }
public Viewport Viewport { get; }
public void Log(string message)
public void LogWarning(string message)
public void LogError(string message)
public void Log(Severity severity, string message)
public void Notify(Severity severity, string title, string message)
public string GetSetting(string key, string fallback = "")
public void SetSetting(string key, string value)
public string PluginFolder { get; }
public string ProjectFolder { get; }
public string ContentFolder { get; }
public string DataFolder { get; }
public void Unregister(Registration registration)
public Registration AddCommand(CommandOptions options, Action execute, Func<bool>? isEnabled = null, Func<bool>? isChecked = null)
public Registration AddPanel(PanelOptions options, Action<Ui> draw)
public Registration AddSettingsPage(SettingsPageOptions options, Action<Ui> draw)
public Registration AddService(string name, Action<float> tick)
public Registration AddAutomationStep(string name, Func<string, AutomationJob, bool> run)
public Registration AddImporter(ImporterOptions options, Action<FileJob> run)
public Registration AddExporter(ExporterOptions options, Action<FileJob> run)
public Registration AddAssetType(AssetTypeOptions options, AssetTypeHandlers handlers)
public Registration AddViewportTool(ViewportToolOptions options, ViewportToolHandlers handlers)
public ComponentType AddComponentType(ComponentTypeOptions options)
public ComponentType FindComponentType(string typeName)
public void Execute(string commandId)
public void SetPanelOpen(string panelId, bool open)
public void MarkAssetDirty(string path)
public bool IsPlaying { get; }
public World? Document { get; }
public IReadOnlyList<Entity> Selection { get; }
public void Select(params Entity[] entities)
public IDisposable Transaction(string label)
public ulong RunTask(string name, Action<TaskProgress> run, Action<bool, string>? complete = null, string? lane = null)
public void CancelTask(ulong taskId)
public void Post(Action action)
public byte[] ReadContentFile(string path)
public void ImportFile(string sourcePath, string destinationFolder)
public void CreateAssetFile(string folder, string fileName, byte[] bytes)

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.