addEvent.yaml

shared:
  name: addEvent
  description: This function allows you to register a custom [event](/reference/Event_System "Event").
    Custom events function exactly like the built\-in events. See [event system](/reference/Event_System
    "Event system") for more information on the event system.
  parameters:
  - name: eventName
    type: string
    description: The name of the event you wish to create.
  - name: allowRemoteTrigger
    type: bool
    description: A boolean specifying whether this event can be called remotely using
      [[triggerClientEvent]] / [[triggerServerEvent]] or not.
    default: 'false'
  examples:
  - path: examples/addEvent-1.lua
    description: This example will define a new event.
  returns:
    values:
    - type: bool
      name: result
    description: Returns **true** if the event was added successfully, otherwise **false** if the event already exists **built-in game events** or if it fails for any other reason.