Class TransientIsland

An island that won't exist for long

Hierarchy

TransientIsland

Index

Properties

Methods

createHuman delete create createIslandId

Properties

`Readonly` island

island: default

Methods

createHuman

createHuman(spawnPoint?: IVector3, facingDirection?: East | North | West | South, copyFromHumanOptions?: ICopyHumanOptions): default<unknown, number, NPC | Player>
Creates a human you can do stuff with

Returns
Human
Parameters
- Optional spawnPoint: IVector3
  
  Spawn point. Set to undefined to use the default island spawn point
- Optional facingDirection: East | North | West | South
  
  Direction they should face when spawing
- Optional copyFromHumanOptions: ICopyHumanOptions
  
  Human object to copy customizations, items, and vehicles from
Returns default<unknown, number, NPC | Player>
- Defined in src/game/game/island/TransientIsland.ts:74

delete

delete(): void
Returns void
- Defined in src/game/game/island/TransientIsland.ts:56

`Static` create

create(islandId?: `${number},${number}`, islandOptions?: Partial<IIslandLoadOptions>): Promise<TransientIsland>
Parameters
- islandId: `${number},${number}` = ...
- Optional islandOptions: Partial<IIslandLoadOptions>
Returns Promise<TransientIsland>
- Defined in src/game/game/island/TransientIsland.ts:36

`Static` createIslandId

createIslandId(): `${number},${number}`
Returns `${number},${number}`
- Defined in src/game/game/island/TransientIsland.ts:26

Generated using TypeDoc