ActorScript

Summary

Definition

Namespace: SDT4.Managed.Core.Script
Assembly: SDT4.Managed.Core.dll

class ActorScript
Inheritance:

ObjectActorActorScript

Implements:

IScriptTarget

Fields

Name Type Description

Properties

Name Type Description
public get; UniqueIdentifier Guid

Methods

protected virtual Void OnCreate(ScriptPayload payload)

Summary

Gets called when script is being created. Level may not have started playing yet, and any rigid bodies will not have been added yet! Creation may be vetoed. If creation is vetoed, it is strongly assumed that the actor is in a safe state to remove from memory (e.g. no dangling objects)! The creation payload. Actor States: Script: Valid Physics: INVALID Renderer: INVALID

Parameters:


protected virtual Void OnSpawn()

Summary

Gets called when actor is fully initialised, but before it started ticking. This means that the level might not have been fully loaded in yet! Actor States: Script: Valid Physics: Valid Renderer: Valid


protected virtual Void OnBegin()

Summary

Gets called when this Actor starts ticking. Actor States: Script: Valid Physics: Valid Renderer: Valid


protected virtual Void OnTick(Single dt)

Summary

Gets called per frame. Delta time in seconds

Parameters:


protected virtual Void OnStep(Single ts)

Summary

Gets called per fixed step. May be called multiple times per frame, or even be skipped! Fixed step time in seconds

Parameters:


protected virtual Void OnEnd()

Summary

Gets called when this Actor stops ticking. Actor States: Script: Valid Physics: Valid Renderer: Valid


protected virtual Void OnKill()

Summary

Gets called when this Actor is destroyed. Actor States: Script: Valid Physics: Valid Renderer: Valid


protected virtual Void OnDestroy()

Summary

Gets called when the script instance is destroyed. Actor States: Script: Valid Physics: INVALID Renderer: Unknown