@temporary-escape/mod-sdk / SpawnArgsBuilder

Class: SpawnArgsBuilder

Defined in: templates.ts:260

Builder for the CBOR map passed to Scene.spawn.

Constructors

Constructor

new SpawnArgsBuilder(): SpawnArgsBuilder;

Returns

SpawnArgsBuilder

Methods

build()

build(): SpawnArgs;

Defined in: templates.ts:435

Returns

SpawnArgs

---

setAssetBlock()

setAssetBlock(key: string, value: AssetBlock | null): SpawnArgsBuilder;

Defined in: templates.ts:383

Parameters

Parameter	Type
key	string
value	AssetBlock | null

Returns

SpawnArgsBuilder

---

setAssetBlockCategory()

setAssetBlockCategory(key: string, value: AssetBlockCategory | null): SpawnArgsBuilder;

Defined in: templates.ts:415

Parameters

Parameter	Type
key	string
value	AssetBlockCategory | null

Returns

SpawnArgsBuilder

---

setAssetFaction()

setAssetFaction(key: string, value: AssetFaction | null): SpawnArgsBuilder;

Defined in: templates.ts:395

Parameters

Parameter	Type
key	string
value	AssetFaction | null

Returns

SpawnArgsBuilder

---

setAssetImage()

setAssetImage(key: string, value: AssetImage | null): SpawnArgsBuilder;

Defined in: templates.ts:379

Parameters

Parameter	Type
key	string
value	AssetImage | null

Returns

SpawnArgsBuilder

---

setAssetModel()

setAssetModel(key: string, value: AssetModel | null): SpawnArgsBuilder;

Defined in: templates.ts:387

Parameters

Parameter	Type
key	string
value	AssetModel | null

Returns

SpawnArgsBuilder

---

setAssetPlanet()

setAssetPlanet(key: string, value: AssetPlanet | null): SpawnArgsBuilder;

Defined in: templates.ts:407

Parameters

Parameter	Type
key	string
value	AssetPlanet | null

Returns

SpawnArgsBuilder

---

setAssetSectorType()

setAssetSectorType(key: string, value: AssetSectorType | null): SpawnArgsBuilder;

Defined in: templates.ts:403

Parameters

Parameter	Type
key	string
value	AssetSectorType | null

Returns

SpawnArgsBuilder

---

setAssetShader()

setAssetShader(key: string, value: AssetShader | null): SpawnArgsBuilder;

Defined in: templates.ts:423

Parameters

Parameter	Type
key	string
value	AssetShader | null

Returns

SpawnArgsBuilder

---

setAssetShipDesign()

setAssetShipDesign(key: string, value: AssetShipDesign | null): SpawnArgsBuilder;

Defined in: templates.ts:399

Parameters

Parameter	Type
key	string
value	AssetShipDesign | null

Returns

SpawnArgsBuilder

---

setAssetSkybox()

setAssetSkybox(key: string, value: AssetSkybox | null): SpawnArgsBuilder;

Defined in: templates.ts:431

Parameters

Parameter	Type
key	string
value	AssetSkybox | null

Returns

SpawnArgsBuilder

---

setAssetSound()

setAssetSound(key: string, value: AssetSound | null): SpawnArgsBuilder;

Defined in: templates.ts:419

Parameters

Parameter	Type
key	string
value	AssetSound | null

Returns

SpawnArgsBuilder

---

setAssetSystemType()

setAssetSystemType(key: string, value: AssetSystemType | null): SpawnArgsBuilder;

Defined in: templates.ts:427

Parameters

Parameter	Type
key	string
value	AssetSystemType | null

Returns

SpawnArgsBuilder

---

setAssetTexture()

setAssetTexture(key: string, value: AssetTexture | null): SpawnArgsBuilder;

Defined in: templates.ts:391

Parameters

Parameter	Type
key	string
value	AssetTexture | null

Returns

SpawnArgsBuilder

---

setAssetTurret()

setAssetTurret(key: string, value: AssetTurret | null): SpawnArgsBuilder;

Defined in: templates.ts:411

Parameters

Parameter	Type
key	string
value	AssetTurret | null

Returns

SpawnArgsBuilder

---

setBool()

setBool(key: string, value: bool): SpawnArgsBuilder;

Defined in: templates.ts:277

Parameters

Parameter	Type
key	string
value	bool

Returns

SpawnArgsBuilder

---

setBytes()

setBytes(key: string, value: Uint8Array): SpawnArgsBuilder;

Defined in: templates.ts:291

Parameters

Parameter	Type
key	string
value	Uint8Array

Returns

SpawnArgsBuilder

---

