Improvements

Author: omar-o22

functions/Event/addEvent.yaml

@@ -1,4 +1,3 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/AddEvent
 shared:
   name: addEvent
   description: This function allows you to register a custom [event](/reference/Event_System "Event").
@@ -11,14 +10,13 @@ shared:
   - name: allowRemoteTrigger
     type: bool
     description: A boolean specifying whether this event can be called remotely using
-      [triggerClientEvent](/reference/triggerClientEvent "TriggerClientEvent") / [triggerServerEvent](/reference/triggerServerEvent "TriggerServerEvent") or not.
+      [[triggerClientEvent]] / [[triggerServerEvent]] or not.
     default: 'false'
   examples:
   - path: examples/addEvent-1.lua
-    description: This example will define a new event calledonSpecialEvent.
+    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.
+      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,4 +1,3 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/AddEventHandler
 shared:
   name: addEventHandler
   description: This function will add an [event](/reference/Event_System "Event System") handler. An
@@ -32,24 +31,18 @@ shared:
     default: 'true'
   - name: priority
     type: string
-    description: | 
-      A string representing the trigger order priority relative to other event handlers of the same name. Possible values are:
-
-      "high"
-      "normal"
-      "low"
+    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
@@ -60,8 +53,7 @@ shared:
     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](/Script_security "Script security") for how-to prevent cheaters from abusing [event system](/reference/Event_System "Event system")
-      and [element data](/reference/Element_data "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

functions/Event/cancelEvent.yaml

@@ -1,29 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CancelEvent
 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](/reference/onPickupUse "OnPickupUse")
+  description: This function is used to stop the automatic internal handling of events
     event.
   parameters: []
   returns:
     values:
     - type: bool
       name: value
-    description: Always returns 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](/reference/onClientPlayerDamage "OnClientPlayerDamage") event.
+      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
@@ -39,5 +31,5 @@ server:
   returns:
     values:
     - type: bool
-      name: value
-    description: Always returns true .
+      name: result
+    description: Returns **true**, otherwise **false** if parameters are invalid.

functions/Event/cancelLatentEvent.yaml

@@ -1,45 +1,37 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CancelLatentEvent
 shared:
   name: cancelLatentEvent
   description: Stops a latent event from completing
   parameters:
   - name: handle
     type: int
-    description: A handle previous got from [getLatentEventHandles](/reference/getLatentEventHandles "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
+      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](/reference/getLatentEventHandles "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
+      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,14 +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 )
-
 -- 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/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)