Refactor OOP classes

Author: Fernando-A-Rocha

.github/workflows/validate.yaml

@@ -6,14 +6,12 @@ on:
       - 'elements/**/*.yaml'
       - 'events/**/*.yaml'
       - 'functions/**/*.yaml'
-      - 'classes/**/*.yaml'
       - 'schemas/**/*.yaml'
   pull_request:
     paths:
       - 'elements/**/*.yaml'
       - 'events/**/*.yaml'
       - 'functions/**/*.yaml'
-      - 'classes/**/*.yaml'
       - 'schemas/**/*.yaml'
   workflow_dispatch:
 

.vscode/settings.json

@@ -3,6 +3,5 @@
         "schemas/function.yaml": "/functions/**/*",
         "schemas/element.yaml": "/elements/**/*",
         "schemas/event.yaml": "/events/**/*",
-        "schemas/class.yaml": "/classes/**/*",
     }
 }

classes/Vector/Vector4.yaml

@@ -2,7 +2,7 @@ name: 'matrix'
 description: |
   Matrices are one of the most powerful features of MTA [OOP](/OOP). We did have a presence of Matrices before with [getElementMatrix](/getElementMatrix), but we were given an ugly disgusting table to play with. Now, with the new Matrix class, we can make and magically manipulate Matrices.
 
-methods:
+oop_methods:
   - name: create
     description: |
       Default constructor for the Matrix class. Returns a Matrix object. 

classes/Matrix/Matrix.yaml renamed to elements/Matrix/Matrix.yaml

@@ -1,20 +1,19 @@
 name: 'vector2'
 description: |
   This is a 2D [Vector](/Vector) class.
-methods:
+oop_methods:
   - name: create
     description: |
       Default constructor for the Vector2 class. Returns a Vector2 object.
-    overloads:
-      - signature: Vector2(mixed vectorOrX[, float y])
-        parameters:
-          - name: vectorOrX
-            type: float | table | vector2
-            description: Vector2, table, or float indicating vector's coordinates
-          - name: y
-            type: float
-            optional: true
-            description: If vectorOrX is a float, this is the Y coordinate
+    signature: Vector2(mixed vectorOrX[, float y])
+    parameters:
+      - name: vectorOrX
+        type: float | table | vector2
+        description: Vector2, table, or float indicating vector's coordinates
+      - name: y
+        type: float
+        optional: true
+        description: If vectorOrX is a float, this is the Y coordinate
 
   - name: normalize
     description: Normalizes the vector

classes/Matrix/examples/matrix-1.lua renamed to elements/Matrix/examples/matrix-1.lua

@@ -2,24 +2,23 @@ name: Vector3
 type: class
 description: |
   Represents a 3D [Vector](/Vector). Used for storing and manipulating three-dimensional coordinates (x, y, z).
-methods:
+oop_methods:
   - name: create
     description: |
       Default constructor for the Vector3 class. Returns a Vector3 object.
-    overloads:
-      - signature: Vector3(mixed vectorOrX[, float y, float z])
-        parameters:
-          - name: vectorOrX
-            type: float | table | vector3
-            description: Vector3, table, or floats indicating vector's coordinates
-          - name: y
-            type: float
-            optional: true
-            description: If vectorOrX is a float, this is the Y coordinate
-          - name: z
-            type: float
-            optional: true
-            description: If vectorOrX is a float, this is the Z coordinate
+    signature: Vector3(mixed vectorOrX[, float y, float z])
+    parameters:
+      - name: vectorOrX
+        type: float | table | vector3
+        description: Vector3, table, or floats indicating vector's coordinates
+      - name: y
+        type: float
+        optional: true
+        description: If vectorOrX is a float, this is the Y coordinate
+      - name: z
+        type: float
+        optional: true
+        description: If vectorOrX is a float, this is the Z coordinate
 
   - name: cross
     type: method

classes/Matrix/examples/matrix-2.lua renamed to elements/Matrix/examples/matrix-2.lua