setF64()

setF64(key: string, value: number): SpawnArgsBuilder;

Defined in: templates.ts:270

Parameters

Parameter	Type
key	string
value	number

Returns

SpawnArgsBuilder

---

setI64()

setI64(key: string, value: number): SpawnArgsBuilder;

Defined in: templates.ts:263

Parameters

Parameter	Type
key	string
value	number

Returns

SpawnArgsBuilder

---

setMatrix3()

setMatrix3(key: string, value: Matrix3f): SpawnArgsBuilder;

Defined in: templates.ts:314

Writes C++ Matrix3 (tag 90 + three tag-85 columns).

Parameters

Parameter	Type
key	string
value	Matrix3f

Returns

SpawnArgsBuilder

---

setMatrix4()

setMatrix4(key: string, value: Matrix4f): SpawnArgsBuilder;

Defined in: templates.ts:306

Writes C++ Matrix4 (tag 91 + four tag-85 columns).

Parameters

Parameter	Type
key	string
value	Matrix4f

Returns

SpawnArgsBuilder

---

setQuaternion()

setQuaternion(key: string, value: Quaternion): SpawnArgsBuilder;

Defined in: templates.ts:370

Writes C++ Quaternion (tag 89 + raw x, y, z, w floats).

Parameters

Parameter	Type
key	string
value	Quaternion

Returns

SpawnArgsBuilder

---

setString()

setString(key: string, value: string): SpawnArgsBuilder;

Defined in: templates.ts:284

Parameters

Parameter	Type
key	string
value	string

Returns

SpawnArgsBuilder

---

setU64()

setU64(key: string, value: number): SpawnArgsBuilder;

Defined in: templates.ts:298

Parameters

Parameter	Type
key	string
value	number

Returns

SpawnArgsBuilder

---

setVector2b()

setVector2b(key: string, value: Vector2b): SpawnArgsBuilder;

Defined in: templates.ts:357

Parameters

Parameter	Type
key	string
value	Vector2b

Returns

SpawnArgsBuilder

---

setVector2d()

setVector2d(key: string, value: Vector2d): SpawnArgsBuilder;

Defined in: templates.ts:345

Parameters

Parameter	Type
key	string
value	Vector2d

Returns

SpawnArgsBuilder

---

setVector2f()

setVector2f(key: string, value: Vector2f): SpawnArgsBuilder;

Defined in: templates.ts:321

Parameters

Parameter	Type
key	string
value	Vector2f

Returns

SpawnArgsBuilder

---

setVector2i()

setVector2i(key: string, value: Vector2i): SpawnArgsBuilder;

Defined in: templates.ts:333

Parameters

Parameter	Type
key	string
value	Vector2i

Returns

SpawnArgsBuilder

---

setVector3b()

setVector3b(key: string, value: Vector3b): SpawnArgsBuilder;

Defined in: templates.ts:361

Parameters

Parameter	Type
key	string
value	Vector3b

Returns

SpawnArgsBuilder

---

setVector3d()

setVector3d(key: string, value: Vector3d): SpawnArgsBuilder;

Defined in: templates.ts:349

Parameters

Parameter	Type
key	string
value	Vector3d

Returns

SpawnArgsBuilder

---

setVector3f()

setVector3f(key: string, value: Vector3f): SpawnArgsBuilder;

Defined in: templates.ts:325

Parameters

Parameter	Type
key	string
value	Vector3f

Returns

SpawnArgsBuilder

---

setVector3i()

setVector3i(key: string, value: Vector3i): SpawnArgsBuilder;

Defined in: templates.ts:337

Parameters

Parameter	Type
key	string
value	Vector3i

Returns

SpawnArgsBuilder

---

setVector4b()

setVector4b(key: string, value: Vector4b): SpawnArgsBuilder;

Defined in: templates.ts:365

Parameters

Parameter	Type
key	string
value	Vector4b

Returns

SpawnArgsBuilder

---

setVector4d()

setVector4d(key: string, value: Vector4d): SpawnArgsBuilder;

Defined in: templates.ts:353

Parameters

Parameter	Type
key	string
value	Vector4d

Returns

SpawnArgsBuilder

---

setVector4f()

setVector4f(key: string, value: Vector4f): SpawnArgsBuilder;

Defined in: templates.ts:329

Parameters

Parameter	Type
key	string
value	Vector4f

Returns

SpawnArgsBuilder

---

setVector4i()

setVector4i(key: string, value: Vector4i): SpawnArgsBuilder;

Defined in: templates.ts:341

Parameters

Parameter	Type
key	string
value	Vector4i

Returns

SpawnArgsBuilder