Class Player

Hierarchy (view full)

WebClientService
- Player

Index

Constructors

Properties

regionURL request

Methods

get joinParty leaveFromParty leaveParty remove setReady transferOwner

Constructors

constructor

new Player(request, regionURL): Player
Parameters
- request: AxiosInstance
- regionURL: WebClientRegionURL
Returns Player
Inherited from WebClientService.constructor
- Defined in web-client/src/client/WebClientService.ts:9

Properties

`Protected` `Readonly`regionURL

regionURL: WebClientRegionURL

`Protected` `Readonly`request

request: AxiosInstance

Methods

get

get(subject): PromiseResponse<GetPlayer>
Parameters
- subject: string
Returns PromiseResponse<GetPlayer>
- Defined in web-client/src/service/Party.ts:247

joinParty

joinParty(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:255

leaveFromParty

leaveFromParty(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:269

leaveParty

leaveParty(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:259

remove

remove(subject): PromiseResponse<any>
Parameters
- subject: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:251

setReady

setReady(subject, partyId, isReady): PromiseResponse<Party.Party>
Parameters
- subject: string
- partyId: string
- isReady: boolean
Returns PromiseResponse<Party.Party>
- Defined in web-client/src/service/Party.ts:263

transferOwner

transferOwner(subject, partyId): PromiseResponse<any>
Parameters
- subject: string
- partyId: string
Returns PromiseResponse<any>
- Defined in web-client/src/service/Party.ts:273