PropScript

Summary

Definition

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

class PropScript

Inheritance:

Object ➔ PropScript

Implements:

IScriptTarget

---

Fields

Name	Type	Description

---

Properties

Name	Type	Description
public get; protected set; 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 prop is in a safe state to remove from memory (e.g. no dangling objects)! The creation payload. Prop States: Script: Valid Physics: INVALID Renderer: INVALID

Parameters:

• payload (ScriptPayload):

---

protected virtual Void OnSpawn()

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

---

protected virtual Void OnBegin()

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

---

protected virtual Void OnTick(Single dt)

Summary: Gets called per frame. Delta time in seconds

Parameters:

• dt (Single):

---

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:

• ts (Single):

---

protected virtual Void OnEnd()

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

---

protected virtual Void OnKill()

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

---

protected virtual Void OnDestroy()

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

---

---