@temporary-escape/mod-sdk / SpawnArgsView

Class: SpawnArgsView

Defined in: templates.ts:611

Read-only view over the spawn arguments a template's onSpawn receives. The backing buffer is owned by the host and only valid for the duration of the hook; copy anything you need to keep.

Methods

getAssetBlock()

getAssetBlock(key: string): AssetBlock | null;

Defined in: templates.ts:895

Parameters

Parameter	Type
key	string

Returns

AssetBlock | null

---

getAssetBlockCategory()

getAssetBlockCategory(key: string): AssetBlockCategory | null;

Defined in: templates.ts:935

Parameters

Parameter	Type
key	string

Returns

AssetBlockCategory | null

---

getAssetFaction()

getAssetFaction(key: string): AssetFaction | null;

Defined in: templates.ts:910

Parameters

Parameter	Type
key	string

Returns

AssetFaction | null

---

getAssetImage()

getAssetImage(key: string): AssetImage | null;

Defined in: templates.ts:890

Parameters

Parameter	Type
key	string

Returns

AssetImage | null

---

getAssetModel()

getAssetModel(key: string): AssetModel | null;

Defined in: templates.ts:900

Parameters

Parameter	Type
key	string

Returns

AssetModel | null

---

getAssetPlanet()

getAssetPlanet(key: string): AssetPlanet | null;

Defined in: templates.ts:925

Parameters

Parameter	Type
key	string

Returns

AssetPlanet | null

---

getAssetSectorType()

getAssetSectorType(key: string): AssetSectorType | null;

Defined in: templates.ts:920

Parameters

Parameter	Type
key	string

Returns

AssetSectorType | null

---

getAssetShader()

getAssetShader(key: string): AssetShader | null;

Defined in: templates.ts:945

Parameters

Parameter	Type
key	string

Returns

AssetShader | null

---

getAssetShipDesign()

getAssetShipDesign(key: string): AssetShipDesign | null;

Defined in: templates.ts:915

Parameters

Parameter	Type
key	string

Returns

AssetShipDesign | null

---

getAssetSkybox()

getAssetSkybox(key: string): AssetSkybox | null;

Defined in: templates.ts:955

Parameters

Parameter	Type
key	string

Returns

AssetSkybox | null

---

getAssetSound()

getAssetSound(key: string): AssetSound | null;

Defined in: templates.ts:940

Parameters

Parameter	Type
key	string

Returns

AssetSound | null

---

getAssetSystemType()

getAssetSystemType(key: string): AssetSystemType | null;

Defined in: templates.ts:950

Parameters

Parameter	Type
key	string

Returns

AssetSystemType | null

---

getAssetTexture()

getAssetTexture(key: string): AssetTexture | null;

Defined in: templates.ts:905

Parameters

Parameter	Type
key	string

Returns

AssetTexture | null

---

getAssetTurret()

getAssetTurret(key: string): AssetTurret | null;

Defined in: templates.ts:930

Parameters

Parameter	Type
key	string

Returns

AssetTurret | null

---

getBool()

getBool(key: string, fallback?: bool): bool;

Defined in: templates.ts:738

Parameters

Parameter	Type	Default value
key	string	undefined
fallback	bool	false

Returns

bool

---

getBytes()

getBytes(key: string): Uint8Array | null;

Defined in: templates.ts:754

Parameters

Parameter	Type
key	string

Returns

Uint8Array | null

---

getF64()

getF64(key: string, fallback?: number): number;

Defined in: templates.ts:724

Parameters

Parameter	Type	Default value
key	string	undefined
fallback	number	0

Returns

number

---

getI64()

getI64(key: string, fallback?: number): number;

Defined in: templates.ts:695

Parameters

Parameter	Type	Default value
key	string	undefined
fallback	number	0

Returns

number

---

getMatrix3()

getMatrix3(key: string, fallback: Matrix3f): Matrix3f;

Defined in: templates.ts:874

Parameters

Parameter	Type
key	string
fallback	Matrix3f

Returns

Matrix3f

---

getMatrix4()

getMatrix4(key: string, fallback: Matrix4f): Matrix4f;

Defined in: templates.ts:882

Parameters

Parameter	Type
key	string
fallback	Matrix4f

Returns

Matrix4f

---

getQuaternion()

getQuaternion(key: string, fallback: Quaternion): Quaternion;

Defined in: templates.ts:866

Parameters

Parameter	Type
key	string
fallback	Quaternion

Returns

Quaternion

---

getString()

getString(key: string, fallback?: string): string;

Defined in: templates.ts:746

Parameters

Parameter	Type	Default value
key	string	undefined
fallback	string	""

Returns

string

---

getU64()

getU64(key: string, fallback?: number): number;

Defined in: templates.ts:710

Parameters

Parameter	Type	Default value
key	string	undefined
fallback	number	0

Returns

number

---

getVector2b()

getVector2b(key: string, fallback: Vector2b): Vector2b;

Defined in: templates.ts:838

Parameters

Parameter	Type
key	string
fallback	Vector2b

Returns

Vector2b

---

getVector2d()

getVector2d(key: string, fallback: Vector2d): Vector2d;

Defined in: templates.ts:812

Parameters

Parameter	Type
key	string
fallback	Vector2d

Returns

Vector2d

---

getVector2f()

getVector2f(key: string, fallback: Vector2f): Vector2f;

Defined in: templates.ts:762

Parameters

Parameter	Type
key	string
fallback	Vector2f

Returns

Vector2f

---

getVector2i()

getVector2i(key: string, fallback: Vector2i): Vector2i;

Defined in: templates.ts:788

Parameters

Parameter	Type
key	string
fallback	Vector2i

Returns

Vector2i

---

getVector3b()

getVector3b(key: string, fallback: Vector3b): Vector3b;

Defined in: templates.ts:846

Parameters

Parameter	Type
key	string
fallback	Vector3b

Returns

Vector3b

---

getVector3d()

getVector3d(key: string, fallback: Vector3d): Vector3d;

Defined in: templates.ts:820

Parameters

Parameter	Type
key	string
fallback	Vector3d

Returns

Vector3d

---

getVector3f()

getVector3f(key: string, fallback: Vector3f): Vector3f;

Defined in: templates.ts:770

Parameters

Parameter	Type
key	string
fallback	Vector3f

Returns

Vector3f

---

getVector3i()

getVector3i(key: string, fallback: Vector3i): Vector3i;

Defined in: templates.ts:796

Parameters

Parameter	Type
key	string
fallback	Vector3i

Returns

Vector3i

---

getVector4b()

getVector4b(key: string, fallback: Vector4b): Vector4b;

Defined in: templates.ts:856

Parameters

Parameter	Type
key	string
fallback	Vector4b

Returns

Vector4b

---

getVector4d()

getVector4d(key: string, fallback: Vector4d): Vector4d;

Defined in: templates.ts:828

Parameters

Parameter	Type
key	string
fallback	Vector4d

Returns

Vector4d

---

getVector4f()

getVector4f(key: string, fallback: Vector4f): Vector4f;

Defined in: templates.ts:778

Parameters

Parameter	Type
key	string
fallback	Vector4f

Returns

Vector4f

---

getVector4i()

getVector4i(key: string, fallback: Vector4i): Vector4i;

Defined in: templates.ts:804

Parameters

Parameter	Type
key	string
fallback	Vector4i

Returns

Vector4i

---

has()

has(key: string): bool;

Defined in: templates.ts:691

Parameters

Parameter	Type
key	string

Returns

bool

---

fromRaw()

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

Defined in: templates.ts:616

Parameters

Parameter	Type
ptr	number
len	number

Returns

SpawnArgsView