Spawning

Invoking Props (PropScript)

Props are the most straight forward to invoke, as they are non-phaseable, meaning they do not require any physical presence, and thus have no IResource to be loaded. This is the fastest way to invoke a script.

using SDT4.Managed.Core;
using SDT4.Managed.Core.Script;
// ...
class MyScript : PropScript 
{
    // Implementation
}
// ...
Scene scene = /*...*/;
// OnCreate() is immediatelly called, together with OnSpawn() if the scene is running. 
// If the scene is not running, the script is queued until Start[Async] is called,
// where OnBegin() is called instead 
// Template argument is *required* to know which script to instantiate.
MyScript? script = scene.InvokeProp<MyScript>();

// Removing the prop from the scene is required, or the prop will not stop execution
// This will invoke OnKill() and OnDestroy().
// scene.KillProp(script);

// If the prop is never removed, OnEnd() will be invoked once the scene stops, 
// followed by OnDestroy().

Creating Prefabs (ActorScript)

Prefabs are a bit more involved, as ActorScripts are always tied to a prefab.

using SDT4.Managed.Core;
using SDT4.Managed.Core.Script;
// ...
class MyPrefabScript : ActorScript 
{
    // Implementation
}
// ...
Scene scene = /*...*/;
IPrefabAsset prefab = /*...*/; // loaded using the IResourceManager from the AppInstance!

// OnCreate() is immediatelly called, together with OnSpawn() if the scene is running. 
// If the scene is not running, the script is queued until Start[Async] is called,
// where OnBegin() is called instead.
// Template argument is *optional*, and will return an Actor by default.
MyPrefabScript? script = scene.CreatePrefabActor<MyPrefabScript>(prefab);

Payloads

Prop- and ActorScripts may have a payload bound to them, which can be used for various state management.

This payload is referenced in the OnCreate method, where it carries custom state information

using SDT4.Managed.Core;
using SDT4.Managed.Core.Script;
// ...
class MyPrefabScript : ActorScript 
{
    protected override void OnCreate(ScriptPayload payload) 
    {
        // payload.Veto allows cancelling the instantiation, 
        // and abort the OnCreate() chain for nested prefabs!

        // payload.State holds an optional object with state. 
        // This is useful for physics actors where setting an 
        // initial transform is vital. 
        var translation = (Vector3d)payload.State ?? Vector3d.Zero;
        this.GetComponent<Transform3DComponent>().Translation = translation;
    }
}
// ...
Scene scene = /*...*/;
scene.CreatePrefabActor<MyPrefabScript>(prefab, payload: new Vector3d(1000.0, 10.0, 5000.0));