Function editAreaForCustomCategory

  • editAreaForCustomCategory(
        sourceEntity: loosePlayerType,
        areaID: string,
        prefix: string,
    ): Promise<0 | 1>

    Edits a protected area for a specified custom category.

    Parameters

    • sourceEntity: loosePlayerType

      The player viewing the UI.

    • areaID: string

      The identifier for the area to be edited.

    • prefix: string

      The prefix associated with the custom category.

    Returns Promise<0 | 1>

    A promise that resolves to 0 if the previous menu should be closed, or 1 if the previous menu should be reopened.

    Throws

    If sourceEntity is not an instance of the Player class or an instance of the executeCommandPlayerW class with a Player linked to it.

    Remarks

    This function presents a form to the player allowing them to edit the coordinates, dimension, mode, and optional icon path of a protected area.

    Updates the protected area details based on user input and saves the changes.

    Handles errors by displaying a message to the player.

Settings

Member Visibility