@temporary-escape/mod-sdk / Entity

Class: Entity

Defined in: entity.ts:377

Constructors

Constructor

new Entity(id: number): Entity;

Defined in: entity.ts:380

Parameters

Parameter	Type
id	number

Returns

Entity

Properties

Property	Type	Defined in
id	number	entity.ts:378

Methods

addCollisionShape()

addCollisionShape(): void;

Defined in: entity.ts:743

Returns

void

---

addEquipment()

addEquipment(): void;

Defined in: entity.ts:591

Returns

void

---

addGate()

addGate(): void;

Defined in: entity.ts:606

Returns

void

---

addGrid()

addGrid(): void;

Defined in: entity.ts:568

Returns

void

---

addHealth()

addHealth(
   hullValue: number, 
   hullMax: number, 
   shieldValue: number, 
   shieldMax: number
): void;

Defined in: entity.ts:754

Parameters

Parameter	Type
hullValue	number
hullMax	number
shieldValue	number
shieldMax	number

Returns

void

---

addIcon()

addIcon(): void;

Defined in: entity.ts:712

Returns

void

---

addLabel()

addLabel(text: string): void;

Defined in: entity.ts:691

Parameters

Parameter	Type
text	string

Returns

void

---

addModel()

addModel(asset: AssetModel, scale: number): void;

Defined in: entity.ts:524

Parameters

Parameter	Type
asset	AssetModel
scale	number

Returns

void

---

addPathfinding()

addPathfinding(): void;

Defined in: entity.ts:661

Returns

void

---

addPlayerControl()

addPlayerControl(
   fleetId: number, 
   shipId: number, 
   playerId: number
): void;

Defined in: entity.ts:676

Parameters

Parameter	Type
fleetId	number
shipId	number
playerId	number

Returns

void

---

addReplicated()

addReplicated(): void;

Defined in: entity.ts:423

Returns

void

---

addRigidBody()

addRigidBody(
   flags: CollisionFlags, 
   group: CollisionMask, 
   mask: CollisionMask
): void;

Defined in: entity.ts:747

Parameters

Parameter	Type
flags	CollisionFlags
group	CollisionMask
mask	CollisionMask

Returns

void

---

addShip()

addShip(): void;

Defined in: entity.ts:633

Returns

void

---

addTransform()

addTransform(value: Matrix4f): void;

Defined in: entity.ts:438

Parameters

Parameter	Type
value	Matrix4f

Returns

void

---

clearCapability()

clearCapability(value: number): void;

Defined in: entity.ts:408

Clears a custom capability on the entity

Parameters

Parameter	Type	Description
value	number	The capability to clear

Returns

void

---

getAbsoluteTransform()

getAbsoluteTransform(): Matrix4f;

Defined in: entity.ts:483

Returns

Matrix4f

---

getGateTargetSector()

getGateTargetSector(): number;

Defined in: entity.ts:626

Returns

number

---

getGateTargetSystem()

getGateTargetSystem(): number;

Defined in: entity.ts:622

Returns

number

---

getGridScale()

getGridScale(): number;

Defined in: entity.ts:584

Returns

number

---

getHealthHull()

getHealthHull(): number;

Defined in: entity.ts:770

Returns

number

---

getHealthHullMax()

getHealthHullMax(): number;

Defined in: entity.ts:778

Returns

number

---

getHealthShield()

getHealthShield(): number;

Defined in: entity.ts:786

Returns

number

---

getHealthShieldMax()

getHealthShieldMax(): number;

Defined in: entity.ts:794

Returns

number

---

getModelAsset()

getModelAsset(): AssetModel;

Defined in: entity.ts:544

Returns

AssetModel

---

getModelScale()

getModelScale(): number;

Defined in: entity.ts:548

Returns

number

---

getOrientation()

getOrientation(): Quaternion;

Defined in: entity.ts:495

Returns

Quaternion

---

getParent()

getParent(): Entity | null;

Defined in: entity.ts:451

Returns

Entity | null

