Function manageEventSubscriptions_event

  • manageEventSubscriptions_event<EventTypeID extends SubscribedEventTypeID>(
        sourceEntity: loosePlayerType,
        eventType: EventTypeID,
        pagen?: number,
        maxentriesperpage?: number,
        search?: { caseSensitive?: boolean; value: string },
        cachedEntries?: Globals.SubscribedEvent<
            EventTypeID,
            EventTypeID extends `${TA}.${TB}.${TC}`
                ? TC extends keyof (TA extends "system" ? System : World)[TB]
                    ? (TA extends "system" ? System : World)[TB][TC<TC>]
                    : never
                : never,
        >[],
    ): Promise<0 | 1>

    Displays a menu to manage event subscriptions for a specific event.

    Type Parameters

    Parameters

    • sourceEntity: loosePlayerType

      The player accessing the menu.

    • eventType: EventTypeID

      The event type to manage subscriptions for.

    • Optionalpagen: number = 0

      The page of the menu to go to. Defaults to 0.

    • Optionalmaxentriesperpage: number = ...

      How many entries to show per page. Defaults to the value of config.ui.pages.maxPlayersPerManagePlayersPage.

    • Optionalsearch: { caseSensitive?: boolean; value: string }

      An object containing the current search query, if any, and search options.

      • OptionalcaseSensitive?: boolean

        Whether to perform a case-sensitive search. Defaults to false.

      • value: string

        The current search query.

    • OptionalcachedEntries: Globals.SubscribedEvent<
          EventTypeID,
          EventTypeID extends `${TA}.${TB}.${TC}`
              ? TC extends keyof (TA extends "system" ? System : World)[TB]
                  ? (TA extends "system" ? System : World)[TB][TC<TC>]
                  : never
              : never,
      >[]

      The cached entries to show in the menu.

    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.

    Throws

    If the event type is unsupported.

    Throws

    If the loaded event subscriptions list for the event type is not an array.

Settings

Member Visibility