Fixes for last commit (Event functions)

Author: FileEX

functions/Event/addEventHandler.yaml

@@ -16,7 +16,7 @@ shared:
       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).
-  - name: handlerFunction
+  - name: handlerFunction()
     type: function
     description: The handler function you wish to call when the event is triggered.
       This function will be passed all of the event's parameters as arguments, but
@@ -53,8 +53,8 @@ shared:
       - See [Event Source Element](/reference/Event_Source_Element "Event Source Element") for a descriptive visualization of the event
       system handling an event trigger.
       - Due to the additional set of global variables, the event-trigger specific
-      variables it is NOT a good idea to use the same function locally as well as
-      directly as an event handler . Event handlers often make use of the source element
+      variables it is **NOT** a good idea to use the same function locally as well as
+      directly as an event handler. Event handlers often make use of the source element
       variable which would often find no use in generic functions. Inside of server-side
       remote event handlers it is important to add protections against exploits due
       to unexpected client event triggers or network-based load situations while generic
@@ -64,8 +64,8 @@ shared:
       from remote logic.
   - type: important
     content: |
-      - See [Script security](/Script_security "Script security") for how-to prevent cheaters from abusing [event system](/reference/Event_System "Event system").
+      - See [Script security](/articles/script-security "Script security") for how-to prevent cheaters from abusing [event system](/reference/Event_System "Event system").
       - 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 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
       an element.

functions/Event/cancelEvent.yaml

@@ -1,4 +1,4 @@
-shared:
+shared: &shared
   name: cancelEvent
   description: This function is used to stop the automatic internal handling of events
     event.
@@ -8,14 +8,19 @@ shared:
     - type: bool
       name: result
     description: Always returns **true**.
+  notes:
+    - type: info
+      content: Not every event can be cancelled, so make sure the event is cancellable according to the documentation.
 
 client:
+  <<: *shared
   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:
+  <<: *shared
   parameters:
   - name: cancel
     type: bool
@@ -27,9 +32,4 @@ server:
     default: '""'
   examples:
   - path: examples/cancelEvent-1.lua
-    description: This example stops the player from entering a vehicle.
-  returns:
-    values:
-    - type: bool
-      name: result
-    description: Returns **true**, otherwise **false** if parameters are invalid.
+    description: This example stops the player from entering a vehicle.

functions/Event/cancelLatentEvent.yaml

@@ -1,37 +1,31 @@
-shared:
+shared: &shared
   name: cancelLatentEvent
-  description: Stops a latent event from completing
-  parameters:
-  - name: handle
-    type: int
-    description: A handle previous got from [[getLatentEventHandles]].
-  examples:
-  - path: examples/cancelLatentEvent-1.lua
-    description: ''
-  returns:
-    values:
-    - type: bool
-      name: result
-    description: Returns a **true** if the latent event was successfully cancelled, otherwise **false**.
-
-server:
+  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]].
-  examples:
-  - path: examples/cancelLatentEvent-3.lua
-    description: "Cancel all my triggerLatentClientEvent's"
   returns:
     values:
     - type: bool
       name: result
     description: Returns a **true** if the latent event was successfully cancelled, otherwise **false**.
 
-client:
+server:
+  <<: *shared
   examples:
   - path: examples/cancelLatentEvent-2.lua
-    description: "Cancel all my triggerLatentServerEvent's"
+    description: "Cancel all my triggerLatentClientEvent's."
+
+client:
+  <<: *shared
+  ignore_parameters:
+    - thePlayer
+  examples:
+  - path: examples/cancelLatentEvent-1.lua
+    description: ''
+  - path: examples/cancelLatentEvent-3.lua
+    description: "Cancel all my triggerLatentServerEvent's."

functions/Event/getCancelReason.yaml

@@ -9,4 +9,4 @@ server:
     values:
     - type: string
       name: result
-    description: Returns the reason that was given with [[cancelEvent]]
+    description: Returns the reason that was given with [[cancelEvent]].

functions/Event/getEventHandlers.yaml

@@ -1,4 +1,4 @@
-shared:
+shared: &shared
   name: getEventHandlers
   description: This function gets the attached functions from the event and attached
     element from current lua script.
