Skip to main content

OnFrameworkEvent

Description​

@Server.OnFrameworkEvent() is a method decorator used to register a method as a listener for an internal OpenCore framework event.

Internal framework events represent lifecycle or system-level signals emitted by the framework itself, not by FiveM directly. This decorator allows controllers to react to those internal events in a structured and strongly typed way.

The decorator does not bind the event immediately. It stores metadata that the framework later reads during bootstrap to attach the method as an event listener.

This only works within each resource context; that is, if it's in the core, it only listens for events that will be sent within the core. There is no communication between resources here!

Arguments​

event - The name of the internal framework event.

The event name is strongly typed and must be a valid key of InternalEventMap. The method signature should accept the payload type associated with the selected event.

Example​

import { Server } from '@open-core/framework'

@Server.Controller()
export class SystemController {
  @Server.OnFrameworkEvent('internal:playerFullyConnected')
  onPlayerConnected(payload: PlayerFullyConnectedPayload) {
    console.log(`Player ${payload.player.session.clientId} connected`)
  }
}

In this example, the onPlayerConnected method is registered as a listener for the internal event internal:playerFullyConnected. When the framework emits this event, the method is invoked with a strongly typed payload.

Notes​

  • This decorator only stores metadata; event binding occurs during server bootstrap.
  • Internal events are emitted by the OpenCore framework, not by FiveM.
  • The payload type is determined by the InternalEventMap definition.
  • This decorator is intended for server-side controllers only.