Event (type) - Revision history

TheKillerBunny: Style guide

2024-10-05T20:21:06Z

Style guide

@@ Line 20: / Line 20: @@
 ! | Description
 |-
-| [[/remove|remove]]
+| [[#remove|remove]]
 | Takes in a {{type|string}} with the name of the event, and removes it, stopping it from being called
 |-
-| [[/clear|clear]]
+| [[#clear|clear]]
 | Clears the event of all methods
 |-
-| [[/register|register]]
+| [[#register|register]]
 | Takes in a {{type|function}} to run when the event is fired, with an optional name argument ({{type|string}})
 |-
-| [[/getRegisteredCount|getRegisteredCount]]
+| [[#getRegisteredCount|getRegisteredCount]]
 | Returns the amount of functions registered, with an optional name argument ({{type|string}})
 |}
 [[Category:Types]]

PoolloverNathan: PoolloverNathan moved page Event to Event (type): Distinguishing from Events

2024-09-27T18:47:19Z

PoolloverNathan moved page Event to Event (type): Distinguishing from Events

← Older revision		Revision as of 18:47, 27 September 2024
(No difference)

PenguinEncounter: use Template:Type?

2024-09-26T19:29:27Z

use Template:Type?

← Older revision		Revision as of 19:29, 26 September 2024
Line 21:		Line 21:
	\|-		\|-
	\| [[/remove\|remove]]		\| [[/remove\|remove]]
	\| Takes in a ~~[https://lua.org/manual/5.1/manual.html#5.4~~ string] with the name of the event, and removes it, stopping it from being called		\| Takes in a {{type\|string}} with the name of the event, and removes it, stopping it from being called
	\|-		\|-
	\| [[/clear\|clear]]		\| [[/clear\|clear]]
Line 27:		Line 27:
	\|-		\|-
	\| [[/register\|register]]		\| [[/register\|register]]
	\| Takes in a ~~[https://www.lua.org/manual/5.1/manual.html#2.5.9~~ function] to run when the event is fired, with an optional name argument (~~[https://lua.org/manual/5.1/manual.html#5.4~~ string])		\| Takes in a {{type\|function}} to run when the event is fired, with an optional name argument ({{type\|string}})
	\|-		\|-
	\| [[/getRegisteredCount\|getRegisteredCount]]		\| [[/getRegisteredCount\|getRegisteredCount]]
	\| 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 ({{type\|string}})
	\|}		\|}

	[[Category:Types]]		[[Category:Types]]

TheKillerBunny: TheKillerBunny moved page User:TheKillerBunny/Event to Event: Now I get to be a real page :3

2024-09-26T18:14:42Z

TheKillerBunny moved page User:TheKillerBunny/Event to Event: Now I get to be a real page :3

← Older revision		Revision as of 18:14, 26 September 2024
(No difference)

TheKillerBunny at 18:13, 26 September 2024

2024-09-26T18:13:52Z

← Older revision		Revision as of 18:13, 26 September 2024
Line 33:		Line 33:
	\|}		\|}

	[[~~Categories~~:Types]]		[[Category:Types]]

TheKillerBunny at 18:13, 26 September 2024

2024-09-26T18:13:33Z

← Older revision		Revision as of 18:13, 26 September 2024
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]]

TheKillerBunny at 18:11, 26 September 2024

2024-09-26T18:11:33Z

← Older revision		Revision as of 18:11, 26 September 2024
Line 1:		Line 1:
	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.

	<syntaxHighlight lang="lua">		<syntaxHighlight lang="lua"> local tick = 0
	function events~~[EVENT]~~()		function events.WORLD_TICK()
			tick = tick + 1
	end		end
	-- OR		-- OR
	events~~[EVENT]~~:register(function()		local tick = 0
	end) ~~-- optionally as a name argument to allow removal~~		events.WORLD_TICK:register(function()
			tick = tick + 1
			end, "TICK_COUNTER")
	</syntaxHighlight>		</syntaxHighlight>

Line 15:		Line 18:
	! \| Description		! \| Description
	\|-		\|-
	\| remove		\| [[/remove\|remove]]
	\| Takes in a [https://lua.org/manual/5.1/manual.html#5.4 string] with the name of the event, and removes it, stopping it from being called		\| Takes in a [https://lua.org/manual/5.1/manual.html#5.4 string] with the name of the event, and removes it, stopping it from being called
	\|-		\|-
	\| clear		\| [[/clear\|clear]]
	\| Clears the event of all methods		\| Clears the event of all methods
	\|-		\|-
	\| register		\| [[/register\|register]]
	\| Takes in a [https://www.lua.org/manual/5.1/manual.html#2.5.9 function] to run when the event is fired, with an optional name argument ([https://lua.org/manual/5.1/manual.html#5.4 string])		\| Takes in a [https://www.lua.org/manual/5.1/manual.html#2.5.9 function] to run when the event is fired, with an optional name argument ([https://lua.org/manual/5.1/manual.html#5.4 string])
	\|-		\|-
	\| getRegisteredCount		\| [[/getRegisteredCount\|getRegisteredCount]]
	\| 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])
	\|}		\|}
	~~== Fields ==~~
	~~remove:~~
	~~# name : [https://lua.org/manual/5.1/manual.html#5.4 string]~~
	~~register:~~
	~~# function : [https://www.lua.org/manual/5.1/manual.html#2.5.9 function]~~
	~~# name : [https://lua.org/manual/5.1/manual.html#5.4 string] (optional)~~
	~~getRegisteredCount:~~
	~~# name : [https://lua.org/manual/5.1/manual.html#5.4 string] (optional)~~

TheKillerBunny at 17:46, 26 September 2024

2024-09-26T17:46:30Z

← Older revision		Revision as of 17:46, 26 September 2024
Line 1:		Line 1:
	The event type is used for events such as `events		The event type is used for events such as <code>events.TICK</code>. To create an event function, use one of the following.
	TICK`. To create an event function, use one of the following.

	<syntaxHighlight lang="lua">		<syntaxHighlight lang="lua">
Line 10:		Line 9:
	</syntaxHighlight>		</syntaxHighlight>

			== Methods ==
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Line 27:		Line 27:
	\| 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])
	\|}		\|}
			== Fields ==
			remove:
			# name : [https://lua.org/manual/5.1/manual.html#5.4 string]
			register:
			# function : [https://www.lua.org/manual/5.1/manual.html#2.5.9 function]
			# name : [https://lua.org/manual/5.1/manual.html#5.4 string] (optional)
			getRegisteredCount:
			# name : [https://lua.org/manual/5.1/manual.html#5.4 string] (optional)

