Functions listing and pages WIP

Fernando-A-Rocha · Fernando-A-Rocha · commit a121ad116401 · 2025-02-05T13:46:15.000Z
diff --git a/web/astro.config.mjs b/web/astro.config.mjs
@@ -37,21 +37,22 @@ export default defineConfig({
 					label: 'Reference',
 					items: [
 						{
-							slug: 'Lua_API',
+							slug: 'lua-api',
 						},
 						{
 							label: 'Functions',
 							items: [
-								{slug: 'Client_Scripting_Functions'},
-								{slug: 'Server_Scripting_Functions'},
-								{slug: 'Shared_Scripting_Functions'},
+								{label: 'All functions', link: '/functions'},
+								{label: 'Shared functions', link: 'Shared_Scripting_Functions'},
+								{label: 'Client functions', link: 'Client_Scripting_Functions'},
+								{label: 'Server functions', link: 'Server_Scripting_Functions'},
 							]
 						},
 						{
 							label: 'Events',
 							items: [
-								{slug: 'Client_Scripting_Events'},
-								{slug: 'Server_Scripting_Events'},
+								// {slug: 'Client_Scripting_Events'},
+								// {slug: 'Server_Scripting_Events'},
 							]
 						},
 						{
diff --git a/web/src/content.config.ts b/web/src/content.config.ts
@@ -6,6 +6,20 @@ import { glob } from 'astro/loaders';
 export const collections = {
 	docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
 	elements: defineCollection({
-		loader: glob({ pattern: "**/*.yaml", base: "../elements" }),
+		loader: glob({
+			pattern: "**/*.yaml",
+			base: "../elements",
+			generateId: ({ entry }) => entry.replace(/\.yaml$/, '')
+		}),
+	}),
+	functions: defineCollection({
+		loader: glob({
+			pattern: "**/*.yaml",
+			base: "../functions",
+			generateId: ({ entry }) => {
+				// Extract the file name without the folder
+				return ((entry.split('/') || []).pop() || '').replace(/\.yaml$/, '');
+			}
+		})
 	}),
 };
diff --git a/web/src/content/docs/reference/events/client.md b/web/src/content/docs/reference/events/client.md
diff --git a/web/src/content/docs/reference/events/server.md b/web/src/content/docs/reference/events/server.md
diff --git a/web/src/content/docs/reference/functions/client.md b/web/src/content/docs/reference/functions/client.md
diff --git a/web/src/content/docs/reference/functions/server.md b/web/src/content/docs/reference/functions/server.md
diff --git a/web/src/content/docs/reference/functions/shared.md b/web/src/content/docs/reference/functions/shared.md
diff --git a/web/src/content/docs/reference/lua.md b/web/src/content/docs/reference/lua.md
@@ -1,6 +1,10 @@
 ---
 title: Lua API
-slug: Lua_API
+slug: lua-api
 ---
 
-...
+The MTA **Lua API** is an extensive ecosystem built on an extended version of [Lua 5.1](https://www.lua.org/manual/5.1/), offering a wide array of functions and systems to enhance and customize gameplay. Whether you're creating game modes, modifying existing ones, or adding new features, the **Lua API** gives you full control over the game environment.
+
+This API includes a powerful [event system](/events), a robust [element system](/Element) for interacting with in-game objects, and a vast collection of [functions](/functions) to manage game logic, networking, and more. With its flexibility and ease of use, the Lua API empowers developers to bring their unique ideas to life, making Multi Theft Auto a versatile platform for creating multiplayer experiences.
+
+Explore this wiki to discover all the functions, event handlers, and tools available to help you make the most out of the Lua API in your MTA projects!
diff --git a/web/src/pages/404.astro b/web/src/pages/404.astro
@@ -1,4 +1,11 @@
 ---
 import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
 ---
-<StarlightPage frontmatter={{ template: 'splash', title: 'Page not found (404)', hero: { title: 'Page not found', tagline: 'Check the URL or try using the search bar.' } }} />
+<StarlightPage frontmatter={{
+    template: 'splash',
+    title: 'Page not found (404)',
+    hero: {
+        title: 'Page not found',
+        tagline: 'Check the URL or try using the search bar.'
+    }
+}} />
diff --git a/web/src/pages/Client_Scripting_Functions.astro b/web/src/pages/Client_Scripting_Functions.astro
@@ -0,0 +1,27 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { getFunctionsByTypeByCategory } from '@src/utils/functions';
+
+const functionsByTypeByCategory = getFunctionsByTypeByCategory();
+const theseFunctions = functionsByTypeByCategory.client;
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Client functions',
+}}>
+
+<p>This page lists all <strong>client-side</strong> functions available in the <a href="/lua-api">Lua API</a> organized by category.</p>
+
+{Object.entries(theseFunctions).map(([category, funcs]) => (
+    <section>
+        <details>
+            <summary>{category} functions</summary>
+            <ul>
+                {funcs.map(func => (
+                    <li><a href={`/${func.id}`}>{func.id}</a></li>
+                ))}
+            </ul>
+        </details>
+    </section>
+))}
+</StarlightPage>
diff --git a/web/src/pages/Server_Scripting_Functions.astro b/web/src/pages/Server_Scripting_Functions.astro
@@ -0,0 +1,27 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { getFunctionsByTypeByCategory } from '@src/utils/functions';
+
+const functionsByTypeByCategory = getFunctionsByTypeByCategory();
+const theseFunctions = functionsByTypeByCategory.server;
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Server functions',
+}}>
+
+<p>This page lists all <strong>server-side</strong> functions available in the <a href="/lua-api">Lua API</a> organized by category.</p>
+
+{Object.entries(theseFunctions).map(([category, funcs]) => (
+    <section>
+        <details>
+            <summary>{category} functions</summary>
+            <ul>
+                {funcs.map(func => (
+                    <li><a href={`/${func.id}`}>{func.id}</a></li>
+                ))}
+            </ul>
+        </details>
+    </section>
+))}
+</StarlightPage>
diff --git a/web/src/pages/Shared_Scripting_Functions.astro b/web/src/pages/Shared_Scripting_Functions.astro
@@ -0,0 +1,27 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { getFunctionsByTypeByCategory } from '@src/utils/functions';
+
+const functionsByTypeByCategory = getFunctionsByTypeByCategory();
+const theseFunctions = functionsByTypeByCategory.shared;
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'Shared functions',
+}}>
+
+<p>This page lists all <strong>shared</strong> functions available in the <a href="/lua-api">Lua API</a> organized by category.</p>
+
+{Object.entries(theseFunctions).map(([category, funcs]) => (
+    <section>
+        <details>
+            <summary>{category} functions</summary>
+            <ul>
+                {funcs.map(func => (
+                    <li><a href={`/${func.id}`}>{func.id}</a></li>
+                ))}
+            </ul>
+        </details>
+    </section>
+))}
+</StarlightPage>
diff --git a/web/src/pages/[func].astro b/web/src/pages/[func].astro
@@ -0,0 +1,23 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { getAllFunctions, getFunctionType } from '@src/utils/functions';
+
+export function getStaticPaths() {
+    const functions = getAllFunctions();
+    return functions.map(func => ({ params: { func: func.id } }));
+}
+
+const { func } = Astro.params;
+const theFunc = getAllFunctions().find(f => f.id === func);
+if (!theFunc) {
+    return
+}
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: func
+}}>
+    <div>
+        {getFunctionType(theFunc.data)}
+    </div>
+</StarlightPage>
diff --git a/web/src/pages/functions.astro b/web/src/pages/functions.astro
@@ -0,0 +1,46 @@
+---
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { getFunctionsByCategory, getFunctionType } from '@src/utils/functions';
+
+const functionsByCategory = getFunctionsByCategory();
+---
+<StarlightPage frontmatter={{
+    template: 'doc',
+    title: 'All functions',
+}}>
+
+<p>This page lists all functions available in the <a href="/lua-api">Lua API</a> organized by category.</p>
+
+{Object.entries(functionsByCategory).map(([category, funcs]) => (
+    <section>
+        <details>
+            <summary>{category} functions</summary>
+            <ul>
+                {funcs.map(func => (
+                    <li><a href={`/${func.id}`}>{func.id}</a> (<span class="side-type-color">{getFunctionType(func.data)}</span>)</li>
+                ))}
+            </ul>
+        </details>
+    </section>
+))}
+</StarlightPage>
+
+<style>
+.side-shared {
+    color: rgb(117, 117, 255);
+}
+.side-client {
+    color: rgb(255, 50, 50);
+}
+.side-server {
+    color: rgb(232, 115, 0);
+}
+</style>
+
+<script>
+    document.querySelectorAll('.side-type-color').forEach(el => {
+        const type = el.textContent || '';
+        el.classList.add(`side-${type.toLowerCase()}`);
+    });
+
+</script>
diff --git a/web/src/utils/functions.ts b/web/src/utils/functions.ts
@@ -0,0 +1,59 @@
+import { getCollection } from 'astro:content';
+import path from 'path';
+
+type FunctionItem = Awaited<ReturnType<typeof getCollection>>[number];
+
+type FunctionsByCategory = {
+    [folder: string]: FunctionItem[];
+};
+type FunctionsByTypeByCategory = {
+    shared: FunctionsByCategory;
+    client: FunctionsByCategory;
+    server: FunctionsByCategory;
+};
+
+type FunctionData = {
+    shared?: object;
+    client?: object;
+    server?: object;
+};
+
+export function getFunctionType(data: FunctionData): 'shared' | 'client' | 'server' {
+    if (data.shared) return 'shared';
+    if (data.client) return 'client';
+    return 'server';
+}
+
+const functionsCollection = await getCollection('functions');
+let functionsByCategory: FunctionsByCategory = {};
+let functionsByTypeByCategory: FunctionsByTypeByCategory = {
+    shared: {},
+    client: {},
+    server: {}
+};
+
+for (let func of functionsCollection) {
+    const normalizedPath = path.normalize(func.filePath || '');
+    const folder = path.basename(path.dirname(normalizedPath));
+    if (!functionsByCategory[folder]) {
+        functionsByCategory[folder] = [];
+    }
+    functionsByCategory[folder].push(func);
+
+    const funcType = getFunctionType(func.data);
+    if (!functionsByTypeByCategory[funcType][folder]) {
+        functionsByTypeByCategory[funcType][folder] = [];
+    }
+    functionsByTypeByCategory[funcType][folder].push(func);
+}
+
+export function getFunctionsByCategory(): FunctionsByCategory {
+    return functionsByCategory;
+}
+export function getAllFunctions(): FunctionItem[] {
+    return functionsCollection;
+}
+
+export function getFunctionsByTypeByCategory(): FunctionsByTypeByCategory {
+    return functionsByTypeByCategory;
+}

