Merge branch 'main' of github.com:multitheftauto/mtasa-wiki

Author: Fernando-A-Rocha

functions/Element/getElementHealth.yaml

@@ -13,13 +13,6 @@ shared: &shared
     values:
       - type: 'float'
         name: 'health'
-  examples:
-    - path: 'examples/getElementHealth-1.lua'
-      description: |
-        This example outputs the player and vehicle health (if player is in a vehicle) to chatbox using /health command:
-    - path: 'examples/getElementHealth-2.lua'
-      description: |
-        This example heals the player to 100 HP using /healme command if he's at 50 HP or lower:
   issues:
     - id: 3791
       description: 'setPedArmor and setElementHealth synchronization problems from Client to Server'
@@ -32,4 +25,11 @@ server:
   <<: *shared
 
 client:
-  <<: *shared
+  <<: *shared
+  examples:
+    - path: 'examples/getElementHealth-1.lua'
+      description: |
+        This example outputs the player and vehicle health (if player is in a vehicle) to chatbox using /health command:
+    - path: 'examples/getElementHealth-2.lua'
+      description: |
+        This example heals the player to 100 HP using /healme command if he's at 50 HP or lower:

functions/Element/setElementHealth.yaml

@@ -15,19 +15,19 @@ shared: &shared
       - *450:* white steam 100%, black smoke 50%
       - *250:* white steam 0%, black smoke 100%
       - *249:* fire with big black smoke
+  parameters:
+    - name: 'theElement'
+      type: 'element'
+      description: 'The player, ped, vehicle or object element whose health you want to set.'
+    - name: 'newHealth'
+      type: 'float'
+      description: 'A float indicating the new health to set for the element.'
   returns:
     description: |
       Returns *true* if the new health was set successfully, *false* otherwise.
     values:
       - type: 'bool'
         name: 'result'
-  examples:
-    - path: 'examples/setElementHealth-1.lua'
-      description: |
-        This example changes the player health to new specified value using /sethealth <value> command:
-    - path: 'examples/setElementHealth-2.lua'
-      description: |
-        This example heals the player vehicle using the command /repairvehicle if it's below 1000 HP:
   issues:
     - id: 3807
       description: 'hpbar on hud is not compatible visually with MAX_HEALTH stat'
@@ -42,6 +42,14 @@ shared: &shared
 
 server:
   <<: *shared
+  examples:
+    - path: 'examples/setElementHealth-1.lua'
+      description: |
+        This example changes the player health to new specified value using /sethealth <value> command:
 
 client:
-  <<: *shared
+  <<: *shared
+  examples:
+    - path: 'examples/setElementHealth-2.lua'
+      description: |
+        This example heals the player vehicle using the command /repairvehicle if it's below 1000 HP:

web/resources/function.html

@@ -13,6 +13,43 @@ <h1 style="border-bottom: 3px solid #FF7F00; margin-bottom: 0.1em;">{{ function.
     <p style="margin-top: 1em;">{{ function['server'].description }}</p>
 {% endif %}
 
+<!-- Syntax -->
+{% for type_name in ['shared', 'client', 'server'] %}
+{% if function[type_name] %}
+    {% if function[type_name].parameters %}
+        <h2>Syntax</h2>
+        <p>{{ function[type_name].parameters.description }}</p>
+
+        <pre><code class="language-lua"> {{ function[type_name].name }}(todo :mreow:)</code></pre>
+
+        <ul>
+            {% for item in function[type_name].parameters %}
+                <li style="margin-bottom: 1em;">
+                    <p>{{ item.name }} : {{ item.description }}</p>
+                </li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+{% endif %}
+{% endfor %}
+
+<!-- Returns -->
+{% for type_name in ['shared', 'client', 'server'] %}
+{% if function[type_name] %}
+    {% if function[type_name].returns %}
+        <h2>Returns</h2>
+        <p>{{ function[type_name].returns.description }}</p>
+        <ul>
+            {% for item in function[type_name].returns["values"] %}
+                <li style="margin-bottom: 1em;">
+                    <p>{{ item.type }} {{ item.name }}</p>
+                </li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+{% endif %}
+{% endfor %}
+
 <!-- Preview Images -->
 {% for type_name in ['shared', 'client', 'server'] %}
     {% if function[type_name] %}