Event functions

functions/Event/addEvent.yaml

@@ -1,8 +1,7 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/AddEvent
 shared:
   name: addEvent
-  description: This function allows you to register a custom [event](/wiki/Event "Event").
-    Custom events function exactly like the built\-in events. See [event system](/wiki/Event_system
+  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
@@ -11,19 +10,13 @@ shared:
   - name: allowRemoteTrigger
     type: bool
     description: A boolean specifying whether this event can be called remotely using
-      triggerClientEvent / triggerServerEvent or not.
+      [[triggerClientEvent]] / [[triggerServerEvent]] or not.
     default: 'false'
   examples:
   - path: examples/addEvent-1.lua
-    description: This example will define a new event calledonSpecialEvent.
-    side: server
-  - path: examples/addEvent-2.lua
-    description: 'You can then trigger this event later on using:'
-    side: server
+    description: This example will define a new event.
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if the event was added successfully, false if the event
-      was already added.
-  requires_review: true
+      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.

functions/Event/addEventHandler.yaml

@@ -1,22 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/AddEventHandler
 shared:
   name: addEventHandler
-  description: This function will add an [event](/wiki/Event "Event") handler. An
+  description: This function will add an [event](/reference/Event_System "Event System") handler. An
     event handler is a function that will be called when the event it's attached to
-    is triggered. See [event system](/wiki/Event_system "Event system") for more information
+    is triggered. See [event system](/reference/Event_System "Event System") for more information
     on how the event system works.
   parameters:
   - name: eventName
     type: string
-    description: 'The name of the event you want to attach the handler function to.
-      Note: The maximum allowed length is 100 ASCII characters (that is, English letters
-      and numerals)'
+    description: 'The name of the [event](/reference/Event_System "Event System") you want to attach the handler function to.
+      **Note: The maximum allowed length is 100 ASCII characters (that is, English letters
+      and numerals)**'
   - name: attachedTo
     type: element
-    description: The element you wish to attach the handler to. The handler will only
+    description: The [element](/reference/Element "Element") you wish to attach the handler to. The handler will only
       be called when the event it is attached to is triggered for this element, or
       one of its children. Often, this can be the root element (meaning the handler
-      will be called when the event is triggered for any element).
+      will be called when the event is triggered for *any* element).
   - name: handlerFunction
     type: function
     description: The handler function you wish to call when the event is triggered.
@@ -25,42 +24,40 @@ shared:
   - name: propagate
     type: bool
     description: A boolean representing whether the handler will be triggered if the
-      event was propagated down or up the element tree (starting from the source),
+      event was propagated down or up the [element tree](/reference/Element_tree "Element tree") (starting from the source),
       and not triggered directly on attachedTo (that is, handlers attached with this
       argument set to false will only be triggered if source == this ). In GUI events
       you will probably want to set this to false .
     default: 'true'
   - name: priority
     type: string
-    description: MISSING_PARAM_DESC
+    description: 'A string representing the trigger order priority relative to other event handlers of the same name. Possible values are:'
+    templateList: 'event-priority'
     default: '"normal"'
   examples:
   - path: examples/addEventHandler-1.lua
     description: This serverside example sends a message to everyone in the server
       when a player spawns.
-    side: server
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if the event handler was attached successfully. Returns
-      false if the specified event could not be found or any parameters were invalid.
+      name: result
+    description: Returns **true** if the event handler was attached successfully. otherwise **false** if the specified event could not be found or any parameters were invalid.
   notes:
   - type: info
     content: You shouldn't re-use the same name for your handler function as the event
       name - if multiple handler functions are used, as this can lead to confusion.
       On the same note, for multiple reasons, it isn't a good idea to export the same
       functions that you use locally as remote event handlers.
   - type: info
-    content: See Event Source Element for a descriptive visualization of the event
+    content: See [Event Source Element](/reference/Event_Source_Element "Event Source Element") for a descriptive visualization of the event
       system handling an event trigger.
   - type: important
-    content: See Script security for how-to prevent cheaters from abusing event system
-      and element data .
+    content: See [Script security](/Script_security "Script security") for how-to prevent cheaters from abusing [event system](/reference/Event_System "Event system").
   - type: important
     content: Anything bound to a specific element will be run before other handlers
       that are bound to something higher in the element tree (like root) This means
-      that "high+10" bound to root won't trigger before "normal" bound directly to
+      that "high+10" bound to root **won't** trigger before "normal" bound directly to
       an element.
   - type: info
     content: Due to the additional set of global variables, the event-trigger specific
@@ -73,4 +70,3 @@ shared:
       the same issues. It is recommended to adapt a good-natured distancing principle
       between code meant to run from local logic in separation to code meant to run
       from remote logic.
