Function manageEventSubscriptions_event_newSubscription

  • manageEventSubscriptions_event_newSubscription<
        EventTypeID extends SubscribedEventTypeID,
    >(
        sourceEntity: loosePlayerType,
        eventType: EventTypeID,
    ): Promise<0 | 1>

    Displays a menu to create a new event subscription.

    Type Parameters

    Parameters

    • sourceEntity: loosePlayerType

      The player viewing the UI.

    • eventType: EventTypeID

      The type ID of the event this event subscription is for.

    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.

Settings

Member Visibility