V5 DocsAthenaShared.interfaces.character.Character ​
shared/interfaces/character.Character
Used as the main interface for storing character data.
Interface
Character
Indexable ​
â–ª [key: string]: any
Properties ​
_id ​
• Optional _id: any
The character identifier in the database.
Defined in ​
shared/interfaces/character.ts:21
account_id ​
• account_id: any
The account id associated with this character.
Defined in ​
shared/interfaces/character.ts:36
appearance ​
• appearance: Appearance | Partial<Appearance>
Appearance data for how this character looks.
Defined in ​
shared/interfaces/character.ts:131
armour ​
• armour: number
The amount of armour the player last had.
Defined in ​
shared/interfaces/character.ts:88
bank ​
• bank: number
The amount of cash in the bank this character has.
Defined in ​
shared/interfaces/character.ts:74
cash ​
• cash: number
The amount of cash this character has.
Defined in ​
shared/interfaces/character.ts:67
character_id ​
• Optional character_id: number
An incremental numerical identifier that increases with each character created. Does not fill gaps. Do not use as a way to save character information.
Defined in ​
shared/interfaces/character.ts:29
dimension ​
• dimension: number
The current dimension of the player. When they spawn they are automatically moved into this dimension.
Defined in ​
shared/interfaces/character.ts:45
food ​
• food: number
The amount of food the player has.
Defined in ​
shared/interfaces/character.ts:95
groups ​
• Optional groups: Object
A key value pair that contains a list of permissions a character has for a group.
Memberof
Character
Index signature ​
â–ª [key: string]: string[]
Defined in ​
shared/interfaces/character.ts:197
health ​
• health: number
The amount of health the player last had.
Defined in ​
shared/interfaces/character.ts:81
hours ​
• hours: number
Amount of hours the player has played.
Defined in ​
shared/interfaces/character.ts:117
info ​
• info: Partial<CharacterInfo>
Character info. Will eventually be used for ID cards.
Defined in ​
shared/interfaces/character.ts:138
interior ​
• interior: number
Current player interior number. Usually bound to dimension.
Defined in ​
shared/interfaces/character.ts:146
inventory ​
• inventory: StoredItem[]
Individual item references that the player currently has on-hand.
Defined in ​
shared/interfaces/character.ts:162
isDead ​
• isDead: boolean
Is this player dead or not. Health does not dictate whether a player is alive or dead.
Defined in ​
shared/interfaces/character.ts:110
name ​
• name: string
The name of this character to display to other users.
Defined in ​
shared/interfaces/character.ts:60
permissions ​
• permissions: string[]
Permissions for a given user.
Defined in ​
shared/interfaces/character.ts:154
pos ​
• pos: IVector3
The position that this character last logged out at. This also updates every 5s or so.
Defined in ​
shared/interfaces/character.ts:53
skin ​
• Optional skin: string | number
A custom model that can be applied to the player. If this is set; the clothing items will never be applied. This also goes for appearance as well.
Defined in ​
shared/interfaces/character.ts:189
toolbar ​
• toolbar: StoredItem[]
Individual item references that the player may access through the 1-4 keys
Defined in ​
shared/interfaces/character.ts:170
uniform ​
• Optional uniform: ClothingComponent[]
Clothes that will be applied to the player last. Uniforms should be used in tandem with typical inventory clothing.
Defined in ​
shared/interfaces/character.ts:179
wanted ​
• wanted: number
Wanted stars to display.
Defined in ​
shared/interfaces/character.ts:124
water ​
• water: number
The amount of water the player has.