World

A scene: the editor document (PluginHost.Document). Reading needs permission scene.read, editing scene.write. Edits of the document are undoable: each call is one undo step, or use PluginHost.Transaction to group several. Calls fail with a KroysException (for example while Play runs, KROYS_E_STATE).

public sealed class DropToGround : EditorPlugin
{
    public override void OnLoad() =>
        Host.AddCommand(new CommandOptions("Drop", "Drop to Y = 0") { Menu = "Level" }, () =>
        {
            World scene = Host.Document ?? throw new InvalidOperationException("Open a scene first.");
            using (Host.Transaction("Drop to Y = 0"))
            {
                foreach (Entity entity in Host.Selection)
                {
                    Transform transform = scene.GetTransform(entity);
                    transform.Position = transform.Position with { Y = 0.0f };
                    scene.SetTransform(entity, transform);
                    Host.Log($"{scene.GetName(entity)} dropped");
                }
            }
        });
}

public nint Handle { get; }
public int EntityCount { get; }
public IReadOnlyList<Entity> Entities { get; }
public bool IsAlive(Entity entity)
public Entity FindByName(string name)
public Entity FindByGuid(Guid guid)
public Entity CreateEntity(string name, Entity parent = default)
public void DestroyEntity(Entity entity)
public string GetName(Entity entity)
public void SetName(Entity entity, string name)
public Guid GetGuid(Entity entity)
public Entity GetParent(Entity entity)
public void SetParent(Entity entity, Entity parent)
public Transform GetTransform(Entity entity)
public void SetTransform(Entity entity, Transform transform)
public bool HasComponent(Entity entity, ComponentType type)
public void AddComponent(Entity entity, ComponentType type)
public void RemoveComponent(Entity entity, ComponentType type)
public object? GetField(Entity entity, ComponentType type, string path)
public void SetField(Entity entity, ComponentType type, string path, object value)
public IReadOnlyList<Entity> Query(ComponentType type)

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