Skip to content

Class: BasePlace

structures.BasePlace

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new BasePlace(options: BasePlaceOptions, client: default): BasePlace

Parameters:

Name Type
options BasePlaceOptions
client default

Returns: BasePlace

Defined in: structures/Game.ts:166

Properties

client

client: default

Defined in: structures/Game.ts:164


id

id: number

Defined in: structures/Game.ts:165


name

name: null | string

Defined in: structures/Game.ts:166

Methods

awardBadge

awardBadge(userId: number, badgeId: number): Promise<boolean>

Parameters:

Name Type
userId number
badgeId number

Returns: Promise<boolean>

Defined in: structures/Game.ts:194


getCompatibilities

getCompatibilities(): Promise<GetPlaceCompatibilities>

Returns: Promise<GetPlaceCompatibilities>

Defined in: structures/Game.ts:174


getGameServers

getGameServers(options: Pick<GetGameServersByTypeOptions, limit | cursor | sortOrder | serverType>): Promise<GetGameServersByType>

Parameters:

Name Type
options Pick<GetGameServersByTypeOptions, limit | cursor | sortOrder | serverType>

Returns: Promise<GetGameServersByType>

Defined in: structures/Game.ts:202


getStatistics

getStatistics(options: Pick<GetPlaceStatisticsByTypeOptions, type | granularity | divisionType | startTime | endTime>): Promise<GetPlaceStatisticsByType>

Parameters:

Name Type
options Pick<GetPlaceStatisticsByTypeOptions, type | granularity | divisionType | startTime | endTime>

Returns: Promise<GetPlaceStatisticsByType>

Defined in: structures/Game.ts:187


updatePlaceConfiguration

updatePlaceConfiguration(options: { description: string ; name: string }): Promise<UpdatePlaceConfiguration>

Parameters:

Name Type
options object
options.description string
options.name string

Returns: Promise<UpdatePlaceConfiguration>

Defined in: structures/Game.ts:180