Skip to content

Commit 2edde00

Browse files
committed
add syntax and return
1 parent a2da7ac commit 2edde00

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

functions/Element/setElementHealth.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ shared: &shared
1515
- *450:* white steam 100%, black smoke 50%
1616
- *250:* white steam 0%, black smoke 100%
1717
- *249:* fire with big black smoke
18+
parameters:
19+
- name: 'theElement'
20+
type: 'element'
21+
description: 'The player, ped, vehicle or object element whose health you want to set.'
22+
- name: 'newHealth'
23+
type: 'float'
24+
description: 'A float indicating the new health to set for the element.'
1825
returns:
1926
description: |
2027
Returns *true* if the new health was set successfully, *false* otherwise.

web/resources/function.html

+37
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,43 @@ <h1 style="border-bottom: 3px solid #FF7F00; margin-bottom: 0.1em;">{{ function.
1313
<p style="margin-top: 1em;">{{ function['server'].description }}</p>
1414
{% endif %}
1515

16+
<!-- Syntax -->
17+
{% for type_name in ['shared', 'client', 'server'] %}
18+
{% if function[type_name] %}
19+
{% if function[type_name].parameters %}
20+
<h2>Syntax</h2>
21+
<p>{{ function[type_name].parameters.description }}</p>
22+
23+
<pre><code class="language-lua"> {{ function[type_name].name }}(todo :mreow:)</code></pre>
24+
25+
<ul>
26+
{% for item in function[type_name].parameters %}
27+
<li style="margin-bottom: 1em;">
28+
<p>{{ item.name }} : {{ item.description }}</p>
29+
</li>
30+
{% endfor %}
31+
</ul>
32+
{% endif %}
33+
{% endif %}
34+
{% endfor %}
35+
36+
<!-- Returns -->
37+
{% for type_name in ['shared', 'client', 'server'] %}
38+
{% if function[type_name] %}
39+
{% if function[type_name].returns %}
40+
<h2>Returns</h2>
41+
<p>{{ function[type_name].returns.description }}</p>
42+
<ul>
43+
{% for item in function[type_name].returns["values"] %}
44+
<li style="margin-bottom: 1em;">
45+
<p>{{ item.type }} {{ item.name }}</p>
46+
</li>
47+
{% endfor %}
48+
</ul>
49+
{% endif %}
50+
{% endif %}
51+
{% endfor %}
52+
1653
<!-- Preview Images -->
1754
{% for type_name in ['shared', 'client', 'server'] %}
1855
{% if function[type_name] %}

0 commit comments

Comments
 (0)