Fix function and events see_also behavior

Fernando-A-Rocha · Fernando-A-Rocha · commit 72a792e382f9 · 2025-05-21T15:13:09.000+01:00
diff --git a/elements/blip.yaml b/elements/blip.yaml
@@ -7,6 +7,3 @@ description: |
   The list of blip icons are available on the [Radar Blips](/radar_blips) page. 
 
   TODO
-see_also:
-  - 'category:Blip functions'
-  - 'category:Blip events'
diff --git a/elements/building.yaml b/elements/building.yaml
@@ -18,6 +18,3 @@ notes:
       Created buildings can have **LOD models**. The procedure is as follows: spawn the LOD building using [createBuilding](/createBuilding), then use [setLowLODElement](/setLowLODElement) to associate it with the non-LOD building element you created beforehand. LOD model distance changed with [engineSetModelLODDistance](/engineSetModelLODDistance) works for buildings.
     - |
       Buildings cannot appear in certain a [dimension](/dimension), and not show in others. Function [setElementDimension](/setElementDimension) returns false on any building. A building is created in a specific [interior world](/interior) (such as 0, the main world), like the default GTA:SA landscape objects. **All buildings appear in EVERY DIMENSION.**
-see_also:
-  - 'category:Building functions'
-  - 'category:Building events'
diff --git a/elements/camera.yaml b/elements/camera.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"camera"**. 
 
   TODO
-see_also:
-  - 'category:Camera functions'
-  - 'category:Camera events'
diff --git a/elements/col.yaml b/elements/col.yaml
@@ -12,6 +12,3 @@ description: |
   The element type of this class is **"col"**. 
 
   TODO
-see_also:
-  - 'category:Col functions'
-  - 'category:Col events'
diff --git a/elements/collision_shape.yaml b/elements/collision_shape.yaml
@@ -5,6 +5,3 @@ description: |
   The element type for this class is **"colshape"**. 
 
   TODO
-see_also:
-  - 'category:Collision_shape functions'
-  - 'category:Collision_shape events'
diff --git a/elements/console.yaml b/elements/console.yaml
@@ -12,6 +12,3 @@ description: |
 preview_images:
     - path: '/assets/server_console_help.jpg'
       description: 'Help output inside server console:'
-see_also:
-  - 'category:Console functions'
-  - 'category:Console events'
diff --git a/elements/dff.yaml b/elements/dff.yaml
@@ -7,6 +7,3 @@ description: |
   The element type of this class is **"dff"**. 
 
   TODO
-see_also:
-  - 'category:Dff functions'
-  - 'category:Dff events'
diff --git a/elements/effect.yaml b/elements/effect.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"effect"**. 
 
   TODO: add all the effects as a table...
-see_also:
-  - 'category:Effect functions'
-  - 'category:Effect events'
diff --git a/elements/light.yaml b/elements/light.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"light"**. 
 
   TODO
-see_also:
-  - 'category:Light functions'
-  - 'category:Light events'
diff --git a/elements/marker.yaml b/elements/marker.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"marker"**. 
 
   TODO
-see_also:
-  - 'category:Marker functions'
-  - 'category:Marker events'
diff --git a/elements/object.yaml b/elements/object.yaml
@@ -11,7 +11,4 @@ notes:
     - |
       There is a distinction in GTA: San Andreas between static and dynamic models. The alternative [createBuilding](/createBuilding) function allows you to create objects that are non-dynamic, utilizing the GTA Building pool, which makes better use of memory.
     - |
-      The [createObject](/createObject) function can also create non-dynamic objects, but for optimization reasons **it is recommended to spawn [Buildings](/building) when creating static objects that don't rely on the [Dimension](/dimension) system** (buildings don't use the same MTA object-streaming system).
-see_also:
-  - 'category:Object functions'
-  - 'category:Object events'
+      The [createObject](/createObject) function can also create non-dynamic objects, but for optimization reasons **it is recommended to spawn [Buildings](/building) when creating static objects that don't rely on the [Dimension](/dimension) system** (buildings don't use the same MTA object-streaming system).
diff --git a/elements/ped.yaml b/elements/ped.yaml
@@ -7,6 +7,3 @@ description: |
   The element type of a NPC is **"ped"**. 
 
   TODO
