Class MachineNetworkBeta

Readonly Betaid

Readonly BetaioType

destroy

• destroy(): void
  Beta

  Destroy this object. This will force a new network to be established if any of the machines inside it still exist. Use this function to force network updates.

  Returns void

  See

  MachineNetwork.updateAdjacent, MachineNetwork.updateWith, MachineNetwork.updateWithBlock

  Throws

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

getLatestAllocationData

• getLatestAllocationData(): Promise<NetworkStorageTypeData>
  Beta

  Get the statistics from the latest network allocation.

  Returns Promise<NetworkStorageTypeData>

  Statistics about this network's storage type before and after the latest distribution.

  Remarks

  Contains statistics about each storage type's availability on the network before and after distribution, as of the latest network allocation. This is equivalent to the data passed to the onNetworkAllocationCompleted machine event.

  Throws

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

isBlockPartOfNetwork

• isBlockPartOfNetwork(block: Block): Promise<boolean>
  Beta

  Tests if a block is inside of this network.

  Parameters

  • block: Block

  Returns Promise<boolean>

  Throws

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

isPartOfNetwork

• isPartOfNetwork(
      location: DimensionLocation,
      type: NetworkConnectionType,
  ): Promise<boolean>
  Beta

  Tests if a machine matching the arguments is inside of this network.

  Parameters

  • location: DimensionLocation
  • type: NetworkConnectionType

  Returns Promise<boolean>

  Throws

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

queueSend

• queueSend(blockLocation: DimensionLocation, amount: number): void
  Beta

  Queue sending a storage type over this machine network.

  Parameters

  • blockLocation: DimensionLocation

    The location of the machine that is sending the storage type.

  • amount: number

    The amount to send. Must be greater than zero.

  Returns void

  Remarks

  • Note: in most cases, prefer generate over this function.
  • Automatically sets the machine's reserve storage to the amount that was not received.

  Throws

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

  See

  generate

Staticestablish

• establish(
      ioTypeId: string,
      location: DimensionLocation,
  ): Promise<MachineNetwork | undefined>
  Beta

  Establish a new network at location.

  Parameters

  • ioTypeId: string
  • location: DimensionLocation

  Returns Promise<MachineNetwork | undefined>

  Throws

  Throws a PublicError of type PublicErrorType.NotRegistered if the storage type does not exist.

  Throws

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

StaticgetAllWith

• getAllWith(
      location: DimensionLocation,
      type: NetworkConnectionType,
  ): Promise<MachineNetwork[]>
  Beta

  Get all MachineNetworks that contain a machine that matches the arguments.

  Parameters

  • location: DimensionLocation
  • type: NetworkConnectionType

  Returns Promise<MachineNetwork[]>

  Throws

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

StaticgetAllWithBlock

• getAllWithBlock(block: Block): Promise<MachineNetwork[]>
  Beta

  Get all MachineNetworks that contain a block.

  Parameters

  • block: Block

  Returns Promise<MachineNetwork[]>

  Throws

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

StaticgetOrEstablish

• getOrEstablish(
      ioTypeId: string,
      location: DimensionLocation,
  ): Promise<MachineNetwork | undefined>
  Beta

  Get the MachineNetwork that contains a block if it exists, otherwise establish a network using the block as the origin if it doesn't exist.

  Parameters

  • ioTypeId: string
  • location: DimensionLocation

  Returns Promise<MachineNetwork | undefined>

  See

  MachineNetwork.getWithBlock, MachineNetwork.establish

  Throws

  Throws a PublicError of type PublicErrorType.NotRegistered if the storage type does not exist.

  Throws

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

StaticgetWith

• getWith(
      ioTypeId: string,
      location: DimensionLocation,
      connectionType: NetworkConnectionType,
  ): Promise<MachineNetwork | undefined>
  Beta

  Get the MachineNetwork that contains a machine that matches the arguments.

  Parameters

  • ioTypeId: string

    the I/O type of the network.

  • location: DimensionLocation

    The location of the machine.

  • connectionType: NetworkConnectionType

    The connection type of the machine.

  Returns Promise<MachineNetwork | undefined>

  Throws

  Throws a PublicError of type PublicErrorType.NotRegistered if the storage type does not exist.

  Throws

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

StaticgetWithBlock

• getWithBlock(
      ioTypeId: string,
      block: Block,
  ): Promise<MachineNetwork | undefined>
  Beta

  Get the MachineNetwork that contains a block.

  Parameters

  • ioTypeId: string
  • block: Block

  Returns Promise<MachineNetwork | undefined>

  Throws

  Throws a PublicError of type PublicErrorType.NotRegistered if the storage type does not exist.

  Throws

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

StaticupdateAdjacent

• updateAdjacent(location: DimensionLocation): Promise<void>
  Beta

  Update all MachineNetworks adjacent to a location.

  Parameters

  • location: DimensionLocation

  Returns Promise<void>

  Throws

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

StaticupdateWith

• updateWith(
      location: DimensionLocation,
      type: NetworkConnectionType,
  ): Promise<void>
  Beta

  Update all MachineNetworks that contain a machine that matches the arguments.

  Parameters

  • location: DimensionLocation
  • type: NetworkConnectionType

  Returns Promise<void>

  Throws

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

StaticupdateWithBlock

• updateWithBlock(block: Block): Promise<void>
  Beta

  Update all MachineNetworks that contain a block.

  Parameters

  • block: Block

  Returns Promise<void>

  Throws

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