Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Event (type): Difference between revisions

From FiguraMC
No edit summary
No edit summary
Line 1: Line 1:
{{Distinguish|Events}}
The event type is used for events such as <code>events.TICK</code>. To create an event function, use one of the following.
The event type is used for events such as <code>events.TICK</code>. To create an event function, use one of the following.


Line 30: Line 32:
| Returns the amount of functions registered, with an optional name argument ([https://lua.org/manual/5.1/manual.html#5.4 string])
| Returns the amount of functions registered, with an optional name argument ([https://lua.org/manual/5.1/manual.html#5.4 string])
|}
|}
[[Categories:Types]]

Revision as of 18:13, 26 September 2024

Not to be confused with Events.

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

 local tick = 0
function events.WORLD_TICK()
  tick = tick + 1
end
-- OR
local tick = 0
events.WORLD_TICK:register(function()
  tick = tick + 1
end, "TICK_COUNTER")

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)

Categories:Types

Contents