Merge branch 'main' into dependabot/npm_and_yarn/web/vite-6.3.5

Author: Fernando-A-Rocha

functions/Cursor/isCursorShowing.yaml

@@ -3,8 +3,10 @@ shared: &shared
   description: |
     This function determines the state of a [player](/player)'s cursor.
   notes:
-    - This function only handles the cursor state set by the [showCursor](/showCursor) function, ignoring it if the console, chatbox, or menu is opened.
-    - If you use this function on the server-side, keep in mind that it only detects the [showCursor](/showCursor) function executed on the server-side and not changes done by client-side.
+    - type: 'warning'
+      content: 'This function only handles the cursor state set by the [showCursor](/showCursor) function, ignoring it if the console, chatbox, or menu is opened.'
+    - type: 'warning'
+      content: 'If you use this function on the server-side, keep in mind that it only detects the [showCursor](/showCursor) function executed on the server-side and not changes done by client-side.'
   returns:
     description: |
       Returns *true* if the [player](/player)'s cursor is visible, and *false* if it is not.

functions/Cursor/showCursor.yaml

@@ -3,8 +3,10 @@ shared: &shared
   description: |
     This function is used to show or hide a [player](/player)'s cursor. 
   notes:
-    - Regardless of the cursor state you set using this function, the cursor will always be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function.
-    - Be aware of that if showCursor is enabled by a resource, you can't disabled it from a different ressource! showCursor(false) will not work, in order to make it work, disable it from the original resource that enabled it or use an export.
+    - type: 'warning'
+      content: 'Regardless of the cursor state you set using this function, the cursor will always be visible while the menu, the chatbox input line or the console are active, or if another resource has called this function.'
+    - type: 'warning'
+      content: "Be aware of that if showCursor is enabled by a resource, you can't disabled it from a different ressource! `showCursor(false)` will not work, in order to make it work, disable it from the original resource that enabled it or use an export."
   parameters:
     - name: 'thePlayer'
       type: 'player'

functions/Element/setElementHealth.yaml

@@ -8,7 +8,7 @@ shared: &shared
   description: |
     This function sets the health of a [player](/player), [ped](/ped), [vehicle](/vehicle), or [object](/object) element.
   notes:
-    - type: 'standard'
+    - type: 'info'
       content: |
         In the case of the [vehicle](/vehicle) element, the health ranges from 0 to 1000.
         

functions/Element/setElementPosition.yaml

@@ -8,10 +8,10 @@ shared: &shared
   description: |
     This function sets the position of an element to the specified coordinates.
   notes:
-    - |
-      Warning: Do not use this function to spawn a [player](/player). It will cause problems with other functions like [warpPedIntoVehicle](/warpPedIntoVehicle). Use [spawnPlayer](/spawnPlayer) instead.
-    - |
-      If you want to put a vehicle or player out of the water or simulate the position-resetting behaviour if CJ goes below the ground too far, then you need to retrieve a recommended coordinate on ground to place the element at. Take a look at this MTA forums [post](https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198) for steps in the right direction.
+    - type: 'warning'
+      content: 'Do not use this function to spawn a [player](/player). It will cause problems with other functions like [warpPedIntoVehicle](/warpPedIntoVehicle). Use [spawnPlayer](/spawnPlayer) instead.'
+    - type: 'info'
+      content: If you want to put a vehicle or player out of the water or simulate the position-resetting behaviour if CJ goes below the ground too far, then you need to retrieve a recommended coordinate on ground to place the element at. Take a look at this MTA forums [post](https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198) for steps in the right direction.
   parameters:
     - name: 'theElement'
       type: 'element'

schemas/common-defs.yaml

@@ -7,7 +7,7 @@ $defs:
     type: array
     description: |
       List of noteworthy pieces of information for the item.
-      Each note can be of a specific type, e.g., 'standard' or 'important'.
+      Each note can be of a specific type, e.g., 'info' or 'important'.
     items:
       type: object
       description: An individual note item.
@@ -18,9 +18,10 @@ $defs:
           type: string
           description: The type of the note, influencing its presentation.
           enum:
-            - standard
+            - info
+            - warning
             - important
-          default: standard
+          default: info
         content:
           type: string
           description: The textual content of the note. Can use markdown and YAML multi-line strings.

schemas/element.yaml

@@ -12,5 +12,10 @@ properties:
   description:
     type: string
     description: Description of the element.
+  notes:
+    type: array
+    description: A list of noteworthy pieces of information for the item.
+    items:
+      type: string
   see_also:
     $ref: 'common-defs.yaml#/$defs/see_also'

web/src/components/NoteBox.astro

@@ -2,10 +2,10 @@
 import type { HTMLAttributes } from 'astro/types';
 
 interface Props extends HTMLAttributes<'div'> {
-  type?: 'standard' | 'important';
+  type?: 'info' | 'warning' | 'important';
 }
 
-const { type = 'standard', class: className, ...rest } = Astro.props;
+const { type = 'info', class: className, ...rest } = Astro.props;
 ---
 <div
   class:list={["custom-note-box", { 'note-important': type === 'important' }, className]}

web/src/utils/functions.ts

@@ -89,15 +89,14 @@ let functionsByTypeByCategory: FunctionsByTypeByCategory = {
 };
 
 for (let func of functionsCollection) {
-    const normalizedPath = path.normalize(func.id);
-    const folder = path.basename(path.dirname(normalizedPath));
+    const folder = path.basename(path.dirname(func.filePath || ''));
     if (!functionsByCategory[folder]) {
         functionsByCategory[folder] = [];
     }
     functionsByCategory[folder].push(func);
 
     const funcType = getFunctionType(func.data);
-    if (!functionsByTypeByCategory[funcType]?.[folder]) {
+    if (!functionsByTypeByCategory[funcType][folder]) {
         functionsByTypeByCategory[funcType][folder] = [];
     }
     functionsByTypeByCategory[funcType][folder].push(func);

web/src/utils/types.ts

@@ -1,5 +1,5 @@
 export type FunctionType = 'shared' | 'client' | 'server';
 export type NotesType = {
-    type: 'standard' | 'important';
+    type: 'info' | 'warning' | 'important';
     content: string;
 }[];