Function duplicateCustomAreaCategory

  • duplicateCustomAreaCategory(
        sourceEntity: loosePlayerType,
        categoryID: string,
    ): Promise<0 | 1 | 2>

    Duplicates a custom protected area category.

    Parameters

    • sourceEntity: loosePlayerType

      The player viewing the UI.

    • categoryID: string

      The ID of the category to duplicate.

    Returns Promise<0 | 1 | 2>

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

    Async

    Throws

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

    The function performs the following steps:

    1. Validates the number of arguments and the type of the source entity.
    2. Checks if the player has the necessary permissions to create a custom protected area category.
    3. Checks if the category with the provided ID exists.
    4. Asks the player for a name for the new category.
    5. Duplicates the category with the provided ID.
    6. Calls editCustomAreaCategory to allow further editing of the newly created category.

Settings

Member Visibility