Event (type)

From FiguraMC
Revision as of 17:46, 26 September 2024 by TheKillerBunny (talk | contribs)

The event type is used for events such as events.TICK. To create an event function, use one of the following.

function events[EVENT]()
end
-- OR
events[EVENT]:register(function()
end) -- optionally as a name argument to allow removal

Methods

Method Description
remove Takes in a string with the name of the event, and removes it, stopping it from being called
clear Clears the event of all methods
register Takes in a function to run when the event is fired, with an optional name argument (string)
getRegisteredCount Returns the amount of functions registered, with an optional name argument (string)

Fields

remove:

  1. name : string

register:

  1. function : function
  2. name : string (optional)

getRegisteredCount:

  1. name : string (optional)