-see_also:
-  - 'category:Ped functions'
-  - 'category:Ped events'
diff --git a/elements/pickup.yaml b/elements/pickup.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"pickup"**. 
 
   TODO
-see_also:
-  - 'category:Pickup functions'
-  - 'category:Pickup events'
diff --git a/elements/player.yaml b/elements/player.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"player"**. 
 
   TODO
-see_also:
-  - 'category:Player functions'
-  - 'category:Player events'
diff --git a/elements/projectile.yaml b/elements/projectile.yaml
@@ -21,7 +21,4 @@ notes:
     - |
       **39: Satchel Charge**
     - |
-      **58: Flare from Hydra**
-see_also:
-  - 'category:Projectile functions'
-  - 'category:Projectile events'
+      **58: Flare from Hydra**
diff --git a/elements/radar_area.yaml b/elements/radar_area.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"radararea"**. 
 
   TODO
-see_also:
-  - 'category:Radar_area functions'
-  - 'category:Radar_area events'
diff --git a/elements/searchlight.yaml b/elements/searchlight.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"searchlight"**. 
 
   TODO
-see_also:
-  - 'category:Searchlight functions'
-  - 'category:Searchlight events'
diff --git a/elements/sound.yaml b/elements/sound.yaml
@@ -9,6 +9,3 @@ description: |
   The element type of this class is **"sound"**. 
 
   TODO
-see_also:
-  - 'category:Sound functions'
-  - 'category:Sound events'
diff --git a/elements/team.yaml b/elements/team.yaml
@@ -7,6 +7,3 @@ description: |
   The element type of this class is **"team"**. 
 
   TODO
-see_also:
-  - 'category:Team functions'
-  - 'category:Team events'
diff --git a/elements/txd.yaml b/elements/txd.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"txd"**. 
 
   TODO
-see_also:
-  - 'category:Txd functions'
-  - 'category:Txd events'
diff --git a/elements/vehicle.yaml b/elements/vehicle.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"vehicle"**. 
 
   TODO
-see_also:
-  - 'category:Vehicle functions'
-  - 'category:Vehicle events'
diff --git a/elements/water.yaml b/elements/water.yaml
@@ -7,6 +7,3 @@ description: |
   The element type of this class is **"water"**. 
 
   TODO
-see_also:
-  - 'category:Water functions'
-  - 'category:Water events'
diff --git a/elements/weapon.yaml b/elements/weapon.yaml
@@ -5,6 +5,3 @@ description: |
   The element type of this class is **"weapon"**. 
 
   TODO
-see_also:
-  - 'category:Weapon functions'
-  - 'category:Weapon events'
diff --git a/events/Element/onClientElementInteriorChange.yaml b/events/Element/onClientElementInteriorChange.yaml
@@ -17,8 +17,3 @@ examples:
     description: >
       Demonstrates how to detect and respond to an element's interior change.
       Includes vehicle creation and an event handler that reports the interior transition.
-notes: []
-preview_images: []
-version: {}
-issues: []
-see_also: []
diff --git a/events/Element/onElementInteriorChange.yaml b/events/Element/onElementInteriorChange.yaml
@@ -20,7 +20,3 @@ examples:
 notes:
   - type: 'info'
     content: 'This is a test!'
-preview_images: []
-version: {}
-issues: []
-see_also: []
diff --git a/functions/Cursor/getCursorAlpha.yaml b/functions/Cursor/getCursorAlpha.yaml
@@ -16,5 +16,3 @@ client:
     - path: 'examples/getCursorAlpha.lua'
       description: |
         This example prints the cursor alpha to chatbox using */cursoralpha* command:
