Skip to content

@temporary-escape/mod-sdk / Scene

Class: Scene ​

Defined in: scene.ts:23

Constructors ​

Constructor ​

ts
new Scene(): Scene;

Returns ​

Scene

Methods ​

contactTestSphere() ​

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

Defined in: scene.ts:47

True when a sphere overlaps anything matching group/mask.

Parameters ​

ParameterType
originVector3f
radiusnumber
groupCollisionMask
maskCollisionMask

Returns ​

bool


createEntity() ​

ts
createEntity(): Entity;

Defined in: scene.ts:24

Returns ​

Entity


destroyEntity() ​

ts
destroyEntity(entity: Entity): void;

Defined in: scene.ts:39

Parameters ​

ParameterType
entityEntity

Returns ​

void


spawn() ​

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

Defined in: scene.ts:32

Spawns an entity from a registered template. The template's onSpawn hook runs before this returns.

Parameters ​

ParameterTypeDefault value
namestringundefined
argsSpawnArgs | nullnull

Returns ​

Entity