Asset packages
The bundle, directory or zip a style project is read from. Created with kind assets.
| Type | Class |
|---|---|
"bundle" | BundleAssetPackage |
"dir" | DirAssetPackage |
"zip" | ZippedAssetPackage |
"bundle" — BundleAssetPackage
{"type": "bundle", "path": …, "base": …}
{"type": "bundle", "path": …}
| Key | Type | Always required | Notes |
|---|---|---|---|
path | string | yes | |
base | object std::shared_ptr<AssetPackage> | no | an id of kind assets, or an inline spec |
| Property | Type | Access | Description |
|---|---|---|---|
basePath | string | read-only | Returns the path of the bundled directory the assets are read from. |
localAssetNames | struct std::vector<std::string> | read-only | Returns the list of assets found in the bundle, ignoring the base asset package. |
Inherited from AssetPackage:
| Property | Type | Access | Description |
|---|---|---|---|
assetNames | struct std::vector<std::string> | read-only |
"dir" — DirAssetPackage
{"type": "dir", "path": …, "base": …}
{"type": "dir", "path": …}
| Key | Type | Always required | Notes |
|---|---|---|---|
path | string | yes | |
base | object std::shared_ptr<AssetPackage> | no | an id of kind assets, or an inline spec |
| Property | Type | Access | Description |
|---|---|---|---|
dirPath | string | read-only | Returns the full path of the directory containing the assets. |
localAssetNames | struct std::vector<std::string> | read-only | Returns the list of assets stored in the directory, ignoring the base asset package. |
Inherited from AssetPackage:
| Property | Type | Access | Description |
|---|---|---|---|
assetNames | struct std::vector<std::string> | read-only |
"zip" — ZippedAssetPackage
{"type": "zip", "data": …, "base": …}
{"type": "zip", "data": …}
| Key | Type | Always required | Notes |
|---|---|---|---|
data | object std::shared_ptr<BinaryData> | yes | an id of kind data, or an inline spec |
base | object std::shared_ptr<AssetPackage> | no | an id of kind assets, or an inline spec |
| Property | Type | Access | Description |
|---|---|---|---|
localAssetNames | struct std::vector<std::string> | read-only |
Inherited from AssetPackage:
| Property | Type | Access | Description |
|---|---|---|---|
assetNames | struct std::vector<std::string> | read-only |
Base classes
Not constructed directly. Their properties are reachable on every object above that derives from them.
AssetPackage
| Property | Type | Access | Description |
|---|---|---|---|
assetNames | struct std::vector<std::string> | read-only |