Class AreaBackup

constructor

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

  Parameters

  • id: string

  Returns Globals.modules.coords.AreaBackup

id

backups

• get backups(): number[]

  Returns number[]

backupStructureIds

• get backupStructureIds(): string[]

  Returns string[]

dimension

• get dimension(): Dimension

  Returns Dimension

from

• get from(): Vector3

  Returns Vector3

size

• get size(): Vector3

  Returns Vector3

to

• get to(): Vector3

  Returns Vector3

backup

• backup(
      saveTime?: number,
      options?: StructureCreateOptions,
      sizeLimits?: { x: number; y: number; z: number },
  ): void

  Parameters

  • saveTime: number = ...
  • options: StructureCreateOptions = ...
  • sizeLimits: { x: number; y: number; z: number } = ...

  Returns void

backupRange

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

  Parameters

  • range: [from: Vector3, to: Vector3, indices: Vector3]
  • saveTime: number
  • Optionaloptions: StructureCreateOptions

  Returns void

clear

• clear(): void

  Returns void

clearBackup

• clearBackup(timestamp: string | number): void

  Parameters

  • timestamp: string | number

  Returns void

clearBackups

• clearBackups(): void

  Returns void

delete

• delete(): void

  Returns void

rollback

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

  Parameters

  • saveTime: number = ...
  • clearSave: boolean = false
  • Optionaloptions: StructurePlaceOptions
  • sizes: Vector3 = ...

  Returns 0 | 1

saveIds

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

  Parameters

  • timestamp: string | number

  Returns string[]

toJSON

• toJSON(): { dimension: Dimension; from: Vector3; id: string; to: Vector3 }

  Returns { dimension: Dimension; from: Vector3; id: string; to: Vector3 }

toJSONNoId

• toJSONNoId(): { dimension: Dimension; from: Vector3; to: Vector3 }

  Returns { dimension: Dimension; from: Vector3; to: Vector3 }