TheKillerBunny: Created page with "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 {| class="wikitable" |- ! | Method ! | Description |- | remove | Takes in a [https://lua.org/manual/5.1/manual.html#5.4 string] with the name of the event, and removes it, stopping it from..."

2024-09-26T17:30:00Z

Created page with "The event type is used for events such as `events TICK`. To create an event function, use one of the following. <syntaxHighlight lang="lua"> function events[EVENT]() end -- OR events[EVENT]:register(function() end) -- optionally as a name argument to allow removal </syntaxHighlight> {| class="wikitable" |- ! | Method ! | Description |- | remove | Takes in a [https://lua.org/manual/5.1/manual.html#5.4 string] with the name of the event, and removes it, stopping it from..."

New page

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

<syntaxHighlight lang="lua">
function events[EVENT]()
end
-- OR
events[EVENT]:register(function()
end) -- optionally as a name argument to allow removal
</syntaxHighlight>

{| class="wikitable"
|-
! | Method
! | Description
|-
| remove
| Takes in a [https://lua.org/manual/5.1/manual.html#5.4 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 [https://www.lua.org/manual/5.1/manual.html#2.5.9 function] to run when the event is fired, with an optional name argument ([https://lua.org/manual/5.1/manual.html#5.4 string])
|-
| getRegisteredCount
| Returns the amount of functions registered, with an optional name argument ([https://lua.org/manual/5.1/manual.html#5.4 string])
|}