bindEventHandler: Difference between revisions

Latest revision as of 20:36, 19 November 2022

Function Server and Client Online and Offline

Available since Server 1.0.0, Client 1.0.0

void bindEventHandler(string eventName, handle source, function handler)

The bindEventHandler function is used to add a handler to call when an event occurs for the source item.

1)	string	eventName	The name of the event, case-insensitive.
2)	handle	source	The source element.
3)	function	handler	The scripting function to call when the event occurs for the source element.

void	This function doesn't return a value.

function handler(Event event, ... vararg)

1)	Event	event	The event object.
2)	...	vararg	The arguments specific to the `eventName`.

There aren't any examples for this function.

There isn't any compatibility information for this function.

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = bindEventHandler
+|side = shared
 |type = function
-|name = bindEventHandler
+|games = iii vc sa iv
-|parameters = string eventName, handle source, function handler
+|desc = add a handler to call when an event occurs for the source item
-|parameter1 = string eventName The name of the event, case-insensitive.
+|arg1 = string eventName The name of the event, case-insensitive.
-|parameter2 = handle source The source element.
+|arg2 = handle source The source element.
-|parameter3 = function handler The scripting function to call when the event occurs for the source element.
+|arg3 = function handler The scripting function to call when the event occurs for the source element.
-|callback3Syntax = Event event, [...]
+|return = void
-|callback3Parameter1 = Event event The event object.
+|freturn = void
-|callback3Parameter2 = ... vararg The arguments specific to the <code>eventName</code>.
+|note = [[Server/Events|Server Events]]<br>
-|usage = add a handler to call when an event occurs for the source item
-|return1 = void
-|returnFail1 = void
-|notes = [[Server/Events|Server Events]]<br>
 [[Client/Events|Client Events]]
+|cb3arg1 = Event event The event object.
+|cb3arg2 = ... vararg The arguments specific to the <code>eventName</code>.
 }}