Athena.document.character ​

Type Aliases ​

KeyChangeCallback ​

Ƭ KeyChangeCallback: (player: alt.Player, newValue: any, oldValue: any) => void

Type declaration ​

Parameters ​

Returns ​

void

Defined in ​

server/document/character.ts:8

Functions ​

bind ​

Binds a player identifier to a Character document.

This document is cleared on disconnected automatically.

This should be the first thing you do after having a user authenticate and select a character.

Example ​

import Database from '@stuyk/ezmongodb';

async function doSomething(somePlayer: alt.Player, someMongoDBId: string) {
    const someData = await Database.fetchData('_id', someMongoDBId, 'characters')
    Athena.document.character.bind(somePlayer, someData);
}

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:43

get ​

Return current player data and their associated character object.

Can also append custom objects to the generic type to obtain custom data from the database.

Example ​

interface Testing {
    myProperty: string;
}

function someFunction(player: alt.Player) {
     const data = Athena.document.character.get<Testing>(player);
     if (typeof data === 'undefined') {
         // Player likely not logged in...
         return;
     }

     if (data.myProperty) {
         console.log(data.myProperty);
     }
}

Type parameters ​

Parameters ​

Returns ​

T | undefined

Defined in ​

server/document/character.ts:104

getAllOnline ​

Return all available and online characters, and their associated alt:V player ids.

The player can be fetched with alt.Player.all.find(x => x.id === someResult.id);

Export

Type parameters ​

Returns ​

{ document: player & T ; id: number }[]

Defined in ​

server/document/character.ts:320

getField ​

Get the current value of a specific field inside of the player data object. Can be extended to obtain any value easily.

Example ​

Get a default value.

const cash = Athena.document.character.getField<{}, number>(somePlayer, 'cash');
if (typeof cash === 'undefined') {
    return;
}

Alternatively, pass a custom interface.

interface CustomData {
    bitcoin: number
}

const bitcoins = Athena.document.character.getField<CustomData, number>(somePlayer, 'bitcoin');
if (typeof bitcoins === 'undefined') {
    return;
}

Type parameters ​

Parameters ​

Returns ​

ReturnType | undefined

Defined in ​

server/document/character.ts:145

onChange ​

Invokes the callback function when a document with a specific field name has changed.

Example ​

Athena.document.character.onChange('cash', (player: alt.Player, newValue: number, oldValue: number) => {
    // Do whatever you want with it.
    // Never, ever update the same document value twice in a row.
    // It creates an endless loop
})

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:297

override ​

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:347

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:348

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:349

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:350

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:351

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:352

Used to override any character document functionality

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:353

set ​

Sets a player document value, and saves it automatically to the selected character's database.

Automatically calls all callbacks associated with the field name.

Example ​

await Athena.document.character.set(somePlayer, 'cash', 50);

Alternatively, pass a custom interface.

interface CustomCharacter {
     someKey: string;
}

await Athena.document.character.set<CustomCharacter>(somePlayer, 'someKey', 'hello world');

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:186

setBulk ​

Sets player document values, and saves it automatically to the selected character's database.

Automatically calls all callbacks associated with the field name.

Example ​

await Athena.document.character.setBulk(player, { cash: 25, bank: 100 });

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:245

unbind ​

Unbind stored player character cache data.

Example ​

Athena.document.character.unbind(1);

Parameters ​

Returns ​

any

Defined in ​

server/document/character.ts:68