Skip to content

Commit 58732f9

Browse files
Fernando-A-RochaFernando-A-Rocha
committed
Add function oop syntax
1 parent 6558c50 commit 58732f9

7 files changed

+36
-11
lines changed

‎functions/Element/getElementHealth.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
shared: &shared
22
name: 'getElementHealth'
33
oop:
4-
entity: player
4+
entity: element
55
method: getHealth
66
variable: health
77
pair: 'setElementHealth'

‎functions/Element/getElementPosition.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
shared: &shared
22
name: 'getElementPosition'
33
oop:
4-
entity: player
4+
entity: element
55
method: getPosition
66
variable: position
77
pair: 'setElementPosition'

‎functions/Element/setElementHealth.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
shared: &shared
22
name: 'setElementHealth'
33
oop:
4-
entity: player
4+
entity: element
55
method: setHealth
66
variable: health
77
pair: 'getElementHealth'

‎functions/Element/setElementPosition.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
shared: &shared
22
name: 'setElementPosition'
33
oop:
4-
entity: player
4+
entity: element
55
method: setPosition
66
variable: position
77
pair: 'getElementPosition'

‎web/resources/article.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<div style="color: #fff; font-size: 1em;">
44
Article: <strong>{{ article.title }}</strong>
55
<a style="margin-left: 2px;" href="https://github.com/multitheftauto/mtasa-wiki/blob/main/CONTRIBUTING.md" rel="noopener" target="_blank">
6-
<i class="fa-solid fa-pen-to-square"></i>
6+
<i class="fa-regular fa-pen-to-square"></i>
77
</a>
88
</div>
99
<div style="color: #b5b5b5; font-size: 0.8em; margin-top: 0.5em;">

‎web/resources/function.html

+30-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<div class="function-type-title" style="color: {{type_colors[function.type_name]}};">{{ function.type_name|capitalize }} function</div>
1010
<h1 style="border-bottom: 3px solid {{type_colors[function.type_name]}}; padding-bottom: 0.2em;">
1111
<span {% if function.disabled %}style="text-decoration: line-through;"{% endif %}>{{ function.name }}</span>
12-
<a class="small-fs" href="#" onclick="copyText('{{ function.name }}', 'copy-{{ function.name }}')"><i class="fa-solid fa-copy"></i> <span id="copy-{{ function.name }}">Copy</span> </a>
12+
<a class="small-fs" href="#" onclick="copyText('{{ function.name }}', 'copy-{{ function.name }}')"><i class="fa-regular fa-copy"></i> <span id="copy-{{ function.name }}">Copy</span> </a>
1313
</h1>
1414

1515
<!-- Disabled Warning -->
@@ -97,7 +97,7 @@ <h3>Pair: <a href="/{{ function[type_name].pair }}">{{ function[type_name].pair
9797
<h2 id="syntax">Syntax <a href="#syntax"><i class="fa-solid fa-link"></i></a></h2>
9898
{% if function.syntaxes.single %}
9999
{% set syntax = function.syntaxes.single %}
100-
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px;">
100+
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ info_color }}; border-radius: 5px;">
101101

102102
<pre><code class="language-lua">{{ syntax.returns.values_type or 'void' }} {{ function.name }} ( {% for parameter in syntax.arguments.required %}{{ parameter.type }} {{ parameter.name }}{% if not loop.last %}, {% endif %}{% endfor %}{% for parameter in syntax.arguments.optional %}{% if syntax.arguments.required %}, {% endif %}{% if loop.first %}[ {% endif %}{{ parameter.type }} {{ parameter.name }} = {{ parameter.default }}{% if loop.last %} ]{% endif %}{% endfor %} )</code></pre>
103103

@@ -129,12 +129,11 @@ <h3>Returns:</h3>
129129
{% endfor %}
130130
</ul>
131131

132-
</div>
133132
{% else %}
134133
{% for type_name in ['server', 'client'] %}
135134
{% set syntax = function.syntaxes[type_name] %}
136135
{% if syntax %}
137-
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ type_colors[type_name] }}; border-radius: 5px;">
136+
<div style="padding-left: 1em; margin-top: 1em; border: 1px solid {{ type_colors[type_name] }}; border-radius: 5px;">
138137
<h3 style="color: {{ type_colors[type_name] }};">{{ type_name|capitalize }}:</h3>
139138

140139
<pre><code class="language-lua">{{ syntax.returns.values_type or 'void' }} {{ function.name }} ( {% for parameter in syntax.arguments.required %}{{ parameter.type }} {{ parameter.name }}{% if not loop.last %}, {% endif %}{% endfor %}{% for parameter in syntax.arguments.optional %}{% if syntax.arguments.required %}, {% endif %}{% if loop.first %}[ {% endif %}{{ parameter.type }} {{ parameter.name }} = {{ parameter.default }}{% if loop.last %} ]{% endif %}{% endfor %} )</code></pre>
@@ -166,10 +165,36 @@ <h4>Returns:</h4>
166165
<li>{{ item.type }} {{ item.name }}</li>
167166
{% endfor %}
168167
</ul>
169-
</div>
170168
{% endif %}
171169
{% endfor %}
172170
{% endif %}
171+
<!-- OOP Syntax -->
172+
{% for type_name in ['shared', 'client', 'server'] %}
173+
{% if function[type_name] %}
174+
{% if function[type_name].oop %}
175+
<h3>OOP syntax: <a href="/OOP_Introduction" ><i class="fa-regular fa-circle-question"></i></a></h3>
176+
{% if function[type_name].oop.note %}
177+
<p>{{ function[type_name].oop.note }}</p>
178+
{% endif %}
179+
<!-- Method or constructor -->
180+
<ul>
181+
{% if function[type_name].oop.constructor %}
182+
<li><strong>Constructor:</strong> <a href="/{{ function[type_name].oop.constructor|lower }}">{{ function[type_name].oop.constructor|capitalize }}</a>(...)</li>
183+
{% else %}
184+
{% if function[type_name].oop.static %}
185+
<li><strong>Method:</strong> <a href="/{{ function[type_name].oop.entity|capitalize }}">{{ function[type_name].oop.entity|capitalize }}</a>.{{ function[type_name].oop.method }}(...)</li>
186+
{% else %}
187+
<li><strong>Method:</strong> <a href="/{{ function[type_name].oop.entity|lower }}">{{ function[type_name].oop.entity }}</a>:{{ function[type_name].oop.method }}(...)</li>
188+
{% endif %}
189+
{% if function[type_name].oop.variable %}
190+
<li><strong>Variable:</strong> <a href="/{{ function[type_name].oop.entity|lower }}">{{ function[type_name].oop.entity }}</a>.{{ function[type_name].oop.variable }}</li>
191+
{% endif %}
192+
{% endif %}
193+
</ul>
194+
{% endif %}
195+
{% endif %}
196+
{% endfor %}
197+
</div>
173198

174199
<!-- Preview Images -->
175200
{% for type_name in ['shared', 'client', 'server'] %}

‎web/resources/layout.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css" integrity="sha512-Evv84Mr4kqVGRNSgIGL/F/aIDqQb7xQ2vcrdIwxfjThSH8CSR7PBEakCr51Ck+w+/U6swU2Im1vVX0SVk9ABhg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
2626

2727
<!-- Custom CSS -->
28-
<link rel="stylesheet" href="/assets/style.css?v=1.5">
28+
<link rel="stylesheet" href="/assets/style.css?v=1.6">
2929
</head>
3030
<body>
3131
<nav id="mta-global-navbar">

0 commit comments

Comments
 (0)