Fix incomplete events

Fernando-A-Rocha · Fernando-A-Rocha · commit 5082e0441ac5 · 2025-06-01T16:38:27.000+01:00
diff --git a/events/Browser/examples/onClientBrowserInputFocusChanged-1.lua b/events/Browser/examples/onClientBrowserInputFocusChanged-1.lua
@@ -0,0 +1,3 @@
+addEventHandler("onClientBrowserInputFocusChanged", root, function(gainedFocus)
+  iprint(source, "gainedFocus:", gainedFocus)
+end)
diff --git a/events/Browser/onClientBrowserInputFocusChanged.yaml b/events/Browser/onClientBrowserInputFocusChanged.yaml
@@ -9,4 +9,7 @@ parameters:
 - name: gainedFocus
   type: bool
   description: true if an input field has been focused, false if it has lost focus.
-examples: []
+examples:
+- path: examples/onClientBrowserInputFocusChanged-1.lua
+  description: ''
+  side: client
diff --git a/events/Input/onClientCursorMove.yaml b/events/Input/onClientCursorMove.yaml
@@ -26,16 +26,15 @@ parameters:
     top of the screen.
 - name: worldX
   type: float
-  description: MISSING_PARAM_DESC
+  description: the 3D in-game world X coordinate that the cursor is pointing at.
 - name: worldY
   type: float
-  description: MISSING_PARAM_DESC
+  description: the 3D in-game world Y coordinate that the cursor is pointing at.
 - name: worldZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: the 3D in-game world Z coordinate that the cursor is pointing at.
 examples:
 - path: examples/onClientCursorMove-1.lua
   description: This example creates a text label at the bottom of the screen which
     displays the mouse position in pixels.
   side: client
-incomplete: true
diff --git a/events/Ped/onClientPedWeaponFire.yaml b/events/Ped/onClientPedWeaponFire.yaml
@@ -18,13 +18,13 @@ parameters:
   description: an int ammount of ammo left for this weapon type in clip.
 - name: hitX
   type: float
-  description: float world coordinates representing a hit point.
+  description: float world X coordinate representing the hit point.
 - name: hitY
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Y coordinate representing the hit point.
 - name: hitZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Z coordinate representing the hit point.
 - name: hitElement
   type: element
   description: an element which was hit by a shot.
@@ -35,4 +35,3 @@ examples:
 notes:
 - type: info
   content: This event is only triggered for peds that are streamed in
-incomplete: true
diff --git a/events/Player/onClientPlayerWeaponFire.yaml b/events/Player/onClientPlayerWeaponFire.yaml
@@ -19,26 +19,26 @@ parameters:
   description: an int amount of ammo left for this weapon type in clip.
 - name: hitX
   type: float
-  description: float world coordinates representing a hit point.
+  description: float world X coordinate representing the hit point.
 - name: hitY
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Y coordinate representing the hit point.
 - name: hitZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Z coordinate representing the hit point.
 - name: hitElement
   type: element
   description: an element which was hit by a shot.
 - name: startX
   type: float
-  description: 'float world coordinates representing the start of the bullet. Note:
+  description: 'float world X coordinate representing the start of the bullet. Note:
     This is not the gun muzzle.'
 - name: startY
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Y coordinate representing the start of the bullet.
 - name: startZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Z coordinate representing the start of the bullet.
 examples:
 - path: examples/onClientPlayerWeaponFire-1.lua
   description: This example implements custom gunshot sounds.
@@ -56,4 +56,3 @@ notes:
 - type: info
   content: This does not trigger for any player's melee weapons or for remote player's
     projectile weapons or cameras
-incomplete: true
diff --git a/events/Player/onPlayerWeaponFire.yaml b/events/Player/onPlayerWeaponFire.yaml
@@ -7,32 +7,32 @@ source_element:
 description: This event is called when a player fires a weapon. This does not trigger
   for projectiles, melee weapons, or camera.
 parameters:
-- name: weapon
+- name: weaponID
   type: int
   description: an int representing weapon used for making a shot.
 - name: endX
   type: float
-  description: float world coordinates representing an end point.
+  description: float world X coordinate representing the end point.
 - name: endY
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Y coordinate representing the end point.
 - name: endZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Z coordinate representing the end point.
 - name: hitElement
   type: element
   description: 'an element which was hit by a shot. Currently this can be only another
     player. Note: hitElement could be incorrect and should not be relied upon.'
 - name: startX
   type: float
