Class AreaBackup

constructor

• new AreaBackup(id: string): Globals.modules.coords.AreaBackup

  Creates a new AreaBackup instance.

  Parameters

  • id: string

    The ID of the area backup.

  Returns Globals.modules.coords.AreaBackup

Readonlyid

backups

• get backups(): number[]

  The timestamps of the backups, sorted newest first.

  Returns number[]

backupStructureIds

• get backupStructureIds(): string[]

  The structure IDs of the backed up area.

  Returns string[]

dimension

• get dimension(): Dimension

  The dimension of the backed up area.

  Returns Dimension

from

• get from(): Vector3

  The corner of the backed up area.

  Returns Vector3

size

• get size(): Vector3

  The size of the backed up area.

  Returns Vector3

to

• get to(): Vector3

  The opposite corner of the backed up area.

  Returns Vector3

backup

• backup(
      saveTime?: number,
      options?: StructureCreateOptions,
      sizeLimits?: Vector3,
  ): void

  Backs up the area.

  Parameters

  • OptionalsaveTime: number = ...

    The timestamp to save the backup.
  • Optionaloptions: StructureCreateOptions = ...

    The options to use when creating the backup. Defaults to { saveMode: StructureSaveMode.World, includeBlocks: true, includeEntities: false }.
  • OptionalsizeLimits: Vector3 = ...

    The size limits to use when splitting the area. Defaults to { x: 64, y: 128, z: 64 }.

  Returns void

backupRange

• backupRange(
      range: [from: Vector3, to: Vector3, indices: Vector3],
      saveTime: number,
      options?: StructureCreateOptions,
  ): void

  Backs up a specific range of the area.

  Parameters

  • range: [from: Vector3, to: Vector3, indices: Vector3]

    The range to back up.
  • saveTime: number

    The timestamp to save the backup.
  • Optionaloptions: StructureCreateOptions

    The options to use when creating the backup.

  Returns void

clear

• clear(): void

  Clears all backups from the area backup.

  Returns void

clearBackup

• clearBackup(timestamp: string | number): void

  Clears a specific backup from the area backup.

  Parameters

  • timestamp: string | number

    The timestamp of the backup to clear.

  Returns void

clearBackups

• clearBackups(): void

  Clears all backups from the area backup.

  Returns void

delete

• delete(): void

  Deletes the area backup.

  Returns void

rollback

• rollback(
      saveTime?: number,
      clearSave?: boolean,
      options?: StructurePlaceOptions,
      sizes?: Vector3,
  ): 0 | 1

  Rolls back to a specific backup.

  Parameters

  • OptionalsaveTime: number = ...

    The timestamp of the backup to roll back to. Defaults to the newest backup.
  • OptionalclearSave: boolean = false

    Whether to clear the backup after rolling back. Defaults to false.
  • Optionaloptions: StructurePlaceOptions

    The options to use when placing the backup.
  • Optionalsizes: Vector3 = ...

    The sizes to use when rolling back. Defaults to { x: 64, y: 128, z: 64 }.

  Returns 0 | 1

  1 if successful, 0 if not.

saveIds

• saveIds(timestamp: string | number): string[]

  The structure IDs of the backed up area for a specific backup.

  Parameters

  • timestamp: string | number

    The timestamp to get the structure IDs for.

  Returns string[]

  The structure IDs for the given timestamp.

toJSON

• toJSON(): SavedAreaBackupData

  The JSON representation of the area backup.

  Returns SavedAreaBackupData

  The JSON representation of the area backup.

toJSONNoId

• toJSONNoId(): Omit<SavedAreaBackupData, "id">

  The JSON representation of the area backup without the ID.

  Returns Omit<SavedAreaBackupData, "id">

  The JSON representation of the area backup without the ID.