Improvements

Author: omar-o22

functions/Event/addEventHandler.yaml

@@ -12,7 +12,7 @@ shared:
       and numerals)**'
   - name: attachedTo
     type: element
-    description: The [element](/reference/Element "Element") you wish to attach the handler to. The handler will only
+    description: The [[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).
@@ -45,22 +45,14 @@ shared:
     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
+    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](/reference/Event_Source_Element "Event Source Element") for a descriptive visualization of the event
+      - 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").
-  - 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
-      an element.
-  - type: info
-    content: Due to the additional set of global variables, the event-trigger specific
+      - 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
       variable which would often find no use in generic functions. Inside of server-side
@@ -70,3 +62,10 @@ 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.
+  - type: important
+    content: |
+      - See [Script security](/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
+      an element.

functions/Event/cancelEvent.yaml

@@ -6,7 +6,7 @@ shared:
   returns:
     values:
     - type: bool
-      name: value
+      name: result
     description: Always returns **true**.
 
 client:

functions/Event/examples/addEvent-1.lua

@@ -1,11 +1,6 @@
--- 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.
+addEventHandler ( "onSpecialEvent", root, specialEventHandler )

functions/Event/getEventHandlers.yaml

@@ -8,12 +8,12 @@ shared:
     description: The name of the event.
   - name: attachedTo
     type: element
-    description: The [element](/reference/Element "Element") attached to.
+    description: The [[element]] attached to.
   returns:
     values:
     - type: table
       name: result
-    description: Returns **table** with attached functions, otherwise **empty table**.
+    description: Returns [[table]] with attached functions, otherwise empty [[table]].
 
 server:
   examples:

functions/Event/getLatentEventHandles.yaml

@@ -11,7 +11,7 @@ shared:
     values:
     - type: table
       name: result
-    description: Returns a **table** of handles, otherwise **false** if invalid arguments were passed.
+    description: Returns a [[table]] of handles, otherwise **false** if invalid arguments were passed.
 
 server:
   name: getLatentEventHandles
@@ -26,4 +26,4 @@ server:
     values:
     - type: table
       name: result
-    description: Returns a **table** of handles, otherwise **false** if invalid arguments were passed.
+    description: Returns a [[table]] of handles, otherwise **false** if invalid arguments were passed.

functions/Event/getLatentEventStatus.yaml

@@ -9,7 +9,7 @@ shared:
     values:
     - type: table
       name: result
-    description: 'Returns a **table** with the following info, otherwise **false** if invalid arguments
+    description: 'Returns a [[table]] with the following info, otherwise **false** if invalid arguments
       were passed:'
 
 server:
@@ -27,8 +27,7 @@ server:
     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:
   examples:

functions/Event/removeEventHandler.yaml

@@ -10,7 +10,7 @@ shared:
     description: The name of the [event](/reference/Event_System "Event") you want to detach the handler function from.
   - name: attachedTo
     type: element
-    description: The [element](/reference/Element "Element") the handler was attached to.
+    description: The [[element]] the handler was attached to.
   - name: functionVar
     type: function
     description: The handler function that was attached.

functions/Event/triggerClientEvent.yaml

@@ -47,14 +47,14 @@ server:
     content: 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
+    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.
-  - type: important
-    content: 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](/reference/root "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")
       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.
+      there is need to restrict event to single certain resource.

functions/Event/triggerEvent.yaml

@@ -1,7 +1,7 @@
 shared:
   name: triggerEvent
   description: This function will trigger a named [event](/reference/Event_System "Event") on
-    a specific [element](/reference/Element "Element") in the [element tree](/reference/Element_tree
+    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.
@@ -30,10 +30,10 @@ shared:
 
   notes:
   - type: info
-    content: You should avoid triggering events on the [root](/reference/root "Root") element unless you really
+    content: |
+      - You should avoid triggering events on the [root](/reference/root "Root") element unless you really
       need to. Doing this triggers the event on every element in the element tree,
       which is potentially very CPU intensive. Use as specific (i.e. low down the
       tree) element as you can.
-  - type: info
-    content: See [Event Source Element](/reference/Event_Source_Element "Event Source Element") for a descriptive visualization of the event
+      - See [Event Source Element](/reference/Event_Source_Element "Event Source Element") for a descriptive visualization of the event
       system handling an event trigger.

functions/Event/triggerServerEvent.yaml

@@ -41,12 +41,12 @@ client:
     content: It is marginally more efficient to pass one large event than two smaller
       ones.
   - type: important
-    content: 'You should use the global variable [client](/reference/Predefined_variables) server-side instead of passing
+    content: |
+      - You should use the global variable [client](/reference/Predefined_variables) server-side instead of passing
       the localPlayer by parameter or source. Otherwise event faking (passing another
       player instead of the localPlayer ) would be possible. For more information
-      see: [Script security](/Script_security) article.'
-  - type: important
-    content: To save server CPU, you should avoid setting **theElement** to the [root](/reference/root "Root") element
+      see: [Script security](/Script_security) article.
+      - To save server CPU, you should avoid setting **theElement** to the [root](/reference/root "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 localPlayer is preferred
       and highly advisable. [resourceRoot](/reference/resourceRoot "ResourceRoot") can also be used as alternative choice, if