Add see_also for related functions

Fernando-A-Rocha · Fernando-A-Rocha · commit 954eef85e8da · 2025-05-21T14:58:26.000+01:00
diff --git a/functions/Cursor/getCursorAlpha.yaml b/functions/Cursor/getCursorAlpha.yaml
@@ -17,4 +17,4 @@ client:
       description: |
         This example prints the cursor alpha to chatbox using */cursoralpha* command:
   see_also:
-    - 'category:Client element functions'
+    - 'functions:any:Cursor'
diff --git a/functions/Cursor/getCursorPosition.yaml b/functions/Cursor/getCursorPosition.yaml
@@ -33,3 +33,5 @@ client:
     - 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'
diff --git a/functions/Cursor/isCursorShowing.yaml b/functions/Cursor/isCursorShowing.yaml
@@ -13,6 +13,8 @@ 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
@@ -21,4 +21,4 @@ client:
       description: |
         This example sets the cursor alpha to 100 using */cursoralpha* command:
   see_also:
-    - 'category:Client GUI functions'
+    - 'functions:any:Cursor'
diff --git a/functions/Cursor/setCursorPosition.yaml b/functions/Cursor/setCursorPosition.yaml
@@ -19,4 +19,4 @@ client:
       description: |
         This example sets your cursor position to the center of your screen after using the */cursorpos* command.
   see_also:
-    - 'category:Client input functions'
+    - 'functions:any:Cursor'
diff --git a/functions/Element/getElementHealth.yaml b/functions/Element/getElementHealth.yaml
@@ -24,6 +24,8 @@ 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,6 +33,8 @@ 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,6 +41,8 @@ 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,6 +40,8 @@ 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: "^(category):"
+      pattern: "^functions:(client|server|any):[A-Za-z0-9_]+$"
       uniqueItems: true
diff --git a/web/src/pages/[func].astro b/web/src/pages/[func].astro
@@ -1,7 +1,7 @@
 ---
 import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
 import { getCollection } from 'astro:content';
-import { getFunctionInfo, parseFunctionSyntaxes } from '@src/utils/functions';
+import { getFunctionInfo, parseFunctionSyntaxes, getFunctionSeeAlsoLinks } from '@src/utils/functions';
 import { renderInlineMarkdown } from '@src/utils/general';
 import { marked } from 'marked';
 import fs from "fs";
@@ -54,6 +54,8 @@ if (Array.isArray(funcInfo.notes) && funcInfo.notes.length > 0) {
 }
 
 let funcSyntaxes = parseFunctionSyntaxes(func.id, func.data);
+
+const seeAlsoLinks = getFunctionSeeAlsoLinks(func);
 ---
 
 <div class={"show-type-badge-" + funcType}>
@@ -185,5 +187,25 @@ let funcSyntaxes = parseFunctionSyntaxes(func.id, func.data);
                 ))}
             </div>
         )}
+
+        <!-- See Also links list -->
+        {seeAlsoLinks.length > 0 && (
+            <div class="see-also-section">
+                <h4>See Also</h4>
+                <ul>
+                    {seeAlsoLinks.map((link: any) => (
+                        (link.name === func.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/utils/functions.ts b/web/src/utils/functions.ts
@@ -236,4 +236,56 @@ export function getFunctionsByCategory(): FunctionsByCategory {
 
 export function getFunctionsByTypeByCategory(): FunctionsByTypeByCategory {
     return functionsByTypeByCategory;
-}
+}
+
+// Gets related functions and other items (links) according to the see_also field
+export function getFunctionSeeAlsoLinks(
+  func: FunctionItem
+): { name: string; link: string }[] {
+  const seeAlso: string[] | undefined =
+    func.data.shared?.see_also ??
+    func.data.client?.see_also ??
+    func.data.server?.see_also;
+
+  if (!seeAlso || seeAlso.length === 0) {
+    return [];
+  }
+
+  const links = seeAlso.map((item: string) => {
+    const parts = item.split(':');
+    if (parts.length !== 3) return null;
+
+    const [itemType, functionType, functionCategory] = parts;
+
+    if (itemType !== 'functions') return null;
+
+    let functionsInCategory: FunctionItem[] = [];
+
+    switch (functionType) {
+      case 'client':
+        functionsInCategory = functionsByTypeByCategory.client[functionCategory] || [];
+        break;
+      case 'server':
+        functionsInCategory = functionsByTypeByCategory.server[functionCategory] || [];
+        break;
+      case 'any':
+        functionsInCategory = [
+          ...(functionsByTypeByCategory.shared[functionCategory] || []),
+          ...(functionsByTypeByCategory.client[functionCategory] || []),
+          ...(functionsByTypeByCategory.server[functionCategory] || []),
+        ];
+        break;
+      default:
+        return null;
+    }
+
+    return functionsInCategory.map(f => ({
+      name: f.id,
+      link: `/${f.id}`,
+    }));
+  })
+  .filter(linkGroup => linkGroup !== null)
+  .flat();
+
+  return links.sort((a, b) => a.name.localeCompare(b.name));
+}
