Interface WorldInterface

Hierarchy

Implemented by

Properties

background?: null | string
controls?: {
    allowMuteAll?: boolean;
    disableHideVideo?: boolean;
    isMobileDisabled?: boolean;
    isShowingCurrentGuests?: boolean;
}

Type declaration

  • Optional allowMuteAll?: boolean
  • Optional disableHideVideo?: boolean
  • Optional isMobileDisabled?: boolean
  • Optional isShowingCurrentGuests?: boolean
created?: object
dataObject?: null | object
description?: string
enforceWhitelistOnLogin?: boolean
forceAuthOnLogin?: boolean
height?: number
heroImage?: string
jwt?: string
mapExists?: boolean
name?: string
redirectTo?: null | string
requestOptions: object
spawnPosition?: {
    x?: number;
    y?: number;
}

Type declaration

  • Optional x?: number
  • Optional y?: number
tileBackgroundEverywhere?: null | boolean
topia: Topia
urlSlug: string
useTopiaPassword?: boolean
width?: number

Methods

  • Parameters

    • __namedParameters: {
          assetSuffix: string;
          position: object;
          sceneId: string;
      }
      • assetSuffix: string
      • position: object
      • sceneId: string

    Returns Promise<object | ResponseType>

  • Returns Promise<void | ResponseType>

  • Returns Promise<void | ResponseType>

  • Returns Promise<void | ResponseType>

  • Parameters

    • __namedParameters: {
          isPartial?: boolean;
          isReversed?: boolean;
          uniqueName: string;
      }
      • Optional isPartial?: boolean
      • Optional isReversed?: boolean
      • uniqueName: string

    Returns Promise<DroppedAsset[]>

  • Parameters

    • path: string
    • amount: number
    • options: object

    Returns Promise<void | ResponseType>

  • Parameters

    • sceneId: string

    Returns Promise<void | ResponseType>

  • Parameters

    • dataObject: undefined | null | object
    • options: object

    Returns Promise<void | ResponseType>

  • Parameters

    Returns Promise<object>

  • Parameters

    • dataObject: object
    • options: object

    Returns Promise<void | ResponseType>