Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / WelcomePayload

Interface: WelcomePayload ​

Defined in: packages/ts-sdk/src/generated/types/common.ts:6591

Example:

ts
import type { WelcomePayload } from '@my-swu/simulator-client'

const welcomePayload: WelcomePayload = { matchId: 'match_123', role: 'player', seat: 'one' }

console.log(welcomePayload)

Properties ​

aiStatus? ​

Example:

ts
import type { WelcomePayload } from '@my-swu/simulator-client'

const welcomePayload: WelcomePayload = { matchId: 'match_123', role: 'player', seat: 'one' }

const { aiStatus } = welcomePayload

console.log(aiStatus)

optional aiStatus?: AiStatusPayload | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:6592


matchId ​

Example:

ts
import type { WelcomePayload } from '@my-swu/simulator-client'

const welcomePayload: WelcomePayload = { matchId: 'match_123', role: 'player', seat: 'one' }

const { matchId } = welcomePayload

console.log(matchId)

matchId: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:6593


role ​

Example:

ts
import type { WelcomePayload } from '@my-swu/simulator-client'

const welcomePayload: WelcomePayload = { matchId: 'match_123', role: 'player', seat: 'one' }

const { role } = welcomePayload

console.log(role)

role: MatchConnectionRole

Defined in: packages/ts-sdk/src/generated/types/common.ts:6594


seat? ​

Example:

ts
import type { WelcomePayload } from '@my-swu/simulator-client'

const welcomePayload: WelcomePayload = { matchId: 'match_123', role: 'player', seat: 'one' }

const { seat: welcomeSeat } = welcomePayload

console.log(welcomeSeat)

optional seat?: Seat | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:6595

Released under the MIT License.