@@ -14,12 +14,18 @@ shared:
     - type: table
       name: result
     description: Returns [[table]] with attached functions, otherwise empty [[table]].
+  notes:
+    - type: important
+      content: This function only checks the current script.
 
 server:
+  <<: *shared
   examples:
     - path: examples/getEventHandlers-1.lua
       description: ''
+
 client:
+  <<: *shared
   examples:
     - path: examples/getEventHandlers-2.lua
       description: This example removes all [[onClientMarkerHit]] event.

functions/Event/getLatentEventHandles.yaml

@@ -1,23 +1,16 @@
-shared:
+shared: &shared
   name: getLatentEventHandles
-  description: Gets the currently queued latent events. The last one in the table
+  description: Gets the currently queued latent events. The last one in the [[table]]
     is always the latest event queued.
   parameters: []
-  examples:
-  - path: examples/getLatentEventHandles-1.lua
-    description: This command is triggering an latent-event to server, and if you
-      write the command again and the trigger still didn't end then you have to wait.
   returns:
     values:
     - type: table
       name: result
     description: Returns a [[table]] of handles, otherwise **false** if invalid arguments were passed.
 
 server:
-  name: getLatentEventHandles
-  description: Gets the currently queued latent events. The last one in the table
-    is always the latest event queued. Each returned handle can be used with [getLatentEventStatus](/wiki/GetLatentEventStatus
-    "GetLatentEventStatus") or [cancelLatentEvent](/wiki/CancelLatentEvent "CancelLatentEvent")
+  <<: *shared
   parameters:
   - name: thePlayer
     type: player
@@ -27,3 +20,12 @@ server:
     - type: table
       name: result
     description: Returns a [[table]] of handles, otherwise **false** if invalid arguments were passed.
+
+client:
+  <<: *shared
+  ignore_parameters:
+    - thePlayer
+  examples:
+  - path: examples/getLatentEventHandles-1.lua
+    description: This command is triggering an latent-event to server, and if you
+      write the command again and the trigger still didn't end then you have to wait.

functions/Event/getLatentEventStatus.yaml

@@ -1,18 +1,4 @@
-shared:
-  name: getLatentEventStatus
-  description: Gets the status of one queued latent event.
-  parameters:
-  - name: handle
-    type: int
-    description: A handle previous got from [[getLatentEventHandles]].
-  returns:
-    values:
-    - type: table
-      name: result
-    description: 'Returns a [[table]] with the following info, otherwise **false** if invalid arguments
-      were passed:'
-
-server:
+shared: &shared
   name: getLatentEventStatus
   description: Gets the status of one queued latent event.
   parameters:
@@ -22,15 +8,18 @@ server:
   - name: handle
     type: int
     description: A handle previous got from [[getLatentEventHandles]].
-  examples: []
   returns:
     values:
     - type: table
       name: result
-    description: 'Returns a [[table]] with the following info, otherwise **false** if invalid arguments were passed:'
-      
+    description: 'Returns a [[table]] with the following info, otherwise **false** if invalid arguments
+      were passed.'
+
 client:
+  <<: *shared
+  ignore_parameters:
+    - thePlayer
   examples:
   - path: examples/getLatentEventStatus-1.lua
     description: The example starts a latent event and outputs the status of the transfer
-      to the client console
+      to the client console.

functions/Event/removeEventHandler.yaml

@@ -1,4 +1,4 @@
-shared:
+shared: &shared
   name: removeEventHandler
   description: This functions removes a handler function from an [event](/reference/Event_System
     "Event"), so that the function is not called anymore when the event is triggered.
@@ -11,7 +11,7 @@ shared:
   - name: attachedTo
     type: element
     description: The [[element]] the handler was attached to.
-  - name: functionVar
+  - name: functionVar()
     type: function
     description: The handler function that was attached.
   returns:
@@ -23,6 +23,7 @@ shared:
       were passed.
 
 client:
+  <<: *shared
   examples:
   - path: examples/removeEventHandler-1.lua
     description: This example shows how to toggle a message on/off a screen with a

functions/Event/triggerClientEvent.yaml

