@temporary-escape/mod-sdk / SpawnContext

Class: SpawnContext

Defined in: generators.ts:25

Context passed to a generator. A generator is a reusable, generation-only function referenced from a sector type's spawns list. It receives a seeded RNG and may spawn any number of ordinary entities.

Properties

Property	Modifier	Type	Defined in
args	readonly	SpawnArgsView	generators.ts:29
sectorId	readonly	number	generators.ts:27
seed	readonly	number	generators.ts:26
systemId	readonly	number	generators.ts:28

Accessors

rng

Get Signature

get rng(): Random;

Defined in: generators.ts:45

Lazily constructs the seeded generator RNG.

Returns

Random

Methods

contactTestSphere()

contactTestSphere(
   origin: Vector3f, 
   radius: number, 
   group: CollisionMask, 
   mask: CollisionMask
): bool;

Defined in: generators.ts:63

True when a sphere overlaps anything matching group/mask.

Parameters

Parameter	Type
origin	Vector3f
radius	number
group	CollisionMask
mask	CollisionMask

Returns

bool

---

spawn()

spawn(name: string, args?: SpawnArgs | null): Entity;

Defined in: generators.ts:55

Spawns a template and runs its onSpawn hook before returning.

Parameters

Parameter	Type	Default value
name	string	undefined
args	SpawnArgs | null	null

Returns

Entity

---

fromRaw()

static fromRaw(ptr: number, len: number): SpawnContext;

Defined in: generators.ts:39

Parameters

Parameter	Type
ptr	number
len	number

Returns

SpawnContext