Class UserEntity

Represents a user within the RBWCM ecosystem. Provides helper methods to update user data and fetch statistics directly from the entity instance.

Index

Constructors

Properties

discordId id ign partyId registeredAt updatedAt

Methods

ban clearStrikes createParty getActiveStrikes getCurrentStats getGamesHistory getParty getRank getStatistics isBanned strike unban updateDiscordId updateIgn

Constructors

constructor

new UserEntity(client: RankedClient, data: User): UserEntity
Instantiates a new UserEntity.
Parameters
- client: RankedClient
  The active SDK client instance.
- data: User
  The raw user data from the API.
Returns UserEntity
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:32

Properties

discordId

discordId: string

See

id

id: number

See

ign

ign: string

See

partyId

partyId: string | null

See

registeredAt

registeredAt: Date

See

User.registeredAt

updatedAt

updatedAt: Date

See

Methods

ban

ban(dto: BanUserDto): Promise<void>
Bans the user with the specified details.
Parameters
- dto: BanUserDto
  The details of the ban, including reason, duration, and staffer information.
Returns Promise<void>
A promise that resolves when the ban is successfully issued.
Example
```
await user.ban({ reason: 'Violation of rules', bannedBy: 'stafferId' });
```
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:132

clearStrikes

clearStrikes(): Promise<void>
Clears all active strikes for this user.

Returns Promise<void>
A promise resolving when all strikes are cleared.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:166

createParty

createParty(): Promise<PartyEntity>
Creates a new party with this user as the leader.

Returns Promise<PartyEntity>
A promise resolving to the newly created PartyEntity.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:189

getActiveStrikes

getActiveStrikes(): Promise<StrikeEntity[]>
Retrieves all active strikes for this user.

Returns Promise<StrikeEntity[]>
A promise resolving to an array of StrikeEntity representing the user's active strikes.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:158

getCurrentStats

getCurrentStats(rankedSystemId: string): Promise<StatisticsEntity>
Fetches the user's statistics for the currently active season of a specific ranked system.
Parameters
- rankedSystemId: string
  The system uuid (e.g., '123e4567-e89b-12d3-a456-426614174000').
Returns Promise<StatisticsEntity>
A promise resolving to a StatisticsEntity.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:89

getGamesHistory

getGamesHistory(limit?: number): Promise<GameEntity[]>
Fetches the user's recent game history.
Parameters
- limit: number = 10
  The maximum number of recent games to retrieve (default is 10).
Returns Promise<GameEntity[]>
A promise resolving to an array of GameEntity representing the user's recent games.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:202

getParty

getParty(): Promise<PartyEntity | null>
Fetches the party this user currently belongs to.

Returns Promise<PartyEntity | null>
A promise resolving to the PartyEntity, or null if the user is solo.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:176

getRank

getRank(rankedSystemId: string): Promise<RankEntity>
Fetches the user's current rank for a specific ranked system based on their ELO.
Parameters
- rankedSystemId: string
  The system uuid (e.g., '123e4567-e89b-12d3-a456-426614174000').
Returns Promise<RankEntity>
A promise resolving to a RankEntity representing the user's current rank.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:98

getStatistics

getStatistics(seasonId: string): Promise<StatisticsEntity>
Fetches the user's statistics for a specific competitive season.
Parameters
- seasonId: string
  The uuid of the season.
Returns Promise<StatisticsEntity>
A promise resolving to a StatisticsEntity.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:80

isBanned

isBanned(): Promise<boolean>
Checks if the user currently has an active ban.

Returns Promise<boolean>
A promise resolving to true if the user is currently banned, or false otherwise.
Example
```
const isBanned = await user.isBanned();
console.log(isBanned); // true or false
```
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:118

strike

strike(dto: AddStrikeDto): Promise<StrikeEntity>
Issues a strike to this user.
Parameters
- dto: AddStrikeDto
  The strike details.
Returns Promise<StrikeEntity>
A promise resolving to the newly created StrikeEntity.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:150

unban

unban(dto: UnbanUserDto): Promise<void>
Lifts an active ban from this user.
Parameters
- dto: UnbanUserDto
  The unban details.
Returns Promise<void>
A promise resolving when the user is successfully unbanned.
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:141

updateDiscordId

updateDiscordId(newDiscordId: string): Promise<UserEntity>
Updates the user's linked Discord ID.
Parameters
- newDiscordId: string
  The new Discord snowflake ID.
Returns Promise<UserEntity>
A promise resolving to the updated UserEntity instance.
Example
```
await user.updateDiscordId('466861191931756544');
console.log(user.discordId); // '466861191931756544'
```
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:68

updateIgn

updateIgn(newIgn: string): Promise<UserEntity>
Updates the user's In-Game Name (IGN) and syncs the entity with the backend.
Parameters
- newIgn: string
  The new Minecraft name.
Returns Promise<UserEntity>
A promise resolving to the updated UserEntity instance.
Example
```
await user.updateIgn('andrew0w0');
console.log(user.ign); // 'andrew0w0'
```
- Defined in packages/sdk/src/managers/users/entities/user.entity.ts:51