Options
All
  • Public
  • Public/Protected
  • All
Menu

Wrapper for the native TickingAreasManager class to add or remove new ticking areas to the world the player is in at the moment.

since

3.0

Hierarchy

Index

Methods

  • Adds new circle-shaped ticking area to the given dimension. It covers not only the blocks included in the resulting circle, but all the chunks that intersect with this circle. In this overload, the name of the area is set to default ("Area{N}")

    since

    3.0

    Parameters

    • dimension: WorldOrDimension

      dimension where to create the ticking area

    • x: number

      X coordinate of the area's center position

    • z: number

      Z coordinate of the area's center position

    • radius: number

      area's radius in meters (blocks)

    Returns void

  • Adds new circle-shaped ticking area to the given dimension. It covers not only the blocks included in the resulting circle, but all the chunks that intersect with this circle. In this overload, the name of the area is set to default ("Area{N}")

    since

    3.0

    Parameters

    • dimension: WorldOrDimension

      dimension where to create the ticking area

    • name: any_string

      area name, that must be unique for the given dimension

    • x: number

      X coordinate of the area's center position

    • z: number

      Z coordinate of the area's center position

    • radius: number

      area's radius in meters (blocks)

    Returns void

  • addRectangleArea(dimension: WorldOrDimension, x1: number, z1: number, x2: number, z2: number): void
  • addRectangleArea(dimension: WorldOrDimension, name: any_string, x1: number, z1: number, x2: number, z2: number): void
  • Adds new rectangle-shaped ticking area to the given dimension. It covers not only the blocks included in the resulting rectangle, but all the chunks that intersect with this rectangle. In this overload, the name of the area is set to default ("Area{N}")

    since

    3.0

    Parameters

    • dimension: WorldOrDimension

      dimension where to create the ticking area

    • x1: number

      X coordinate of the area's start position

    • z1: number

      Z coordinate of the area's start position

    • x2: number

      X coordinate of the area's end position

    • z2: number

      Z coordinate of the area's end position

    Returns void

  • Adds new rectangle-shaped ticking area to the given dimension. It covers not only the blocks included in the resulting rectangle, but all the chunks that intersect with this rectangle.

    since

    3.0

    Parameters

    • dimension: WorldOrDimension

      dimension where to create the ticking area

    • name: any_string

      area name, that must be unique for the given dimension

    • x1: number

      X coordinate of the area's start position

    • z1: number

      Z coordinate of the area's start position

    • x2: number

      X coordinate of the area's end position

    • z2: number

      Z coordinate of the area's end position

    Returns void

  • clone(): any
  • countAllAreas(): number
  • since

    3.0

    Returns number

    how many ticking areas are there in all dimensions of the current Minecraft world at the moment.

  • since

    3.0

    Parameters

    Returns number

    how many ticking areas are there in the given dimension at the moment.

  • equals(param0: any): boolean
  • finalize(): void
  • Method used internally when you don't specify the name for a new ticking area.

    since

    3.0

    Parameters

    Returns String

    names that look like "Area{N}", where {N} is an incrementing integer.

  • getPointer(): number
  • Returns number

    pointer to the native object wrapped by the following native interface object, represented by a signed 64-bit integer

  • hasActiveAreas(): boolean
  • since

    3.0

    Returns boolean

    whether there is at least one active ticking area in the world at the moment.

  • since

    3.0

    Parameters

    Returns number

    whether a ticking area exists by given name in the given dimension. Dimension parameter is needed because every dimension has its own ticking areas list, and it's possible that two areas with the same name exist at the same time in different dimensions

  • hashCode(): number
  • notify(): void
  • notifyAll(): void
  • Removes all the ticking areas from given dimension containing the given position.

    since

    3.0

    Parameters

    Returns void

  • toString(): string
  • wait(): void
  • wait(param0: number): void
  • wait(param0: number, param1: number): void

Generated using TypeDoc