---

getPosition()

getPosition(): Vector3f;

Defined in: entity.ts:489

Returns

Vector3f

---

getShipId()

getShipId(): number;

Defined in: entity.ts:649

Returns

number

---

getTransform()

getTransform(): Matrix4f;

Defined in: entity.ts:477

Returns

Matrix4f

---

hasCapability()

hasCapability(value: number): bool;

Defined in: entity.ts:416

Returns true if the capability is set on the entity

Parameters

Parameter	Type	Description
value	number	The capability to check

Returns

bool

---

hasEquipment()

hasEquipment(): bool;

Defined in: entity.ts:595

Returns

bool

---

hasGate()

hasGate(): bool;

Defined in: entity.ts:610

Returns

bool

---

hasGrid()

hasGrid(): bool;

Defined in: entity.ts:572

Returns

bool

---

hasHealth()

hasHealth(): bool;

Defined in: entity.ts:758

Returns

bool

---

hasIcon()

hasIcon(): bool;

Defined in: entity.ts:716

Returns

bool

---

hasLabel()

hasLabel(): bool;

Defined in: entity.ts:696

Returns

bool

---

hasModel()

hasModel(): bool;

Defined in: entity.ts:528

Returns

bool

---

hasPathfinding()

hasPathfinding(): bool;

Defined in: entity.ts:665

Returns

bool

---

hasPlayerControl()

hasPlayerControl(): bool;

Defined in: entity.ts:680

Returns

bool

---

hasReplicated()

hasReplicated(): bool;

Defined in: entity.ts:427

Returns

bool

---

hasShip()

hasShip(): bool;

Defined in: entity.ts:637

Returns

bool

---

hasTransform()

hasTransform(): bool;

Defined in: entity.ts:443

Returns

bool

---

isNull()

isNull(): bool;

Defined in: entity.ts:385

True when the id is NullEntity (e.g. a spawn whose template was missing).

Returns

bool

---

loadShipDesignAsset()

loadShipDesignAsset(asset: AssetShipDesign): void;

Defined in: entity.ts:553

Loads a voxel ship design into this entity's grid and equipment.

Parameters

Parameter	Type
asset	AssetShipDesign

Returns

void

---

removeEquipment()

removeEquipment(): void;

Defined in: entity.ts:599

Returns

void

---

removeGate()

removeGate(): void;

Defined in: entity.ts:614

Returns

void

---

removeGrid()

removeGrid(): void;

Defined in: entity.ts:576

Returns

void

---

removeHealth()

removeHealth(): void;

Defined in: entity.ts:762

Returns

void

---

removeIcon()

removeIcon(): void;

Defined in: entity.ts:720

Returns

void

---

removeLabel()

removeLabel(): void;

Defined in: entity.ts:700

Returns

void

---

removeModel()

removeModel(): void;

Defined in: entity.ts:532

Returns

void

---

removePathfinding()

removePathfinding(): void;

Defined in: entity.ts:669

Returns

void

---

removePlayerControl()

removePlayerControl(): void;

Defined in: entity.ts:684

Returns

void

---

removeReplicated()

removeReplicated(): void;

Defined in: entity.ts:431

Returns

void

---

removeShip()

removeShip(): void;

Defined in: entity.ts:641

Returns

void

---

removeTransform()

removeTransform(): void;

Defined in: entity.ts:447

Returns

void

---

rotate()

rotate(value: Quaternion): void;

Defined in: entity.ts:505

Parameters

Parameter	Type
value	Quaternion

Returns

void

---

rotateX()

rotateX(radians: number): void;

Defined in: entity.ts:509

Parameters

Parameter	Type
radians	number

Returns

void

---

rotateY()

rotateY(radians: number): void;

Defined in: entity.ts:513

Parameters

Parameter	Type
radians	number

Returns

void

---

rotateZ()

rotateZ(radians: number): void;

Defined in: entity.ts:517

Parameters

Parameter	Type
radians	number

Returns

void

---

saveShipDesignBlob()

