GetBundleDetailsAsync
This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.
For thread safety, this property is not safe to read in an unsynchronized thread.
This function returns details of the contents of the specified bundle.
Understanding the returned ValueTable
It returns a ValueTable object with the following key-value pairs containing details about the specified bundle
| Key Name | Value Type | Description |
|---|---|---|
| Id number | int | Bundle Id (passed in as an argument) |
| Name | string | Bundle name |
| Description | string | Bundle description |
| BundleType | string | Bundle Type. eg. BodyParts or `AvatarAnimation|AvatarAnimations` |
| Items | ValueArray | An array of ValueTable objects |
Each object in the Items array contains details of the item as described in the table below:
| Key Name | Value Type | Description |
|---|---|---|
| Id number | int | Item’s id |
| Name | string | Item name |
| Type | string | Item Type eg: "UserOutfit" or "Asset" |
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
|
|
The id of the specified bundle |
Returns
| Return Type | Summary |
|---|---|
|
A ValueTable object with the following key-value pairs containing details about the specified bundle. See the function description for more information |
Code Samples
Getting Bundle Details
The following code sample demonstrates how to retrieve details for the bundle with the id 13. The Expected Value tab displays the key-value pairs contained within the returned ValueTable and item array for the bundle with the specified id.