Class World

Summary

Create an instance of World class with a given url slug and optional attributes and session credentials.

Usage

await new World(topia, "exampleWorld", {
  attributes: { name: "Example World" },
  credentials: { apiKey: "exampleKey", interactiveNonce: "exampleNonce", urlSlug: "exampleWorld", visitorId: 1 }
});

Hierarchy

SDKController
- World

Implements

WorldInterface

Constructors

constructor

new World(topia: Topia, urlSlug: string, options?: WorldOptionalInterface): World
Parameters
- topia: Topia
- urlSlug: string
- options: WorldOptionalInterface = ...
Returns World
Overrides SDKController.constructor
- Defined in controllers/World.ts:38

Properties

credentials

credentials: undefined | InteractiveCredentials

`Optional` dataObject

dataObject?: null | object

`Optional` jwt

jwt?: string

requestOptions

requestOptions: object

`Optional` sceneDropIds

sceneDropIds?: null | [string]

`Optional` scenes

scenes?: null | [string]

topia

topia: Topia

urlSlug

urlSlug: string

`Optional` webhooks

webhooks?: null | WorldWebhooksInterface

Accessors

droppedAssets

get droppedAssets(): {
[key: string]: DroppedAsset;
}
Returns {
[key: string]: DroppedAsset;
}
- [key: string]: DroppedAsset
- Defined in controllers/World.ts:50

Methods

dropScene

dropScene(__namedParameters: {
    allowNonAdmins?: boolean;
    assetSuffix?: string;
    position: object;
    sceneDropId?: string;
    sceneId: string;
}): Promise<ResponseType>
Summary
Drops a scene in a world and returns sceneDropId.

Usage
```
await world.dropScene({
  "sceneId": "string",
  "position": {
    "x": 0,
    "y": 0
  },
  "assetSuffix": "string"
});
```
Result
```
{ sceneDropId: sceneId-timestamp, success: true }
```
Parameters
- __namedParameters: {
      allowNonAdmins?: boolean;
      assetSuffix?: string;
      position: object;
      sceneDropId?: string;
      sceneId: string;
  }
  - Optional allowNonAdmins?: boolean
  - Optional assetSuffix?: string
  - position: object
  - Optional sceneDropId?: string
  - sceneId: string
Returns Promise<ResponseType>
Implementation of WorldInterface.dropScene
- Defined in controllers/World.ts:456

errorHandler

