Instantiate a new instance of DroppedAsset class for an existing dropped asset in a world.
Optionaloptions: DroppedAssetOptionalInterfaceReturns a new DroppedAsset object without fetching its properties.
This method creates a controller instance for an existing dropped asset but does not fetch its properties. Use this when you need a lightweight instance and will fetch properties separately if needed or when you already have the properties.
// Import the pre-initialized factory from your app's initialization file
import { DroppedAsset } from "utils/topiaInit.ts";
// Create a DroppedAsset instance with credentials
const droppedAssetInstance = DroppedAsset.create(
assetId,
urlSlug,
{
credentials: {
interactiveNonce,
interactivePublicKey,
assetId,
urlSlug,
visitorId
}
}
);
// Later fetch its properties if needed
await droppedAssetInstance.fetchDroppedAssetById();
Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
Returns a new DroppedAsset object representing the placed asset in the world.
This method places an existing Asset into a world at specified coordinates, effectively "dropping" it into the environment. You can customize various properties of the dropped asset during placement, such as scale, position, interactive settings, and visual layers.
// Import the pre-initialized factories from your app's initialization file
import { Asset, DroppedAsset } from "utils/topiaInit.ts";
// First get an asset instance
const assetInstance = Asset.create("asset-id-123", {
credentials: {
interactiveNonce,
interactivePublicKey,
assetId,
urlSlug,
visitorId
}
});
// Then drop (place) the asset in a world
const droppedAssetInstance = await DroppedAsset.drop(
assetInstance,
{
// Basic positioning and appearance
position: { x: 250, y: 350 },
assetScale: 1.5,
flipped: true,
uniqueName: "welcome-sign",
urlSlug: "my-world-slug",
// For web images (optional)
layer0: "https://example.com/background.png",
layer1: "https://example.com/foreground.png",
// For interactive assets (optional)
interactivePublicKey: "your-public-key",
isInteractive: true,
// For clickable assets (optional)
clickType: "link",
clickableLink: "https://example.com",
clickableLinkTitle: "Visit Example"
}
);
// The dropped asset is ready to use
console.log(droppedAssetInstance.id);
Standardized error handler for all SDK operations.
Standardized error object with properties: data, message, method, params, sdkMethod, stack, status, success, url
This method processes errors from API calls and formats them consistently across the SDK. It extracts relevant error information including:
All errors thrown by SDK methods flow through this handler to ensure consistent error format.
Instantiate a new instance of DroppedAsset class and automatically fetch all its properties.
Optionaloptions: DroppedAssetOptionalInterfaceReturns a new DroppedAsset object with all properties already fetched.
This method creates a controller instance and immediately fetches all properties of the dropped asset. It's a convenience method that combines creating an instance and calling fetchDroppedAssetById().
// Import the pre-initialized factory from your app's initialization file
import { DroppedAsset } from "utils/topiaInit.ts";
// Get a fully populated DroppedAsset instance
const droppedAssetInstance = await DroppedAsset.get(
assetId,
urlSlug,
{
credentials: {
interactiveNonce,
interactivePublicKey,
assetId,
urlSlug,
visitorId
}
}
);
// The properties are already loaded, so you can use them immediately
console.log(droppedAssetInstance.position);
Searches for and retrieves a dropped asset by its unique name within a world.
Returns a new DroppedAsset object with all properties already fetched.
This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with the matching uniqueName for the given urlSlug. Use this when you need to find a dropped asset by its uniqueName rather than its id.
// Import the pre-initialized factory from your app's initialization file
import { DroppedAsset } from "utils/topiaInit.ts";
// Find and retrieve a dropped asset by its unique name
const droppedAssetInstance = await DroppedAsset.getWithUniqueName(
"banner-sign-northeast",
"my-world-slug",
"your-interactive-secret",
{
apiKey: "your-api-key",
interactivePublicKey: "your-public-key",
// other credentials...
}
);
// The properties are already loaded, so you can use them immediately
console.log(droppedAssetInstance.position);
Returns the configured Axios instance for making API calls to Topia's Public API.
The configured Axios client instance with authentication headers.
Factory for creating and retrieving DroppedAsset instances. Use this factory to work with assets that have been placed in a Topia world.
Remarks
This factory should be instantiated once per application and reused across your codebase.
Keywords
dropped asset, factory, create, get, retrieve, instantiate, topia
Example