@@ -0,0 +1,29 @@
+name: Vector4
+type: class
+description: |
+  Represents a 4D [Vector](/Vector).
+oop_methods:
+  - name: create
+    description: |
+      Default constructor for the Vector4 class. Returns a Vector4 object.
+    signature: Vector4(mixed vectorOrX[, float y, float z, float w])
+    parameters:
+      - name: vectorOrX
+        type: float | table | vector4
+        description: Vector4, table, or floats indicating vector's coordinates
+      - name: y
+        type: float
+        optional: true
+        description: If vectorOrX is a float, this is the Y coordinate
+      - name: z
+        type: float
+        optional: true
+        description: If vectorOrX is a float, this is the Z coordinate
+      - name: w
+        type: float
+        optional: true
+        description: If vectorOrX is a float, this is the W coordinate
+
+examples:
+  - path: examples/vector4-1.lua
+    description: This example adds a command called "/garage", allowing you to get any garage bounding box. 

classes/Matrix/examples/matrix-3.lua renamed to elements/Matrix/examples/matrix-3.lua

@@ -17,5 +17,47 @@ properties:
     description: A list of noteworthy pieces of information for the item.
     items:
       type: string
+  examples:
+    $ref: 'common-defs.yaml#/$defs/examples'
   see_also:
     $ref: 'common-defs.yaml#/$defs/see_also'
+  oop_methods:
+    type: array
+    items:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          type: string
+        description:
+          type: string
+        signature:
+          type: string
+        overloads:
+          type: array
+          items:
+            type: object
+            required:
+              - signature
+            properties:
+              signature:
+                type: string
+              description:
+                type: string
+              parameters:
+                type: array
+                items:
+                  type: object
+                  required:
+                    - name
+                    - type
+                  properties:
+                    name:
+                      type: string
+                    type:
+                      type: string
+                    description:
+                      type: string
+                    optional:
+                      type: boolean

classes/Vector/Vector2.yaml renamed to elements/Vector/Vector2.yaml

@@ -11,7 +11,3 @@ for /r "elements" %%f in (*.yaml) do (
 for /r "events" %%f in (*.yaml) do (
     .\tools\yajsv.exe -s schemas/event.yaml -r schemas/common-defs.yaml "%%f"
 )
-
-for /r "classes" %%f in (*.yaml) do (
-    .\tools\yajsv.exe -s schemas/class.yaml -r schemas/common-defs.yaml "%%f"
-)

classes/Vector/Vector3.yaml renamed to elements/Vector/Vector3.yaml

@@ -3,4 +3,3 @@
 find 'functions/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/function.yaml -r schemas/common-defs.yaml {}
 find 'elements/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/element.yaml -r schemas/common-defs.yaml {}
 find 'events/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/event.yaml -r schemas/common-defs.yaml {}
-find 'classes/' -name '*.yaml' -type f -print0 | xargs -0 -I {} tools/yajsv -s schemas/class.yaml -r schemas/common-defs.yaml {}

elements/Vector/Vector4.yaml

@@ -1,5 +1,6 @@
 /wiki/ /
 /wiki/* /:splat
+/Main_Page /
 
 /MTA_Classes /Element
 /Element/:elementname /:elementname

classes/Vector/examples/vector2-1.lua renamed to elements/Vector/examples/vector2-1.lua

@@ -35,14 +35,4 @@ export const collections = {
 			}
 		}),
 	}),
-	classes: defineCollection({
-		loader: glob({
-			pattern: "**/*.yaml",
-			base: "../classes",
-			generateId: ({ entry }) => {
-				// Extract the file name without the folder
-				return ((entry.split('/') || []).pop() || '').replace(/\.yaml$/, '');
-			}
-		})
-	}),
 };

classes/Vector/examples/vector2-2.lua renamed to elements/Vector/examples/vector2-2.lua

@@ -2,6 +2,7 @@
 import { CardGrid } from '@astrojs/starlight/components';
 import IconLinkCard from '@src/components/IconLinkCard.astro';
 ---
+<hr>
 
 <CardGrid>
     <IconLinkCard

