Class SubscribedEvent<EventTypeID, EventSignal>

constructor

• new SubscribedEvent<
      EventTypeID extends SubscribedEventTypeID,
      EventSignal extends
          SubscribedEventSignalUnion = EventTypeID extends `${TA}.${TB}.${TC}`
          ? TC extends keyof (TA extends "system" ? System : World)[TB]
              ? (TA extends "system" ? System : World)[TB][TC<TC>]
              : never
          : never,
  >(
      data: SubscribedEventSavedData<EventTypeID>,
      isSaved?: boolean,
  ): Globals.SubscribedEvent<EventTypeID, EventSignal>

  Creates a new event subscription.

  Type Parameters

  • EventTypeID extends SubscribedEventTypeID
  • EventSignal extends SubscribedEventSignalUnion = EventTypeID extends `${TA}.${TB}.${TC}`
        ? TC extends keyof (TA extends "system" ? System : World)[TB]
            ? (TA extends "system" ? System : World)[TB][TC<TC>]
            : never
        : never

  Parameters

  • data: SubscribedEventSavedData<EventTypeID>

    The data for the event subscription.
  • OptionalisSaved: boolean = false

    Whether or not the event subscription has already been saved.

  Returns Globals.SubscribedEvent<EventTypeID, EventSignal>

  Throws

  If the event type is unsupported.

  Throws

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

data

isSaved

false
Copy

creationTime

• get creationTime(): number

  The creation time of the event subscription.

  Undefined if the format of the save ID is not recognized.

  Returns number

  Default

  undefined
  Copy

eventType

• get eventType(): EventTypeID

  The type ID of the event this subscription is for.

  Returns EventTypeID

eventTypeLoadedEventsReference

• get eventTypeLoadedEventsReference(): Globals.SubscribedEvent<
      EventTypeID,
      EventSignal,
  >[]

  A reference to the array of loaded event subscriptions for the event this subscription is for.

  Returns Globals.SubscribedEvent<EventTypeID, EventSignal>[]

eventTypeSignalReference

• get eventTypeSignalReference(): EventSignal

  A reference to the event signal for the event this subscription is for.

  Returns EventSignal

initialized

• get initialized(): boolean

  Whether or not the event subscription has been initialized.

  Returns boolean

  Default

  false
  Copy

isValid

• get isValid(): boolean

  Whether or not the event subscription is valid.

  True if the event is loaded, false otherwise.

  Returns boolean

lastModified

• get lastModified(): number

  The last time the event subscription was modified.

  Returns number

  Default

  this.creationTime
  Copy

deinitialize

• deinitialize(): boolean

  Deinitializes the event subscription.

  This method unsubscribes the subscription from the actual event.

  Returns boolean

  A boolean representing whether or not the subscription was successfully deinitialized, currently it always returns true, as when it is not successful, an error is thrown.

  Remarks

  This function can't be called in read-only mode.

  This function can be called in early-execution mode.

  Throws

  If the event subscription callback is not initialized.

  Throws

  If the event subscription is not initialized.

delete

• delete(): void

  Deletes the event subscription.

  Returns void

  Remarks

  This function can't be called in read-only mode.

  This function can be called in early-execution mode.

  Description

  If the event subscription is initialized, it will be deinitialized.

  If the event subscription is loaded, it will be removed from the loaded event subscriptions list.

  If the event subscription is loaded and is saved, it will be removed from the loaded event subscriptions list, then the list of loaded event subscriptions will be saved, causing the event subscription to be deleted.

  If the event subscription is not loaded but is saved, the list of loaded event subscriptions will be saved, causing the event subscription to be deleted.

disable

• disable(): boolean

  Disables the event subscription.

  Returns boolean

  A boolean representing whether or not the subscription was successfully disabled, if the event is already disabled, false is returned, otherwise true.

enable

• enable(): boolean

  Enables the event subscription.

  Returns boolean

  A boolean representing whether or not the subscription was successfully enabled, if the event is already enabled, false is returned, otherwise true.

initialize

• initialize(): true

  Initializes the event subscription.

  This method subscribes the subscription to the actual event.

  Returns true

  A boolean representing whether or not the subscription was successfully initialized, currently it always returns true, as when it is not successful, an error is thrown.

  Remarks

  This function can't be called in read-only mode.

  This function can be called in early-execution mode.

  Throws

  If the event subscription is disabled.

  Throws

  If the event subscription callback has already been initialized.

  Throws

  If the event subscription has already been initialized.

  Throws

  If the event subscription callback is an empty string.

  Throws

  If the event subscription callback is not a string.

  Throws

  If the event subscription callback is not a valid stringified JavaScript function.

toJSON

• toJSON(): Full<SubscribedEventSavedData<EventTypeID>>

  Returns the data for the event subscription.

  Returns Full<SubscribedEventSavedData<EventTypeID>>