Class RegisteredItemMachine`Beta`

A registered item machine definition.

See

ItemMachineDefinition, registerItemMachine.

Index

Accessors

Methods

hasCallback get getOwn

Accessors

id

get id(): string
Beta
Returns string
- Defined in public_api/src/item_machine_registry.ts:45

maxStorage

get maxStorage(): number
Beta
Returns number
- Defined in public_api/src/item_machine_registry.ts:49

Methods

hasCallback

hasCallback(name: ItemMachineCallbackName): boolean
Beta
Tests if the registered item machine has a specific callback (event or handler).
Parameters
- name: ItemMachineCallbackName
  The name of the callback.
Returns boolean
Whether the item machine defines the specified callback.
- Defined in public_api/src/item_machine_registry.ts:59

`Static`get

get(id: string): Promise<RegisteredItemMachine | undefined>
Beta
Get a registered item machine by its ID.
Parameters
- id: string
  The ID of the item machine to get.
Returns Promise<RegisteredItemMachine | undefined>
The registered item machine, 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/item_machine_registry.ts:92

`Static`getOwn

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

Remarks
This will only include item machines that have been registered by this pack. If an item machine registered by this pack has been overriden by another pack, this will return the original version registered by this pack. Use RegisteredItemMachine.get to get item machines registered by any pack.
- Defined in public_api/src/item_machine_registry.ts:81