Athena.session.vehicle ​

Functions ​

clearAll ​

Clear all keys, and remove all data for a session.

Export

Parameters ​

Returns ​

void

Defined in ​

server/session/vehicle.ts:122

clearKey ​

Clear a key from the vehicle.

Export

Parameters ​

Returns ​

void

Defined in ​

server/session/vehicle.ts:100

get ​

Retrieve data from a vehicle's session storage.

Type parameters ​

Parameters ​

Returns ​

AthenaSession.Vehicle[K] | undefined

Any type of value, can be specified with a generic type.

Defined in ​

server/session/vehicle.ts:78

getAll ​

Get all vehicles's that have a specific key.

Export

Type parameters ​

Parameters ​

Returns ​

AthenaSession.Vehicle[K][]

Defined in ​

server/session/vehicle.ts:140

has ​

Returns true, if it has any value set for a given key.

Export

Parameters ​

Returns ​

boolean

Defined in ​

server/session/vehicle.ts:59

set ​

Set data for a vehicle's session

This data is not persistent, and automatically clears on disconnect / vehicle destroy

Example ​

declare global {
    namespace AthenaSession {
        export interface Vehicle {
            myCustomValue: boolean;
        }
    }
}

Athena.session.vehicle.set(someVehicle, 'myCustomValue', true);

Type parameters ​

Parameters ​

Returns ​

void

Any type of value, can be specified with a generic type.

Defined in ​

server/session/vehicle.ts:36