@my-swu/simulator-client

---

@my-swu/simulator-client / CreateLobbyRequest

Interface: CreateLobbyRequest

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:164

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

console.log(createLobbyRequest)

Properties

config

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { config } = createLobbyRequest

console.log(config)

config: LobbyConfig

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:165

---

historyIdentities

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { historyIdentities } = createLobbyRequest

console.log(historyIdentities)

historyIdentities: HistoryIdentityInput[]

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:180

Personal identities that should own the host player's history.

---

hostAuthenticated

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { hostAuthenticated } = createLobbyRequest

console.log(hostAuthenticated)

hostAuthenticated: boolean

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:174

Whether the host joined from an authenticated app session.

---

hostAvatarUrl?

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { hostAvatarUrl } = createLobbyRequest

console.log(hostAvatarUrl)

optional hostAvatarUrl?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:176

Public avatar image URL for the lobby host.

---

hostName

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { hostName } = createLobbyRequest

console.log(hostName)

hostName: string

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:172

---

hostProfileUrl?

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { hostProfileUrl } = createLobbyRequest

console.log(hostProfileUrl)

optional hostProfileUrl?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:178

Public profile URL for the lobby host.

---

matchSeed?

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { matchSeed } = createLobbyRequest

console.log(matchSeed)

optional matchSeed?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:169

Fixed match seed reused for limited duel matches.

---

packSeed?

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { packSeed } = createLobbyRequest

console.log(packSeed)

optional packSeed?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:167

Fixed limited pack/leader seed.

---

visibility

Example:

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

const createLobbyRequest: CreateLobbyRequest = {
  "config": {
    "type": "match",
    "format": "premier",
    "playerCount": 2,
    "bestOfMatches": 1,
    "gameTimerEnabled": false,
  },
  "visibility": "private",
  "hostName": 'example',
  "hostAuthenticated": false,
  "historyIdentities": [],
}

const { visibility } = createLobbyRequest

console.log(visibility)

visibility: LobbyVisibility

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:171

Whether the lobby should appear in public browsing surfaces.