-  requires_review: true

functions/Event/cancelEvent.yaml

@@ -1,44 +1,35 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CancelEvent
-client:
+shared:
   name: cancelEvent
-  description: This function is used to stop the automatic internal handling of events,
-    for example this can be used to prevent an item being given to a player when they
-    walk over a pickup, by canceling the [onPickupUse](/wiki/OnPickupUse "OnPickupUse")
+  description: This function is used to stop the automatic internal handling of events
     event.
   parameters: []
-  examples:
-  - path: examples/cancelEvent-2.lua
-    description: This example prevents any damage to a player clientside by makingcancelEventan
-      event handler for theonClientPlayerDamageevent.
-    side: client
   returns:
     values:
     - type: bool
       name: value
-    description: Always returns true .
-  requires_review: true
+    description: Always returns **true**.
+
+client:
+  examples:
+  - path: examples/cancelEvent-2.lua
+    description: This example prevents any damage to a player clientside by making **cancelEvent** an
+      event handler for the [[onClientPlayerDamage]] event.
+
 server:
-  name: cancelEvent
-  description: This function is used to stop the automatic internal handling of events,
-    for example this can be used to prevent an item being given to a player when they
-    walk over a pickup, by canceling the [onPickupUse](/wiki/OnPickupUse "OnPickupUse")
-    event.
   parameters:
   - name: cancel
     type: bool
-    description: MISSING_PARAM_DESC
+    description: True to cancel, false to uncancel.
     default: 'true'
   - name: reason
     type: string
-    description: MISSING_PARAM_DESC
+    description: The reason for cancelling the event.
     default: '""'
   examples:
   - path: examples/cancelEvent-1.lua
     description: This example stops the player from entering a vehicle.
-    side: server
   returns:
     values:
     - type: bool
-      name: value
-    description: Always returns true .
-  requires_review: true
+      name: result
+    description: Returns **true**, otherwise **false** if parameters are invalid.

functions/Event/cancelLatentEvent.yaml

@@ -1,46 +1,37 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CancelLatentEvent
-client:
+shared:
   name: cancelLatentEvent
   description: Stops a latent event from completing
   parameters:
   - name: handle
     type: int
-    description: A handle previous got from getLatentEventHandles .
+    description: A handle previous got from [[getLatentEventHandles]].
   examples:
   - path: examples/cancelLatentEvent-1.lua
     description: ''
-    side: client
-  - path: examples/cancelLatentEvent-4.lua
-    description: ''
-    side: client
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns a true if the latent event was successfully cancelled, or
-      false if it was not
-  requires_review: true
+      name: result
+    description: Returns a **true** if the latent event was successfully cancelled, otherwise **false**.
+
 server:
-  name: cancelLatentEvent
-  description: Stops a latent event from completing
   parameters:
   - name: thePlayer
     type: player
     description: The player who is receiving the event.
   - name: handle
     type: int
-    description: A handle previous got from getLatentEventHandles .
+    description: A handle previous got from [[getLatentEventHandles]].
   examples:
-  - path: examples/cancelLatentEvent-2.lua
-    description: ''
-    side: server
   - path: examples/cancelLatentEvent-3.lua
-    description: ''
-    side: server
+    description: "Cancel all my triggerLatentClientEvent's"
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns a true if the latent event was successfully cancelled, or
-      false if it was not
-  requires_review: true
+      name: result
+    description: Returns a **true** if the latent event was successfully cancelled, otherwise **false**.
+
+client:
+  examples:
+  - path: examples/cancelLatentEvent-2.lua
+    description: "Cancel all my triggerLatentServerEvent's"

functions/Event/examples/addEvent-1.lua

@@ -1,10 +1,11 @@
 -- Add a new event called onSpecialEvent
 addEvent ( "onSpecialEvent", true )
-
 -- Define our handler function, that takes a "text" parameter and outputs it to the chatbox
 function specialEventHandler ( text )
 	outputChatBox ( text )
 end
-
 -- Add it as a handler for our event
-addEventHandler ( "onSpecialEvent", root, specialEventHandler )
+addEventHandler ( "onSpecialEvent", root, specialEventHandler )
+-- You can then trigger this event later on using:
+triggerEvent ( "onSpecialEvent", root, "test" )
+-- This will cause the handler to be triggered, so "test" will be output to the chatbox.

functions/Event/examples/addEventHandler-1.lua

@@ -5,5 +5,4 @@ function onPlayerSpawnHandler ( )
 	-- output in the chat box that they've spawned
 	outputChatBox ( playerName .. " has spawned!" )
 end
