@minecraft/server
    Preparing search index...

    Class TickingAreaManagerBeta

    This manager is used to add, remove or query temporary ticking areas to a dimension. These ticking areas are limited by a fixed amount of ticking chunks per pack independent of the command limits. Cannot modify or query ticking areas added by other packs or commands.

    Index

    Properties

    chunkCount maxChunkCount

    Methods

    createTickingArea getAllTickingAreas getTickingArea hasCapacity hasTickingArea removeAllTickingAreas removeTickingArea

    Properties

    chunkCount: number

    The number of currently ticking chunks in this manager.

    maxChunkCount: number

    The maximum number of allowed ticking chunks. Overlapping ticking area chunks do count towards total.

    Methods

    • Beta

      Parameters

      Returns Promise<TickingArea>

      Creates a ticking area. Promise will return when all the chunks in the area are loaded and ticking.

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

      TickingAreaError

    • Beta

      Returns TickingArea[]

      Gets all ticking areas added by this manager.

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Parameters

      Returns undefined | TickingArea

      Tries to get specific ticking area by identifier.

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Parameters

      Returns boolean

      Returns true if the manager has enough chunk capacity for the ticking area and false otherwise. Will also return false if the length or width exceeds the 255 chunk limit.

      This function can't be called in restricted-execution mode.

    • Beta

      Parameters

      • identifier: string

      Returns boolean

      Returns true if the identifier is already in the manager and false otherwise.

      This function can't be called in restricted-execution mode.

    • Beta

      Returns void

      Removes all ticking areas added by this manager.

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Parameters

      Returns void

      Removes specific ticking area by unique identifier.

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

      TickingAreaError

    Settings

    Member Visibility

    On This Page

    Properties
    Methods