saveShipDesignBlob(blobId?: number): number;

Defined in: entity.ts:561

Serializes this entity's ship design into a database blob. Pass 0 to create a new blob, or an existing id to replace it.

Parameters

Parameter	Type	Default value
blobId	number	0

Returns

number

---

setCapability()

setCapability(value: number): void;

Defined in: entity.ts:400

Sets a custom capability on the entity

Parameters

Parameter	Type	Description
value	number	The capability to set

Returns

void

---

setCommandWarp()

setCommandWarp(warpUntilTicks: number, sourceSectorId: number): void;

Defined in: entity.ts:654

Commands the ship to warp until warpUntilTicks, coming from sourceSectorId.

Parameters

Parameter	Type
warpUntilTicks	number
sourceSectorId	number

Returns

void

---

setGateTarget()

setGateTarget(targetSystemId: number, targetSectorId: number): void;

Defined in: entity.ts:618

Parameters

Parameter	Type
targetSystemId	number
targetSectorId	number

Returns

void

---

setGridScale()

setGridScale(scale: number): void;

Defined in: entity.ts:580

Parameters

Parameter	Type
scale	number

Returns

void

---

setHealthHull()

setHealthHull(value: number): void;

Defined in: entity.ts:766

Parameters

Parameter	Type
value	number

Returns

void

---

setHealthHullMax()

setHealthHullMax(value: number): void;

Defined in: entity.ts:774

Parameters

Parameter	Type
value	number

Returns

void

---

setHealthShield()

setHealthShield(value: number): void;

Defined in: entity.ts:782

Parameters

Parameter	Type
value	number

Returns

void

---

setHealthShieldMax()

setHealthShieldMax(value: number): void;

Defined in: entity.ts:790

Parameters

Parameter	Type
value	number

Returns

void

---

setIconCategory()

setIconCategory(value: IconCategory): void;

Defined in: entity.ts:728

Parameters

Parameter	Type
value	IconCategory

Returns

void

---

setIconFaction()

setIconFaction(value: AssetFaction | null): void;

Defined in: entity.ts:732

Parameters

Parameter	Type
value	AssetFaction | null

Returns

void

---

setIconPlayerId()

setIconPlayerId(value: number): void;

Defined in: entity.ts:736

Parameters

Parameter	Type
value	number

Returns

void

---

setIconType()

setIconType(value: IconType): void;

Defined in: entity.ts:724

Parameters

Parameter	Type
value	IconType

Returns

void

---

setLabelText()

setLabelText(text: string): void;

Defined in: entity.ts:704

Parameters

Parameter	Type
text	string

Returns

void

---

setModelAsset()

setModelAsset(asset: AssetModel): void;

Defined in: entity.ts:536

Parameters

Parameter	Type
asset	AssetModel

Returns

void

---

setModelScale()

setModelScale(scale: number): void;

Defined in: entity.ts:540

Parameters

Parameter	Type
scale	number

Returns

void

---

setOrientation()

setOrientation(value: Quaternion): void;

Defined in: entity.ts:473

Parameters

Parameter	Type
value	Quaternion

Returns

void

---

setParent()

setParent(parent: Entity | null): void;

Defined in: entity.ts:456

Parameters

Parameter	Type
parent	Entity | null

Returns

void

---

setPosition()

setPosition(value: Vector3f): void;

Defined in: entity.ts:469

Parameters

Parameter	Type
value	Vector3f

Returns

void

---

setShipId()

setShipId(shipId: number): void;

Defined in: entity.ts:645

Parameters

Parameter	Type
shipId	number

Returns

void

---

setTransform()

setTransform(value: Matrix4f): void;

Defined in: entity.ts:464

Parameters

Parameter	Type
value	Matrix4f

Returns

void

---

toString()

toString(): string;

Defined in: entity.ts:389

Returns

string

---

translate()

translate(value: Vector3f): void;

Defined in: entity.ts:501

Parameters

Parameter	Type
value	Vector3f

Returns

void