-
 addEventHandler( "onPlayerSpawn", root, onPlayerSpawnHandler ) -- root is a predefined global variable for getRootElement()

functions/Event/examples/cancelEvent-1.lua

@@ -1,4 +1,4 @@
 function onVehicleStartEnter()
-   cancelEvent()
+    cancelEvent()
 end
 addEventHandler("onVehicleStartEnter", root, onVehicleStartEnter)

functions/Event/examples/cancelLatentEvent-1.lua

@@ -1,14 +1,20 @@
--- Cancel triggerLatentServerEvent directly after execution.
+-- *****************************************************************************
+-- CLIENT CODE
 addCommandHandler("cancelLatentEvent",
 function ()
 	triggerLatentServerEvent("exampleEvent",3000,false,localPlayer)
-
-	-- Get all your active handles, when you executed the command: /cancelLatentEvent
 	local handles = getLatentEventHandles() -- Returns a table.
-
 	local handle = handles[#handles] -- Get the latest handle.
 
 	if cancelLatentEvent(handle) then -- Cancel it!
 		outputChatBox("Successfully cancelled!",0,200,0)
 	end
+end)
+
+-- *****************************************************************************
+-- SERVER CODE
+addEvent("exampleEvent",true)
+addEventHandler("exampleEvent",root,
+function ()
+	outputChatBox("Warning! The triggerLatentServerEvent wasn't cancelled!",client,255,0,0) -- warn the user.
 end)

functions/Event/examples/cancelLatentEvent-2.lua

@@ -1,5 +1,9 @@
-addEvent("exampleEvent",true)
-addEventHandler("exampleEvent",root,
-function ()
-	outputChatBox("Warning! The triggerLatentServerEvent wasn't cancelled!",client,255,0,0) -- warn the user.
+addCommandHandler("cancelLatentEvents",
+function (player)
+	local handles = getLatentEventHandles (player) -- Returns a table. 
+
+	for index=1,#handles do -- Loop through the table.
+		local handle = handles[index]
+		cancelLatentEvent(player,handle) -- Cancel it!
+	end
 end)

functions/Event/examples/cancelLatentEvent-3.lua

@@ -1,12 +1,9 @@
--- Cancel all my triggerLatentClientEvent's.
 addCommandHandler("cancelLatentEvents",
-function (player)
-
-	-- Get all active handles from the player that executed the command: /cancelLatentEvents
-	local handles = getLatentEventHandles (player) -- Returns a table. 
+function ()
+	local handles = getLatentEventHandles () -- Returns a table. 
 
 	for index=1,#handles do -- Loop through the table.
-		local handle = handles[index]
-		cancelLatentEvent(player,handle) -- Cancel it!
+		local handle = handles[index] 
+		cancelLatentEvent(handle) -- Cancel it!
 	end
 end)

functions/Event/examples/getCancelReason-1.lua

@@ -1,4 +1,3 @@
--- call 'stopVehicleEntry' whenever hunterPlayer is about to enter a vehicle:
 function stopVehicleEntry ( theplayer, seat, jacked )
    cancelEvent (true, "You can't enter a vehicle during war.") -- stop the event from occuring and tell the player the reason.
    outputConsole("We told "..getPlayerName(theplayer).." : "..getCancelReason()) --Now tell everyone what the player tried to do

functions/Event/examples/getLatentEventHandles-1.lua

@@ -1,7 +1,6 @@
--- CLIENT SIDE:
-
+-- *****************************************************************************
+-- CLIENT CODE
 local lastTriggerd = false 
-
 addCommandHandler("trigger",function()
 	local triggers = getLatentEventHandles() -- get all latent events
 	if triggers[lastTriggerd] then -- you can use (getLatentEventStatus) too!
@@ -12,8 +11,8 @@ addCommandHandler("trigger",function()
 	lastTriggerd = #getLatentEventHandles() -- set the lastTriggerd with the id for last event triggerd
 end)
 
--- SERVER SIDE:
-
+-- *****************************************************************************
+-- SERVER CODE
 addEvent("LatentEventsCheck",true)
 addEventHandler("LatentEventsCheck",root,function (thePlayer)
 	outputChatBox("Latent trigger done from: " .. getPlayerName(thePlayer), root,math.random(255),0,0) 

functions/Event/examples/triggerClientEvent-1.lua

@@ -1,3 +1,12 @@
+-- *****************************************************************************
+-- SERVER CODE
+ greetingCommand ( playerSource, commandName )
+    triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
+end
+addCommandHandler ( "greet", greetingCommand )
+
+-- *****************************************************************************
+-- CLIENT CODE
 function greetingHandler ( message )
     outputChatBox ( "The server says: " .. message )
 end