-  description: 'float world coordinates representing the start of the bullet. Note:
+  description: 'float world X coordinate representing the start of the bullet. Note:
     This is not the gun muzzle.'
 - name: startY
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Y coordinate representing the start of the bullet.
 - name: startZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: float world Z coordinate representing the start of the bullet.
 examples:
 - path: examples/onPlayerWeaponFire-1.lua
   description: This code creates explosions when the source players shoots.
@@ -41,4 +41,3 @@ notes:
 - type: info
   content: This event works only with weapons which have enabled bullet sync. See
     Weapons for more information.
-incomplete: true
diff --git a/events/Vehicle/onClientVehicleCollision.yaml b/events/Vehicle/onClientVehicleCollision.yaml
@@ -17,25 +17,49 @@ parameters:
     of this see below)'
 - name: bodyPart
   type: int
-  description: the bodypart that hit the other element
+  description: 'the bodypart that hit the other element
+
+    0: Frame
+
+    2: Trunk
+
+    3: Hood
+
+    4: Rear
+
+    5: Front left door
+
+    6: Front right door
+
+    7: Rear left door
+
+    8: Rear right door
+
+    13: Front Left tyre
+
+    14: Front Right tyre
+
+    15: Back Left tyre
+
+    16: Back Right tyre'
 - name: collisionX
   type: float
-  description: MISSING_PARAM_DESC
+  description: the X coordinate of the position the collision took place
 - name: collisionY
   type: float
-  description: MISSING_PARAM_DESC
+  description: the Y coordinate of the position the collision took place
 - name: collisionZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: the Z coordinate of the position the collision took place
 - name: normalX
   type: float
-  description: MISSING_PARAM_DESC
+  description: the X coordinate of the surface normal of the hit object
 - name: normalY
   type: float
-  description: MISSING_PARAM_DESC
+  description: the Y coordinate of the surface normal of the hit object
 - name: normalZ
   type: float
-  description: MISSING_PARAM_DESC
+  description: the Z coordinate of the surface normal of the hit object
 - name: hitElementForce
   type: float
   description: 0 for non vehicles or the force of the other vehicle
@@ -53,4 +77,3 @@ examples:
 notes:
 - type: info
   content: This event is only triggered for vehicles that are streamed in
-incomplete: true
diff --git a/web/src/pages/Incomplete_Pages.astro b/web/src/pages/Incomplete_Pages.astro
@@ -17,33 +17,41 @@ const unfinishedEvents = getUnfinishedPages('events');
     class="guidelines-link">Contribution guidelines</a></p>
 
 <h3>Unfinished Function Pages</h3>
-<p>These functions (part of the MTA Lua API) are <strong>missing documentation or code examples</strong>:</p>
 <section>
-    <details>
-    <summary>Total: {unfinishedFunctions.length}</summary>
-    <ul>
-        {unfinishedFunctions.map((func) => (
-            <li>
-                <a href={`/reference/${func}`}>{func}</a>
-            </li>
-        ))}
-    </ul>
-    </details>
+    {unfinishedFunctions.length === 0 ? (
+        <p>There are currently no unfinished function pages 😄</p>
+    ) : (
+        <p>These functions (part of the MTA Lua API) are <strong>missing documentation or code examples</strong>:</p>
+        <details>
+        <summary>Total: {unfinishedFunctions.length}</summary>
+        <ul>
+            {unfinishedFunctions.map((func) => (
+                <li>
+                    <a href={`/reference/${func}`}>{func}</a>
+                </li>
+            ))}
+        </ul>
+        </details>
+    )}
 </section>
 
 <h3>Unfinished Event Pages</h3>
-<p>These events (part of the MTA Lua API) are <strong>missing documentation or code examples</strong>:</p>
 <section>
-    <details>
-    <summary>Total: {unfinishedEvents.length}</summary>
-    <ul>
-        {unfinishedEvents.map((event) => (
-            <li>
-                <a href={`/reference/${event}`}>{event}</a>
-            </li>
-        ))}
-    </ul>
-    </details>
+    {unfinishedEvents.length === 0 ? (
+        <p>There are currently no unfinished event pages 😄</p>
+    ) : (
+        <p>These events (part of the MTA Lua API) are <strong>missing documentation or code examples</strong>:</p>
+        <details>
+        <summary>Total: {unfinishedEvents.length}</summary>
+        <ul>
+            {unfinishedEvents.map((event) => (
+                <li>
+                    <a href={`/reference/${event}`}>{event}</a>
+                </li>
+            ))}
+        </ul>
+        </details>
+    )}
 </section>
 
 </StarlightPage>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+addEventHandler("onClientBrowserInputFocusChanged", root, function(gainedFocus)`
	`2`	`+ iprint(source, "gainedFocus:", gainedFocus)`
	`3`	`+end)`