-  see_also:
-    - 'functions:any:Cursor'
diff --git a/functions/Cursor/getCursorPosition.yaml b/functions/Cursor/getCursorPosition.yaml
@@ -32,6 +32,4 @@ client:
         This example prints your cursors current world coordinates and relative screen coordinates to chatbox after using */cursorpos* command.
     - path: 'examples/getCursorPosition-2.lua'
       description: |
-        This (untested) example uses [processLineOfSight](/processLineOfSight) to calculate the exact world location: Warning, this script causes high CPU usage!
-  see_also:
-    - 'functions:any:Cursor'
+        This (untested) example uses [processLineOfSight](/processLineOfSight) to calculate the exact world location: Warning, this script causes high CPU usage!
diff --git a/functions/Cursor/isCursorShowing.yaml b/functions/Cursor/isCursorShowing.yaml
@@ -13,8 +13,6 @@ shared: &shared
     values:
       - type: 'bool'
         name: 'result'
-  see_also:
-  - 'functions:any:Cursor'
 
 server:
   <<: *shared
diff --git a/functions/Cursor/setCursorAlpha.yaml b/functions/Cursor/setCursorAlpha.yaml
@@ -20,5 +20,3 @@ client:
     - path: 'examples/setCursorAlpha.lua'
       description: |
         This example sets the cursor alpha to 100 using */cursoralpha* command:
-  see_also:
-    - 'functions:any:Cursor'
diff --git a/functions/Cursor/setCursorPosition.yaml b/functions/Cursor/setCursorPosition.yaml
@@ -18,5 +18,3 @@ client:
     - path: 'examples/setCursorPosition.lua'
       description: |
         This example sets your cursor position to the center of your screen after using the */cursorpos* command.
-  see_also:
-    - 'functions:any:Cursor'
diff --git a/functions/Element/getElementHealth.yaml b/functions/Element/getElementHealth.yaml
@@ -24,8 +24,6 @@ shared: &shared
       description: 'setElementHealth in onClientPlayerDamage bug'
     - id: 1423
       description: 'When you setElementHealth under onClientPlayerDamage, the local (hit) player rotates automatically'
-  see_also:
-    - 'functions:any:Element'
 
 server:
   <<: *shared
diff --git a/functions/Element/getElementPosition.yaml b/functions/Element/getElementPosition.yaml
@@ -33,8 +33,6 @@ shared: &shared
   issues:
     - id: 928
       description: 'Position desync with dead players'
-  see_also:
-    - 'functions:any:Element'
 
 server:
   <<: *shared
diff --git a/functions/Element/setElementHealth.yaml b/functions/Element/setElementHealth.yaml
@@ -41,8 +41,6 @@ shared: &shared
       description: 'When you setElementHealth under onClientPlayerDamage, the local (hit) player rotates automatically'
     - id: 448
       description: 'Crash when plane explode'
-  see_also:
-    - 'functions:any:Element'
 
 server:
   <<: *shared
diff --git a/functions/Element/setElementPosition.yaml b/functions/Element/setElementPosition.yaml
@@ -40,8 +40,6 @@ shared: &shared
       description: 'Changing player position when they have a jetpack will remove the jetpack and bug when skin is changed'
     - id: 529
       description: 'Player falls from bike when the bike is teleported using setElementPosition'
-  see_also:
-    - 'functions:any:Element'
 
 server:
   <<: *shared
diff --git a/schemas/common-defs.yaml b/schemas/common-defs.yaml
@@ -111,5 +111,5 @@ $defs:
       introduce this property, then you have to be explicit about it.
     items:
       type: string
-      pattern: "^functions:(client|server|any):[A-Za-z0-9_]+$"
+      pattern: "^(functions|events):(client|server|any):[A-Za-z0-9_]+$"
       uniqueItems: true