Original file line number	Diff line number	Diff line change
`@@ -37,21 +37,22 @@ export default defineConfig({`
`37`	`37`	`label: 'Reference',`
`38`	`38`	`items: [`
`39`	`39`	`{`
`40`		`- slug: 'Lua_API',`
	`40`	`+ slug: 'lua-api',`
`41`	`41`	`},`
`42`	`42`	`{`
`43`	`43`	`label: 'Functions',`
`44`	`44`	`items: [`
`45`		`- {slug: 'Client_Scripting_Functions'},`
`46`		`- {slug: 'Server_Scripting_Functions'},`
`47`		`- {slug: 'Shared_Scripting_Functions'},`
	`45`	`+ {label: 'All functions', link: '/functions'},`
	`46`	`+ {label: 'Shared functions', link: 'Shared_Scripting_Functions'},`
	`47`	`+ {label: 'Client functions', link: 'Client_Scripting_Functions'},`
	`48`	`+ {label: 'Server functions', link: 'Server_Scripting_Functions'},`
`48`	`49`	`]`
`49`	`50`	`},`
`50`	`51`	`{`
`51`	`52`	`label: 'Events',`
`52`	`53`	`items: [`
`53`		`- {slug: 'Client_Scripting_Events'},`
`54`		`- {slug: 'Server_Scripting_Events'},`
	`54`	`+ // {slug: 'Client_Scripting_Events'},`
	`55`	`+ // {slug: 'Server_Scripting_Events'},`
`55`	`56`	`]`
`56`	`57`	`},`
`57`	`58`	`{`