Class AreaBackups

A class representing a collection of area backups.

Index

Constructors

Accessors

areas ids structureIds

Methods

clear createAreaBackup delete get

Constructors

constructor

new AreaBackups(): Globals.modules.coords.AreaBackups
Returns Globals.modules.coords.AreaBackups

Accessors

`Static`areas

get areas(): Globals.modules.coords.AreaBackup[]
The area backups.

Returns Globals.modules.coords.AreaBackup[]
- Defined in modules/coordinates/classes/AreaBackups.ts:33

`Static`ids

get ids(): string[]
The IDs of the area backups.

Returns string[]
- Defined in modules/coordinates/classes/AreaBackups.ts:13

`Static`structureIds

get structureIds(): string[]
The structure IDs of the area backups.

Returns string[]
- Defined in modules/coordinates/classes/AreaBackups.ts:23

Methods

`Static`clear

clear(): void
Deletes all area backups.

Returns void
- Defined in modules/coordinates/classes/AreaBackups.ts:56

`Static`createAreaBackup

createAreaBackup(
    id: string,
    dimension: string | Dimension,
    area: { from: Vector3; to: Vector3 },
): Globals.modules.coords.AreaBackup
Creates an area backup.
Parameters
- id: string
  The ID of the area backup.
- dimension: string | Dimension
  The dimension of the area backup.
- area: { from: Vector3; to: Vector3 }
  The area of the area backup.
Returns Globals.modules.coords.AreaBackup
The newly created area backup.
- Defined in modules/coordinates/classes/AreaBackups.ts:67

`Static`delete

delete(id: string): void
Deletes an area backup by its ID.
Parameters
- id: string
  The ID of the area backup.
Returns void
- Defined in modules/coordinates/classes/AreaBackups.ts:50

`Static`get

get(id: string): Globals.modules.coords.AreaBackup
Gets an area backup by its ID.
Parameters
- id: string
  The ID of the area backup.
Returns Globals.modules.coords.AreaBackup
The area backup.
- Defined in modules/coordinates/classes/AreaBackups.ts:42