errorHandler(__namedParameters: {
    error?: unknown;
    message?: string;
    params?: object;
    sdkMethod?: string;
}): {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
Parameters
- __namedParameters: {
      error?: unknown;
      message?: string;
      params?: object;
      sdkMethod?: string;
  }
  - Optional error?: unknown
  - Optional message?: string
  - Optional params?: object
  - Optional sdkMethod?: string
Returns {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
- data: {}
- message: string
- method: string
- params: object
- sdkMethod: undefined | string
- stack: string
- stackTrace: Error
- status: number
- success: boolean
- url: string
Inherited from SDKController.errorHandler
- Defined in controllers/SDKController.ts:93

fetchDataObject

fetchDataObject(): Promise<void | ResponseType>
Summary
Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.

Usage
```
await world.fetchDataObject();
const { dataObject } = world;
```
Returns Promise<void | ResponseType>
Implementation of WorldInterface.fetchDataObject
- Defined in controllers/World.ts:572

fetchDetails

fetchDetails(): Promise<void | ResponseType>
Summary
Retrieves details of a world.

Usage
```
await world.fetchDetails();
const { name } = world;
```
Returns Promise<void | ResponseType>
Implementation of WorldInterface.fetchDetails
- Defined in controllers/World.ts:65

fetchDroppedAssets

fetchDroppedAssets(): Promise<void | ResponseType>
Summary
Retrieve all assets dropped in a world.

Usage
```
await world.fetchDroppedAssets();
const assets = world.droppedAssets;
```
Returns Promise<void | ResponseType>
Implementation of WorldInterface.fetchDroppedAssets
- Defined in controllers/World.ts:181

fetchDroppedAssetsBySceneDropId

fetchDroppedAssetsBySceneDropId(__namedParameters: {
sceneDropId: string;
uniqueName?: string;
}): Promise<DroppedAsset[]>
Summary
Retrieve all assets dropped in a world matching sceneDropId.

Usage
```
await world.fetchDroppedAssetsBySceneDropId({
  sceneDropId: "sceneDropIdExample",
  uniqueName: "optionalUniqueNameExample",
});
const assets = world.droppedAssets;
```
Parameters
- __namedParameters: {
  sceneDropId: string;
  uniqueName?: string;
  }
  - sceneDropId: string
  - Optional uniqueName?: string
Returns Promise<DroppedAsset[]>
- Defined in controllers/World.ts:300

fetchDroppedAssetsWithUniqueName

fetchDroppedAssetsWithUniqueName(__namedParameters: {
    isPartial?: boolean;
    isReversed?: boolean;
    uniqueName: string;
}): Promise<DroppedAsset[]>
Summary
Retrieve all assets dropped in a world matching uniqueName.

Usage
```
await world.fetchDroppedAssetsWithUniqueName();
const assets = world.droppedAssets;
```
Parameters
- __namedParameters: {
      isPartial?: boolean;
      isReversed?: boolean;
      uniqueName: string;
  }
  - Optional isPartial?: boolean
  - Optional isReversed?: boolean
  - uniqueName: string
Returns Promise<DroppedAsset[]>
Implementation of WorldInterface.fetchDroppedAssetsWithUniqueName
- Defined in controllers/World.ts:211

fetchLandmarkZones

fetchLandmarkZones(landmarkZoneName?: string, sceneDropId?: string): Promise<DroppedAsset[]>
Summary
Retrieve all landmark zone assets dropped in a world.

Usage
```
const zones = await world.fetchLandmarkZones("optionalLandmarkZoneName", "optionalSceneDropIdExample");
```
Parameters
- Optional landmarkZoneName: string
- Optional sceneDropId: string
Returns Promise<DroppedAsset[]>
- Defined in controllers/World.ts:255

fetchSceneDropIds

fetchSceneDropIds(): Promise<object | ResponseType>
Deprecated
Use fetchScenes instead.

Summary
Fetch a list of all scene drop ids in a world that include at least one asset with an interactivePublicKey

Usage
```
await world.fetchSceneDropIds();
```
Result
```
{ sceneDropIds: [] }
```
Returns Promise<object | ResponseType>
- Defined in controllers/World.ts:381

fetchScenes

fetchScenes(): Promise<object | ResponseType>

Summary

Fetch a list of all scene drop ids and dropped assets in a world

Usage

await world.fetchScenes();

Result

{ "scenes": {
    "sceneDropId_1": {
        "droppedAssets": {
            "droppedAssetId_1": {
                "metaName": "hello"
                "metaNameReversed": "olleh"
            },
            "droppedAssetId_2": {
                "metaName": "world"
                "metaNameReversed": "dlorw"
            }
        }
    },
  }
}

Returns Promise<object | ResponseType>

fetchWebhooks

fetchWebhooks(): Promise<void | ResponseType>
Summary
Retrieve all webhooks in a world.

Usage
```
await world.fetchWebhooks();
const webhooks = world.webhooks;
```
Returns Promise<void | ResponseType>
- Defined in controllers/World.ts:696

fetchWorldAnalytics

fetchWorldAnalytics(__namedParameters: {
    dateValue: number;
    periodType: "week" | "month" | "quarter" | "year";
    year: number;
}): Promise<void | ResponseType>
Summary
Retrieve world analytics by day, week, month, quarter, or year

Usage
```
const analytics = await world.fetchWorldAnalytics({
  periodType: "week",
  dateValue: 40,
  year: 2023,
});
```
Parameters
- __namedParameters: {
      dateValue: number;
      periodType: "week" | "month" | "quarter" | "year";
      year: number;
  }
  - dateValue: number
  - periodType: "week" | "month" | "quarter" | "year"
  - year: number
Returns Promise<void | ResponseType>
- Defined in controllers/World.ts:722

getAllParticles

getAllParticles(): Promise<object | ResponseType>
Summary
Get all particles available

Usage
```
await world.getAllParticles();
```
Returns Promise<object | ResponseType>
- Defined in controllers/World.ts:512

incrementDataObjectValue

incrementDataObjectValue(path: string, amount: number, options?: {
    analytics?: AnalyticType[];
    lock?: {
        lockId: string;
        releaseLock?: boolean;
    };
}): Promise<void | ResponseType>
Summary
Increments a specific value in the data object for a world by the amount specified. Must have valid interactive credentials from a visitor in the world.

Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id

Usage
```
await world.incrementDataObjectValue("key", 1);
```
Parameters
- path: string
- amount: number
- options: {
      analytics?: AnalyticType[];
      lock?: {
          lockId: string;
          releaseLock?: boolean;
      };
  } = {}
  - Optional analytics?: AnalyticType[]
  - Optional lock?: {
    lockId: string;
    releaseLock?: boolean;
    }
    - lockId: string
    - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of WorldInterface.incrementDataObjectValue
- Defined in controllers/World.ts:662

replaceScene

replaceScene(sceneId: string): Promise<void | ResponseType>

Summary

Replace the current scene of a world.

Usage

const droppedAssetsToUpdate = [world.droppedAssets["6"], world.droppedAssets["12"]]
const style = {
  "textColor": "#abc123",
  "textFontFamily": "Arial",
  "textSize": 40,
  "textWeight": "normal",
  "textWidth": 200
}
await world.replaceScene(SCENE_ID);

Parameters

sceneId: string

Returns Promise<void | ResponseType>

setDataObject

setDataObject(dataObject: undefined | null | object, options?: {
    analytics?: AnalyticType[];
    lock?: {
        lockId: string;
        releaseLock?: boolean;
    };
}): Promise<void | ResponseType>
Summary
Sets the data object for a user. Must have valid interactive credentials from a visitor in the world.

Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id

Usage
```
await world.setDataObject({
  "exampleKey": "exampleValue",
});
const { dataObject } = world;
```
Parameters
- dataObject: undefined | null | object
- options: {
      analytics?: AnalyticType[];
      lock?: {
          lockId: string;
          releaseLock?: boolean;
      };
  } = {}
  - Optional analytics?: AnalyticType[]
  - Optional lock?: {
    lockId: string;
    releaseLock?: boolean;
    }
    - lockId: string
    - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of WorldInterface.setDataObject
- Defined in controllers/World.ts:599

topiaPublicApi

topiaPublicApi(): AxiosInstance
Returns AxiosInstance
Inherited from SDKController.topiaPublicApi
- Defined in controllers/SDKController.ts:89

triggerParticle

triggerParticle(__namedParameters: {
    duration?: number;
    id?: string;
    name?: string;
    position?: object;
}): Promise<string | ResponseType>
Summary
Trigger a particle effect at a position in the world

Usage
```
await world.triggerParticle({ name: "Flame" });
```
Parameters
- __namedParameters: {
      duration?: number;
      id?: string;
      name?: string;
      position?: object;
  }
  - Optional duration?: number
  - Optional id?: string
  - Optional name?: string
  - Optional position?: object
Returns Promise<string | ResponseType>
- Defined in controllers/World.ts:530

updateCloseWorldSettings

updateCloseWorldSettings(__namedParameters: {
closeWorldDescription: string;
isWorldClosed: boolean;
}): Promise<void | ResponseType>

Summary

Set close world settings

Usage

await world.updateCloseWorldSettings({
  controls: {
    allowMuteAll: true,
    disableHideVideo: true,
    isMobileDisabled: false,
    isShowingCurrentGuests: false,
  },
  description: 'Welcome to my world.',
  forceAuthOnLogin: false,
  height: 2000,
  name: 'Example',
  spawnPosition: { x: 100, y: 100 },
  width: 2000
});

Parameters

__namedParameters: {
closeWorldDescription: string;
isWorldClosed: boolean;
}
- closeWorldDescription: string
- isWorldClosed: boolean

Returns Promise<void | ResponseType>

updateCustomTextDroppedAssets

updateCustomTextDroppedAssets(droppedAssetsToUpdate: DroppedAsset[], style: object): Promise<object>
Summary
Update multiple custom text dropped assets with a single style while preserving text for specified dropped assets only.

Usage
```
const droppedAssetsToUpdate = [world.droppedAssets["6"], world.droppedAssets["12"]];
const style = {
  "textColor": "#abc123",
  "textFontFamily": "Arial",
  "textSize": 40,
  "textWeight": "normal",
  "textWidth": 200
};
await world.updateCustomText(droppedAssetsToUpdate, style);
```
Result
Updates each DroppedAsset instance and world.droppedAssets map.
Parameters
- droppedAssetsToUpdate: DroppedAsset[]
- style: object
Returns Promise<object>
Implementation of WorldInterface.updateCustomTextDroppedAssets
- Defined in controllers/World.ts:355

updateDataObject

updateDataObject(dataObject: object, options?: {
    analytics?: AnalyticType[];
    lock?: {
        lockId: string;
        releaseLock?: boolean;
    };
}): Promise<void | ResponseType>
Summary
Updates the data object for a world. Must have valid interactive credentials from a visitor in the world.

Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id

Usage
```
await world.updateDataObject({
  "exampleKey": "exampleValue",
});
const { dataObject } = world;
```
Parameters
- dataObject: object
- options: {
      analytics?: AnalyticType[];
      lock?: {
          lockId: string;
          releaseLock?: boolean;
      };
  } = {}
  - Optional analytics?: AnalyticType[]
  - Optional lock?: {
    lockId: string;
    releaseLock?: boolean;
    }
    - lockId: string
    - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of WorldInterface.updateDataObject
- Defined in controllers/World.ts:632

updateDetails

updateDetails(__namedParameters: WorldDetailsInterface): Promise<void | ResponseType>

Summary

Update details of a world.

Usage

await world.updateDetails({
  controls: {
    allowMuteAll: true,
    disableHideVideo: true,
    isMobileDisabled: false,
    isShowingCurrentGuests: false,
  },
  description: 'Welcome to my world.',
  forceAuthOnLogin: false,
  height: 2000,
  name: 'Example',
  spawnPosition: { x: 100, y: 100 },
  width: 2000
});

Parameters

__namedParameters: WorldDetailsInterface

Class World

Summary

Usage

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

topia: Topia

urlSlug: string

options: WorldOptionalInterface = ...

Returns World

Properties

credentials

Optional dataObject

Optional jwt

requestOptions

Optional sceneDropIds

Optional scenes

topia

urlSlug

Optional webhooks

Accessors

droppedAssets

Returns { [key: string]: DroppedAsset; }

[key: string]: DroppedAsset

Methods

dropScene

Summary

Usage

Result

Parameters

__namedParameters: { allowNonAdmins?: boolean; assetSuffix?: string; position: object; sceneDropId?: string; sceneId: string; }

Optional allowNonAdmins?: boolean

Optional assetSuffix?: string

position: object

Optional sceneDropId?: string

sceneId: string

Returns Promise<ResponseType>

errorHandler

Parameters

__namedParameters: { error?: unknown; message?: string; params?: object; sdkMethod?: string; }

Optional error?: unknown

Optional message?: string

Optional params?: object

Optional sdkMethod?: string

Returns { data: {}; message: string; method: string; params: object; sdkMethod: undefined | string; stack: string; stackTrace: Error; status: number; success: boolean; url: string; }

data: {}

message: string

method: string

params: object

sdkMethod: undefined | string

stack: string

stackTrace: Error

status: number

success: boolean

url: string

fetchDataObject

Summary

Usage

Returns Promise<void | ResponseType>

fetchDetails

Summary

Usage

Returns Promise<void | ResponseType>

fetchDroppedAssets

Summary

Usage

Returns Promise<void | ResponseType>

fetchDroppedAssetsBySceneDropId

Summary

Usage

Parameters

__namedParameters: { sceneDropId: string; uniqueName?: string; }

sceneDropId: string

`Optional` dataObject

`Optional` jwt

`Optional` sceneDropIds

`Optional` scenes

`Optional` webhooks

Returns {
[key: string]: DroppedAsset;
}

__namedParameters: {
allowNonAdmins?: boolean;
assetSuffix?: string;
position: object;
sceneDropId?: string;
sceneId: string;
}

`Optional` allowNonAdmins?: boolean

`Optional` assetSuffix?: string

`Optional` sceneDropId?: string

__namedParameters: {
error?: unknown;
message?: string;
params?: object;
sdkMethod?: string;
}

`Optional` error?: unknown

`Optional` message?: string

`Optional` params?: object

`Optional` sdkMethod?: string

Returns {
data: {};
message: string;
method: string;
params: object;
sdkMethod: undefined | string;
stack: string;
stackTrace: Error;
status: number;
success: boolean;
url: string;
}

__namedParameters: {
sceneDropId: string;
uniqueName?: string;
}

`Optional` uniqueName?: string

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

`Optional` isPartial?: boolean

`Optional` isReversed?: boolean

`Optional` landmarkZoneName: string

`Optional` sceneDropId: string

__namedParameters: {
dateValue: number;
periodType: "week" | "month" | "quarter" | "year";
year: number;
}

options: {
analytics?: AnalyticType[];
lock?: {
lockId: string;
releaseLock?: boolean;
};
} = {}

`Optional` analytics?: AnalyticType[]

`Optional` lock?: {
lockId: string;
releaseLock?: boolean;
}

`Optional` releaseLock?: boolean

options: {
analytics?: AnalyticType[];
lock?: {
lockId: string;
releaseLock?: boolean;
};
} = {}