Class RegisteredStorageType`Beta`

A registered storage type definition.

See

StorageTypeDefinition, registerStorageType

Implements

StorageTypeData

Index

Accessors

category id name texture

Methods

get getAllIds getOwn getOwnIds

Accessors

category

get category(): string
Beta
Returns string
The category of this storage type.
Implementation of StorageTypeData.category
- Defined in public_api/src/storage_type_registry.ts:60

id

get id(): string
Beta
Returns string
The ID of this storage type.
Implementation of StorageTypeData.id
- Defined in public_api/src/storage_type_registry.ts:52

name

get name(): string
Beta
Returns string
The name of this storage type.
- Defined in public_api/src/storage_type_registry.ts:76

texture

get texture(): StorageTypeTextureDescription | StorageTypeTexturePreset
Beta
Returns StorageTypeTextureDescription | StorageTypeTexturePreset
The texture preset or description of this storage type.
- Defined in public_api/src/storage_type_registry.ts:68

Methods

`Static`get

get(id: string): Promise<RegisteredStorageType | undefined>
Beta
Get a registered storage type by its ID.
Parameters
- id: string
  The ID of the storage type to get.
Returns Promise<RegisteredStorageType | undefined>
The registered storage type, or undefined if it does not exist.

Throws
Throws a PublicError of type PublicErrorType.InvalidState if this package has not been initialized (see init).
- Defined in public_api/src/storage_type_registry.ts:110

`Static`getAllIds

getAllIds(): Promise<string[]>
Beta
Get all registered storage type IDs.

Returns Promise<string[]>
An array containing all registered storage type IDs.

Throws
Throws a PublicError of type PublicErrorType.InvalidState if this package has not been initialized (see init).
- Defined in public_api/src/storage_type_registry.ts:143

`Static`getOwn

getOwn(id: string): RegisteredStorageType | undefined
Beta
Get a storage type registered by this pack by its ID.
Parameters
- id: string
  The ID of the storage type to get.
Returns RegisteredStorageType | undefined
The registered storage type, or undefined if it does not exist.

Remarks
This will only include storage types that have been registered by this pack. If a storage type registered by this pack has been overriden by another pack, this will return the original version registered by this pack. Use RegisteredStorageType.get to get storage types registered by any pack.
- Defined in public_api/src/storage_type_registry.ts:88

`Static`getOwnIds

getOwnIds(): string[]
Beta
Get all storage type IDs registered by this pack.

Returns string[]
An array containing all local registered storage type IDs.

Remarks
This will only include storage types that have been registered by this pack. Use RegisteredStorageType.getAllIds to get storage types registered by any pack.
- Defined in public_api/src/storage_type_registry.ts:99