Class LandClaimAlpha

A land claim for the land claim system.

Deprecated

This class is not functional yet.

Constructors

constructor

Properties

area customPermissions defaultPermissions dimension format_version land_claim_format_version name ownerId ownerName? saveId

Accessors

isOwnerOnline isSaved owner

Methods

remove save setPermissions toJSON delete get

Constructors

constructor

  • new LandClaim(
        claim: {
            area: { max: Vector3; min: Vector3 };
            customPermissions?: {
                [playerId: string]: {
                    breakBlocks: boolean;
                    enterArea: boolean;
                    interactWithBlocks: boolean;
                    placeBlocks: boolean;
                    playerName?: string;
                };
            };
            defaultPermissions?: {
                breakBlocks?: boolean;
                enterArea?: boolean;
                interactWithBlocks?: boolean;
                placeBlocks?: boolean;
            };
            dimension: string
            | Dimension;
            format_version?: string;
            land_claim_format_version?: string;
            name: string;
            ownerId: string;
            saveId: string;
        },
    ): Globals.modules.cmds.LandClaim
    Alpha

    Parameters

    • claim: {
          area: { max: Vector3; min: Vector3 };
          customPermissions?: {
              [playerId: string]: {
                  breakBlocks: boolean;
                  enterArea: boolean;
                  interactWithBlocks: boolean;
                  placeBlocks: boolean;
                  playerName?: string;
              };
          };
          defaultPermissions?: {
              breakBlocks?: boolean;
              enterArea?: boolean;
              interactWithBlocks?: boolean;
              placeBlocks?: boolean;
          };
          dimension: string
          | Dimension;
          format_version?: string;
          land_claim_format_version?: string;
          name: string;
          ownerId: string;
          saveId: string;
      }

    Returns Globals.modules.cmds.LandClaim

Properties

Alphaarea

area: { max: Vector3; min: Vector3 }

AlphacustomPermissions

customPermissions: {
    [playerId: string]: {
        breakBlocks: boolean;
        enterArea: boolean;
        interactWithBlocks: boolean;
        placeBlocks: boolean;
        playerName?: string;
    };
} = {}

AlphadefaultPermissions

defaultPermissions: {
    breakBlocks: boolean;
    enterArea: boolean;
    interactWithBlocks: boolean;
    placeBlocks: boolean;
} = ...

Alphadimension

dimension: Dimension

Alphaformat_version

format_version: string = format_version

Alphaland_claim_format_version

land_claim_format_version: string = LandClaimSystem.land_claim_format_version

Alphaname

name: string

AlphaownerId

ownerId: string

Optional AlphaownerName

ownerName?: string

AlphasaveId

saveId: string

Accessors

isOwnerOnline

  • get isOwnerOnline(): boolean
    Alpha

    Returns boolean

isSaved

  • get isSaved(): boolean
    Alpha

    Returns boolean

owner

  • get owner(): undefined | Player
    Alpha

    Returns undefined | Player

Methods

remove

  • remove(): void
    Alpha

    Returns void

save

  • save(otherDataToChange: any, keepOldFormatVersion?: boolean): void
    Alpha

    Parameters

    • otherDataToChange: any
    • keepOldFormatVersion: boolean = false

    Returns void

setPermissions

  • setPermissions(
        permissions: {
            breakBlocks: boolean;
            enterArea: boolean;
            interactWithBlocks: boolean;
            placeBlocks: boolean;
            playerName?: string;
        },
        playerOrPlayerId: string | Player,
        playerName?: string,
    ): void
    Alpha

    Parameters

    • permissions: {
          breakBlocks: boolean;
          enterArea: boolean;
          interactWithBlocks: boolean;
          placeBlocks: boolean;
          playerName?: string;
      }
    • playerOrPlayerId: string | Player
    • OptionalplayerName: string

    Returns void

toJSON

  • toJSON(): {
        area: { max: Vector3; min: Vector3 };
        customPermissions: {
            [playerId: string]: {
                breakBlocks: boolean;
                enterArea: boolean;
                interactWithBlocks: boolean;
                placeBlocks: boolean;
                playerName?: string;
            };
        };
        defaultPermissions: {
            breakBlocks: boolean;
            enterArea: boolean;
            interactWithBlocks: boolean;
            placeBlocks: boolean;
        };
        dimension: string;
        format_version: string;
        land_claim_format_version: string;
        name: string;
        ownerId: string;
        ownerName: undefined
        | string;
    }
    Alpha

    Returns {
        area: { max: Vector3; min: Vector3 };
        customPermissions: {
            [playerId: string]: {
                breakBlocks: boolean;
                enterArea: boolean;
                interactWithBlocks: boolean;
                placeBlocks: boolean;
                playerName?: string;
            };
        };
        defaultPermissions: {
            breakBlocks: boolean;
            enterArea: boolean;
            interactWithBlocks: boolean;
            placeBlocks: boolean;
        };
        dimension: string;
        format_version: string;
        land_claim_format_version: string;
        name: string;
        ownerId: string;
        ownerName: undefined
        | string;
    }

Staticdelete

  • delete(claimId: string): void
    Alpha

    Parameters

    • claimId: string

    Returns void

Staticget

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods