V5 DocsAthena.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 ​
| Name | Type |
|---|---|
entity | Entity |
Returns ​
boolean
Defined in ​
positionIsClear ​
Usage
Athena.getters.world.positionIsClear(pos, lookFor): Promise<boolean>
Check if a world position is free of vehicles.
Parameters ​
| Name | Type | Description |
|---|---|---|
pos | IVector3 | A position in the world. |
lookFor | "vehicle" | "player" | "all" | - |
Returns ​
Promise<boolean>