diff --git a/web/src/pages/[event].astro b/web/src/pages/[event].astro
@@ -6,6 +6,7 @@ import fs from "fs";
 import path from "path";
 import { Code } from '@astrojs/starlight/components';
 import '@src/styles/function-page.css';
+import { getEventSeeAlsoLinks } from '@src/utils/events';
 
 import NoteBox from '@src/components/NoteBox.astro';
 import type { NotesType } from '@src/utils/types';
@@ -55,6 +56,8 @@ let notesContent: NotesType = [];
 if (Array.isArray(event.data.notes) && event.data.notes.length > 0) {
     notesContent = event.data.notes;
 }
+
+const seeAlsoLinks = getEventSeeAlsoLinks(event);
 ---
 
 <div class={"show-type-badge-" + eventType}>
@@ -111,5 +114,25 @@ if (Array.isArray(event.data.notes) && event.data.notes.length > 0) {
                 ))}
             </div>
         )}
+
+        <!-- See Also -->
+        {seeAlsoLinks.length > 0 && (
+            <div class="see-also-section">
+                <h4>See Also</h4>
+                <ul>
+                    {seeAlsoLinks.map((link: any) => (
+                        (link.name === event.id) && (
+                            <li>
+                                <strong>{link.name}</strong>
+                            </li>
+                        ) || (
+                            <li>
+                                <a href={link.link}>{link.name}</a>
+                            </li>
+                        )
+                    ))}
+                </ul>
+            </div>
+        )}
     </StarlightPage>
 </div>
diff --git a/web/src/pages/[func].astro b/web/src/pages/[func].astro
@@ -188,7 +188,7 @@ const seeAlsoLinks = getFunctionSeeAlsoLinks(func);
             </div>
         )}
 
-        <!-- See Also links list -->
+        <!-- See Also -->
         {seeAlsoLinks.length > 0 && (
             <div class="see-also-section">
                 <h4>See Also</h4>
diff --git a/web/src/utils/events.ts b/web/src/utils/events.ts
@@ -45,3 +45,56 @@ export function getEventsByCategory(): EventsByCategory {
 export function getEventsByTypeByCategory(): EventsByTypeByCategory {
     return eventsByTypeByCategory;
 }
+
+
+// Gets related functions and other items (links) according to the see_also field
+export function getEventSeeAlsoLinks(
+  event: EventItem
+): { name: string; link: string }[] {
+  let seeAlso: string[] = event.data.see_also || [];
+  // Add the event's own category if not already present
+  const folder = path.basename(path.dirname(event.filePath || ''));
+  const ownSeeAlso = 'events:any:' + folder;
+  if (seeAlso && !seeAlso.includes(ownSeeAlso)) {
+      seeAlso.push(ownSeeAlso);
+  }
+  if (!seeAlso || seeAlso.length === 0) {
+    return [];
+  }
+
+  const links = seeAlso.map((item: string) => {
+    const parts = item.split(':');
+    if (parts.length !== 3) return null;
+
+    const [itemType, eventType, eventCategory] = parts;
+    if (itemType !== 'events') return null;
+
+    let eventsInCategory: EventItem[] = [];
+
+    switch (eventType) {
+      case 'client':
+        eventsInCategory = eventsByTypeByCategory.client[eventCategory] || [];
+        break;
+      case 'server':
+        eventsInCategory = eventsByTypeByCategory.server[eventCategory] || [];
+        break;
+      case 'any':
+        eventsInCategory = [
+          ...(eventsByTypeByCategory.client[eventCategory] || []),
+          ...(eventsByTypeByCategory.server[eventCategory] || []),
+        ];
+        break;
+      default:
+        return null;
+    }
+
+    return eventsInCategory.map(f => ({
+      name: f.id,
+      link: `/${f.id}`,
+    }));
+  })
+  .filter(linkGroup => linkGroup !== null)
+  .flat();
+
+  return links.sort((a, b) => a.name.localeCompare(b.name));
+}
diff --git a/web/src/utils/functions.ts b/web/src/utils/functions.ts
