Class RegisteredMachineBeta

Readonly BetauiElements

defaultEntityNameTag

• get defaultEntityNameTag(): string
  Beta

  Returns string

  The default name tag for this machine's entity.

entityId

• get entityId(): string
  Beta

  Returns string

  The ID for this machine's entity.

id

• get id(): string
  Beta

  Returns string

  The ID of this machine.

maxStorage

• get maxStorage(): number
  Beta

  Returns number

  The max amount of each storage type in this machine.

persistentEntity

• get persistentEntity(): boolean
  Beta

  Returns boolean

  Whether this machine has a persistent entity or not

hasCallback

• hasCallback(name: MachineCallbackName): boolean
  Beta

  Tests if the registered machine has a specific callback (event or handler).

  Parameters

  • name: MachineCallbackName

    The name of the callback.

  Returns boolean

  Whether the machine defines the specified callback.

StaticforceGet

• forceGet(id: string): Promise<RegisteredMachine>
  Beta

  Get a registered machine by its ID or throw an error if it doesn't exist.

  Parameters

  • id: string

    The ID of the machine to get.

  Returns Promise<RegisteredMachine>

  The registered machine.

  Throws

  Throws a PublicError of type PublicErrorType.NotRegistered if the machine does not exist in the registry.

  Throws

  Throws a PublicError of type PublicErrorType.InvalidState if this package has not been initialized (see init).

Staticget

• get(id: string): Promise<RegisteredMachine | undefined>
  Beta

  Get a registered machine by its ID.

  Parameters

  • id: string

    The ID of the machine to get.

  Returns Promise<RegisteredMachine | undefined>

  The registered 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).

StaticgetOwn

• getOwn(id: string): RegisteredMachine | undefined
  Beta

  Get a machine registered by this pack by its ID.

  Parameters

  • id: string

    The ID of the machine to get.

  Returns RegisteredMachine | undefined

  The registered machine, or undefined if it does not exist.

  Remarks

  This will only include machines that have been registered by this pack. If a machine registered by this pack has been overriden by another pack, this will return the original version registered by this pack. Use RegisteredMachine.get to get machines registered by any pack.