Athena.getters.player ​

Functions ​

byAccount ​

Gets an online player by account identifier based on their MongoDB account _id.

Example ​

const player = Athena.getters.player.byAccount('123456789');
if (player) {
    console.log(`Found player ${player.id} with account ID ${player.account._id}`);
} else {
   console.log('No player found with that account ID');
}

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:26

byDatabaseID ​

Get an online player based on their MongoDB _id

Example ​

const id = 'abc123jkfewfwe';
const player = Athena.getters.player.byDatabaseID(id);

if (player) {
    console.log(`Found player with id ${id}`);
} else {
    console.log(`No player found with the id '${id}'`);
}

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:133

byID ​

Return a player based on their ID given the Identifier strategy currently setup. Use this to get the player in-game that you see with your eyes.

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:155

byName ​

Gets an online player by their name.

Not case sensitive and returns the first player it finds matching that name.

Example ​

const player = Athena.getters.player.byName('john_fettermanjoe');
if (player) {
    console.log(`Found player ${player.id} with name ${player.name}`);
} else {
    console.log('No player found with that name');
}

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:63

byPartialName ​

Gets an online player by their partial name.

Not case sensitive and returns the first player it finds that includes the partial

Example ​

const partialName = 'john';
const player = Athena.getters.player.byPartialName(partialName);

if (player) {
    console.log(`Found player ${player.id} with name ${player.name}`);
} else {
    console.log(`No player found with the partial name '${partialName}'`);
}

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:99

characters ​

Returns all characters that belong to a player. Requires account info, player, or account id string.

Parameters ​

Returns ​

Promise<player[]>

Defined in ​

server/getters/player.ts:318

closestOwnedVehicle ​

Returns the closest owned vehicle for a given player. Counts any owned vehicles from other players that have supplied an injection for ownership. Ignores vehicles with keyless for start.

Parameters ​

Returns ​

alt.Vehicle | undefined

Defined in ​

server/getters/player.ts:262

closestToPlayer ​

The player closest to a player.

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:240

closestToVehicle ​

The player closest to a vehicle.

Parameters ​

Returns ​

alt.Player | undefined

Defined in ​

server/getters/player.ts:250

inFrontOf ​

Creates a temporary ColShape in front of the player. The ColShape is then used to check if the entity is present within the ColShape. It will keep subtract distance until it finds a player near the player that is in the ColShape. Works best on flat land or very close distances.

Parameters ​

Returns ​

Promise<alt.Player | undefined>

Defined in ​

server/getters/player.ts:169

isDead ​

Determine if a player is currently dead / marked as dead.

Parameters ​

Returns ​

boolean

Defined in ​

server/getters/player.ts:350

isNearPosition ​

Checks if a player is within 3 distance of a position.

Parameters ​

Returns ​

boolean

Defined in ​

server/getters/player.ts:220

isValid ​

Determine if a player is valid, and spawned as a character.

Parameters ​

Returns ​

boolean

Defined in ​

server/getters/player.ts:366

ownedVehicleDocuments ​

Get all owned vehicles from the database for a given character.

Parameters ​

Returns ​

Promise<player[]>

Defined in ​

server/getters/player.ts:302

waypoint ​

Get the current waypoint marked on a player's map. Will return undefined it is not currently set.

Parameters ​

Returns ​

alt.IVector3 | undefined

Defined in ​

server/getters/player.ts:230