Your first script

Create a script, attach it to an entity, and make the entity move.

Create a script

1. Select an entity in the Scene panel.

2. In the Inspector, find the Script section and click (Create new script).

3. Choose Strata or C#, and give it a name.

The editor adds a ScriptComponent to the entity, and saves the file to Scripts/<Name>.strata or Scripts/<Name>.cs in your project. The new script looks like this:

import Engine;

Entity g_entity;

void OnAdded(const Entity entity)
{
    g_entity = entity;
}

void Update(float delta)
{
}

void Destroy()
{
}

using Hyperion;

public class NewScript : Script
{
    public override void OnAdded(Entity entity)
    {
    }

    public override void Update(float deltaTime)
    {
    }

    public override void Destroy()
    {
    }
}

In C#, the class is named after the script.

Lifecycle

Both languages use the same three functions. In Strata they're plain functions in the file; in C# they're overrides on Script.

All three are optional.

Each entity gets its own copy of the script's state: its own Strata globals, or its own instance of the C# class. Entities sharing a script don't share state.

Moving the entity

This moves the entity upward while the game runs:

import Engine;

Entity g_entity;

void OnAdded(const Entity entity)
{
    g_entity = entity;
}

void Update(float delta)
{
    g_entity.Translate(float3(0.0, delta, 0.0));
}

using Hyperion;

public class NewScript : Script
{
    public override void OnAdded(Entity entity)
    {
        base.OnAdded(entity);
    }

    public override void Update(float deltaTime)
    {
        Entity.Translate(new Vec3f(0.0f, deltaTime, 0.0f));
    }
}

In C#, calling base.OnAdded(entity) sets the script's Entity property. The editor's template leaves it out, so add it when you want to use Entity.

Live reload

Saving the file recompiles it in the editor, in either language. Entities using the script get Destroy, the new code is loaded, and OnAdded runs again.

Script state is reset on reload.