Skip to content
On this page

Athena.getters.world

Functions

isInOceanWater

Usage

Athena.getters.world.isInOceanWater(entity): boolean

Used to check if an entity is in ocean water. Uses a simple 'z' positional check and dimension check.

Parameters

NameType
entityEntity

Returns

boolean

Defined in

server/getters/world.ts:40


positionIsClear

Usage

Athena.getters.world.positionIsClear(pos, lookFor): Promise<boolean>

Check if a world position is free of vehicles.

Parameters

NameTypeDescription
posIVector3A position in the world.
lookFor"vehicle" | "player" | "all"-

Returns

Promise<boolean>

Defined in

server/getters/world.ts:10

Created by Stuyk | Est. 2020