interface.World.md

Latite Scripting Documentation (Exports)

---

Exports > world/world > World

World

Interface

Source: world/world.d.ts:1

Methods

exists()

exists(): boolean

Returns true if in a world, returns false if not. You will only be able to use the World methods if you are in a world.

Source: world/world.d.ts:5

Returns

boolean

getEntities()

getEntities(): Entity[]

Gets the clientside entity list (only if you have operator otherwise it will only return you)

Source: world/world.d.ts:24

Returns

Entity[]

getEntityCount()

getEntityCount(): number

Gets the clientside number of entities (including you)

Source: world/world.d.ts:29

Returns

number

getName()

getName(): string

The saved world name.

Source: world/world.d.ts:10

Returns

string

getPlayers()

getPlayers(): string[]

Gets the name of the players connected to the world.

Source: world/world.d.ts:14

Returns

string[]

isLocalWorld()

isLocalWorld(): boolean

Returns true if it's your own local world. Returns false if not.

Source: world/world.d.ts:19

Returns

boolean