@@ -3,21 +3,13 @@ server:
   description: | 
     This function triggers an event previously registered on a client.
     This is the primary means of passing information between the server and the client.
-    Clients have a similar [triggerServerEvent](/reference/triggerServerEvent "TriggerServerEvent")
-    function that can do the reverse. You can treat this function as if it was an
-    asynchronous function call, using [triggerServerEvent](/reference/triggerServerEvent
-    "TriggerServerEvent") to pass back any returned information if necessary.
-
-    Almost any data types can be passed as expected, including [elements](/reference/Element "Element") and complex nested [tables](/reference/table "Table"). Non-element MTA data types like [xmlNodes](/reference/xmlnode "XML Node") or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.
-
-    Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.
-    
-    Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. It is marginally more efficient to pass one large event than two smaller ones.
+    Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an
+    asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.
   parameters:
   - name: sendTo
     type: 'table/element'
     description: The event will be sent to all [players](/reference/player "Player") that are children of the specified element. By default this is the [root](/reference/root "Root") element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
-    default: getRootElement(
+    default: getRootElement()
   - name: name
     type: string
     description: The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
@@ -44,17 +36,20 @@ server:
       arguments were specified.
   notes:
   - type: info
-    content: It is marginally more efficient to pass one large event than two smaller
-      ones.
+    content: |
+      - Almost any data types can be passed as expected, including [elements](/reference/Element "Element") and complex nested [tables](/reference/table "Tables"). Non-element MTA data types like [xmlNodes](/reference/xmlnode "XML Node") or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client. **Elements of the [Vector](/reference/Vector "Vector") or [Matrix](/reference/Matrix "Matrix") classes cannot be passed!**
+      - Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.
+      - Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. It is marginally more efficient to pass one large event than two smaller ones.
   - type: important
     content: |
-      - Non-element MTA data types like [xmlNodes](/reference/xmlnode "XML Node") or resource pointers will not
-      be able to be passed as they do not necessarily have a valid representation
-      on the client.
-      - To save client CPU, you should avoid setting theElement to the [root](/reference/root "Root") element
+      To save client CPU, you should avoid setting theElement to the [root] element
       where possible - it should be used as a last resort (rather questionable thing
-      to do, limited to very specific tasks, if any). Using target element ( [player](/reference/player "Player")
+      to do, limited to very specific tasks, if any). Using target element [[player]]
       who should receive event, if expected to be delivered to particular one) is
-      preferred and highly advisable. [resourceRoot](/reference/resourceRoot "ResourceRoot") can also be used as alternative
-      choice, if [addEventHandler](/reference/addEventHandler "addEventHandler") is bound to [root](/reference/root "Root") element, or to [resourceRoot](/reference/resourceRoot "ResourceRoot") when
-      there is need to restrict event to single certain resource.
+      preferred and highly advisable. [[resourceRoot]] can also be used as alternative
+      choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when
+      there is need to restrict event to single certain resource.
+  meta:
+    - changelog:
+        - version: 1.3.0-9.04570
+          description: Added option to use a list of player elements for the **sendTo** argument.

functions/Event/triggerEvent.yaml

@@ -4,11 +4,12 @@ shared:
     a specific [[element]] in the [element tree](/reference/Element_tree
     "Element tree"). See [event system](/reference/Event_System "Event System") for more
     information on how the event system works.
-    You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an onFlagCapture event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have onPlayerKill as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.
+
+    You can use the value returned from this function to determine if the event was cancelled by one of the event handlers. You should determine what your response (if any) to this should be based on the event's purpose. Generally, cancelling an event should prevent any further code being run that is dependent on whatever triggered that event. For example, if you have an `onFlagCapture` event, cancelling it would be expected to prevent the flag being able to be captured. Similarly, if you have `onPlayerKill` as an event you trigger, canceling it would either be expected to prevent the player being killed from dying or at least prevent the player from getting a score for it.
   parameters:
   - name: eventName
     type: string
-    description: The name of the event you wish to trigger
+    description: The name of the event you wish to trigger.
   - name: baseElement
     type: element
     description: The element you wish to trigger the event on. See [event system](/reference/Event_System "Event System") for