classes/Vector/examples/vector3-1.lua renamed to elements/Vector/examples/vector3-1.lua

@@ -2,7 +2,7 @@
 import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
 import { getSeeAlsoLinksFromList } from '@src/utils/general';
 import SeeAlsoSection from '@src/components/SeeAlsoSection.astro';
-import { getElementsByCategory } from '@src/utils/elements';
+import { getElementsByCategory, hasOopMethods } from '@src/utils/elements';
 const elementsByCategory = getElementsByCategory();
 ---
 <StarlightPage frontmatter={{
@@ -22,6 +22,7 @@ const elementsByCategory = getElementsByCategory();
                     {elements.map(element => (
                         <li>
                             <a href={`/${element.id}`}>{element.id}</a>
+                            {hasOopMethods(element) ? <span class="small-text">[OOP]</span> : ''}
                         </li>
                     ))}
                 </ul>

classes/Vector/examples/vector3-2.lua renamed to elements/Vector/examples/vector3-2.lua

@@ -2,24 +2,25 @@
 import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
 import { getSeeAlsoLinksFromList } from '@src/utils/general';
 import SeeAlsoSection from '@src/components/SeeAlsoSection.astro';
-import { getOOPClassesByCategory } from '@src/utils/classes';
-const classesByCategory = getOOPClassesByCategory();
+import { getOOPElementsByCategory } from '@src/utils/elements';
+const elementsByCategory = getOOPElementsByCategory();
 ---
 <StarlightPage frontmatter={{
     template: 'doc',
     title: 'OOP Classes',
     tableOfContents: false,
 }}>
-    <p>This page lists all <strong><a href="/OOP">OOP</a> Classes</strong> available in the <a href="/Lua_API">Lua API</a> organized by category.</p>
-    <p>Vectors and Matrices make it easier to drop the complex maths and go straight ahead with fun part of maths. OOP does not have to be enabled in the server config for this to be enabled.</p>
+    <p>This page lists all <strong>Classes</strong> available in the <a href="/Lua_API">Lua API</a> using <a href="/OOP_Introduction">OOP</a> organized by category.</p>
+
+    <p><strong>Vectors</strong> and <strong>Matrices</strong> make it easier to drop the complex maths and go straight ahead with fun part of maths. OOP does not have to be enabled in the server config for this to be enabled.</p>
 
-    {Object.entries(classesByCategory).map(([category, oopClasses]) => (
+    {Object.entries(elementsByCategory).map(([category, elements]) => (
         <section>
-            <details>
+            <details open>
                 <summary>{category} classes</summary>
                 <ul>
-                    {oopClasses.map(oopClass => (
-                        <li><a href={`/${oopClass.id}`}>{oopClass.id}</a></li>
+                    {elements.map(element => (
+                        <li><a href={`/${element.id}`}>{element.id}</a></li>
                     ))}
                 </ul>
             </details>
@@ -29,5 +30,6 @@ const classesByCategory = getOOPClassesByCategory();
 
     <SeeAlsoSection seeAlsoLinks={getSeeAlsoLinksFromList([
         'article:OOP_Introduction',
+        'article:Element',
     ])} currentId='' />
 </StarlightPage>

classes/Vector/examples/vector3-3.lua renamed to elements/Vector/examples/vector3-3.lua

@@ -17,10 +17,9 @@ A vector represents a <a href="https://en.wikipedia.org/wiki/Euclidean_vector" t
 **Tip**: if you are using vectors a lot, you can use `collectgarbage("setpause",100)` to tell Lua to garbage collect intermediary vectors frequently. Run that once per resource (or just in the resource you need it for). This has other performance implications as Lua will be stopping the world more frequently. 
 
 <SeeAlsoSection seeAlsoLinks={getSeeAlsoLinksFromList([
-    'article:OOP',
     'article:OOP_Introduction',
-    'classes:any:Vector',
-    'classes:any:Matrix'
+    'elements:any:Vector',
+    'elements:any:Matrix'
 ])} currentId='' />
 
 </StarlightPage>