Merge branch 'main' of https://github.com/multitheftauto/wiki.multitheftauto.com

FileEX · FileEX · commit 270e1a3b671e · 2025-05-28T12:11:08.000+02:00
diff --git a/functions/Cursor/isCursorShowing.yaml b/functions/Cursor/isCursorShowing.yaml
@@ -34,18 +34,18 @@ client:
     - path: 'examples/isCursorShowing-3.lua'
       description: |
         This example creates a function to set the state of the [player](/player)'s cursor using the [showCursor](/showCursor) function. 
-      exampleTitle: 'Toggle Cursor'
+      title: 'Toggle Cursor'
     - path: 'examples/isCursorShowing-4.lua'
       description: |
         If you are already advanced in scripting, using this code is recommended, as it is much more compact:
       append: true
-      exampleTitle: 'Toggle Cursor'
+      title: 'Toggle Cursor (Advanced)'
     - path: 'examples/isCursorShowing-5.lua'
       description: |
         This example creates a function that allows the [player](/player) to change the state of the cursor using the [showCursor](/showCursor) and [bindKey](/bindKey) functions. 
-      exampleTitle: 'Toggle Cursor by binded key'
+      title: 'Toggle Cursor by bound key'
     - path: 'examples/isCursorShowing-6.lua'
       description: |
         If you are already advanced in scripting, using this code is recommended, as it is much more compact:
       append: true
-      exampleTitle: 'Toggle Cursor by binded key'
+      title: 'Toggle Cursor by bound key (Advanced)'
diff --git a/functions/Element/getElementHealth.yaml b/functions/Element/getElementHealth.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'getElementHealth'
   oop:
-    entity: element
+    element: element
     method: getHealth
     variable: health
   pair: 'setElementHealth'
diff --git a/functions/Element/getElementPosition.yaml b/functions/Element/getElementPosition.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'getElementPosition'
   oop:
-    entity: element
+    element: element
     method: getPosition
     variable: position
   pair: 'setElementPosition'
diff --git a/functions/Element/setElementHealth.yaml b/functions/Element/setElementHealth.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'setElementHealth'
   oop:
-    entity: element
+    element: element
     method: setHealth
     variable: health
   pair: 'getElementHealth'
diff --git a/functions/Element/setElementPosition.yaml b/functions/Element/setElementPosition.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'setElementPosition'
   oop:
-    entity: element
+    element: element
     method: setPosition
     variable: position
   pair: 'getElementPosition'
diff --git a/functions/File/fileClose.yaml b/functions/File/fileClose.yaml
@@ -5,7 +5,7 @@ shared: &shared
       content: |
         It is important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.
   oop:
-    entity: file
+    element: file
     method: close
   description: Closes a file handle obtained by [[fileCreate]] or [[fileOpen]].
   parameters:
diff --git a/functions/File/fileCopy.yaml b/functions/File/fileCopy.yaml
@@ -5,7 +5,7 @@ shared: &shared
       content: |
         If you do not want to share the content of the created file with other servers, prepend the file path with @ (See [[filepath]] for more information).
   oop:
-    entity: file
+    element: file
     static: true
     method: copy
   description: This function copies a file.
diff --git a/functions/File/fileCreate.yaml b/functions/File/fileCreate.yaml
@@ -11,7 +11,7 @@ shared: &shared
       content: |
         It is important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.
   oop:
-    entity: file
+    element: file
     static: true
     method: new
   description: Creates a new file in a directory of a resource. If there already exists a file with the specified name, it is overwritten with an empty file.
diff --git a/functions/File/fileDelete.yaml b/functions/File/fileDelete.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: fileDelete
   oop:
-    entity: file
+    element: file
     static: true
     method: delete
   description: Deletes the specified file.
diff --git a/functions/File/fileExists.yaml b/functions/File/fileExists.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: fileExists
   oop:
-    entity: file
+    element: file
     static: true
     method: exists
   description: This functions checks whether a specified file exists inside a resource.
diff --git a/functions/File/fileFlush.yaml b/functions/File/fileFlush.yaml
@@ -4,7 +4,7 @@ shared: &shared
     - type: 'info'
       content: '[[fileClose]] automatically flushes the file.'
   oop:
-    entity: file
+    element: file
     method: flush
   description: |
     Forces pending disk writes to be executed. [[fileWrite]] doesn't directly write to the hard disk but places the data in a temporary buffer; only when there is enough data in the buffer it is actually written to disk. Call this function if you need the data written right now without closing the file. This is useful for log files that might want to be read while the resource is still executing. `fileFlush` can be called after each log entry is written. Without this, the file may appear empty or outdated to the user.
diff --git a/functions/File/fileGetContents.yaml b/functions/File/fileGetContents.yaml
@@ -5,7 +5,7 @@ shared: &shared
       content: |
         Please note that even if you enable SD #22 and #23 on your server, you are not protected from user attacks, which can happen after verification of the file, but before you read the contents of such verified file. This function enables you to safely read the contents of a meta.xml-listed file on both client and server.
   oop:
-    entity: file
+    element: file
     method: getContents
   description: |
     Reads the entire contents of the file, optionally verifies the read contents by computing and comparing the checksum with the expected one, and returns the content as string. The file cursor position is not modified by calls to this function. File must be added in the [[meta.xml]].
diff --git a/functions/File/fileGetPath.yaml b/functions/File/fileGetPath.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: fileGetPath
   oop:
-    entity: file
+    element: file
     method: getPath
     variable: path
   description: This function retrieves the path of the given file.
diff --git a/functions/File/fileGetPos.yaml b/functions/File/fileGetPos.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: fileGetPos
   pair: fileSetPos
   oop:
-    entity: file
+    element: file
     method: getPos
     variable: pos
   description: Returns the current read/write position in the given file.
diff --git a/functions/File/fileGetSize.yaml b/functions/File/fileGetSize.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: fileGetSize
   oop:
-    entity: file
+    element: file
     method: getSize
     variable: size
   description: Returns the total size in **bytes** of the given file.
diff --git a/functions/File/fileIsEOF.yaml b/functions/File/fileIsEOF.yaml
@@ -7,7 +7,7 @@ shared: &shared
       content: |
         When you open a file, its file position is set to the beginning of the file. Each call to [[fileRead]] or [[fileWrite]] moves the position ahead by the amount of bytes that were read/written. This way, by using [[fileIsEOF]] you can check if you've passed through the whole file.
   oop:
-    entity: file
+    element: file
     method: isEOF
     variable: eof
   description: Checks if the file position is at the end of the file.
diff --git a/functions/File/fileOpen.yaml b/functions/File/fileOpen.yaml
@@ -4,7 +4,7 @@ shared: &shared
     - type: 'important'
       content: To prevent memory leaks, ensure each successful call to [[fileOpen]] has a matching call to [[fileClose]].
   oop:
-    entity: file
+    element: file
     constructorclass: File
   description: Opens an existing file for reading and writing.
   parameters:
diff --git a/functions/File/fileRead.yaml b/functions/File/fileRead.yaml
@@ -4,7 +4,7 @@ shared: &shared
     - type: 'info'
       content: '[[fileOpen]] sets the read/write position to the beginning of the file. [[fileGetSize]] gets the total size in bytes of given file.'
   oop:
-    entity: file
+    element: file
     method: read
   description: Reads the specified number of bytes from the given file starting at its current read/write position, and returns them as a string.
   parameters:
diff --git a/functions/File/fileRename.yaml b/functions/File/fileRename.yaml
@@ -5,7 +5,7 @@ shared: &shared
       content: |
         Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have `ModifyOtherObjects` [[ACL]] right set to true.
   oop:
-    entity: file
+    element: file
     method: rename
   description: Renames the specified file.
   parameters:
diff --git a/functions/File/fileSetPos.yaml b/functions/File/fileSetPos.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: fileSetPos
   oop:
-    entity: file
+    element: file
     method: setPos
     variable: pos
   description: Sets the current read/write position in the file.
diff --git a/functions/File/fileWrite.yaml b/functions/File/fileWrite.yaml
@@ -5,7 +5,7 @@ shared: &shared
       content: |
         It is important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.
   oop:
-    entity: file
+    element: file
     method: write
   description: Writes one or more strings to a given file, starting at the current read/write position. Advances the position over the number of bytes that were written.
   parameters:
diff --git a/functions/Player/getPlayerName.yaml b/functions/Player/getPlayerName.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'getPlayerName'
   oop:
-    entity: player
+    element: player
     method: getName
     variable: name
   pair: 'setPlayerName'
diff --git a/functions/Vehicle/createVehicle.yaml b/functions/Vehicle/createVehicle.yaml
@@ -11,7 +11,7 @@ shared: &shared
       content: |
         It's worth nothing that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [getElementDistanceFromCentreOfMassToBaseOfModel](/getElementDistanceFromCentreOfMassToBaseOfModel), or you can estimate it yourself and just spawn the vehicle so it drops to the ground.
   oop:
-    entity: vehicle
+    element: vehicle
     constructorclass: Vehicle
   description: |
     This function creates a [vehicle](/vehicle) at the specified location.
diff --git a/functions/Vehicle/setVehicleSirensOn.yaml b/functions/Vehicle/setVehicleSirensOn.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'setVehicleSirensOn'
   oop:
-    entity: vehicle
+    element: vehicle
     method: setSirensOn
     variable: sirensOn
   pair: 'getVehicleSirensOn'
diff --git a/functions/XML/xmlCopyFile.yaml b/functions/XML/xmlCopyFile.yaml
@@ -5,7 +5,7 @@ shared: &shared
       content: |
         To prevent memory leaks, ensure each call to **xmlCopyFile** has a matching call to [xmlUnloadFile](/xmlUnloadFile).
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: copy
   description: |
     This function copies all contents of a certain node in a XML document to a new document file, so the copied node becomes the new file's root node. The new file will not be saved to file system until [xmlSaveFile](/xmlSaveFile) is called.
diff --git a/functions/XML/xmlCreateChild.yaml b/functions/XML/xmlCreateChild.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlCreateChild'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: createChild
   description: |
     This function creates a new child node under an XML node.
diff --git a/functions/XML/xmlCreateFile.yaml b/functions/XML/xmlCreateFile.yaml
@@ -8,7 +8,7 @@ shared: &shared
       content: |
         If you do not want to share the content of the created file with other servers, prepend the file path with @ (See [filepath](/filepath) for more information).
   oop:
-    entity: xmlnode
+    element: xmlnode
     constructorclass: XML
   description: |
     This function creates a new XML document, which can later be saved to a file by using [xmlSaveFile](/xmlSaveFile). This function will overwrite the file specified if it already exists.
diff --git a/functions/XML/xmlDestroyNode.yaml b/functions/XML/xmlDestroyNode.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlDestroyNode'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: destroy
   description: |
     This function destroys a XML node from the XML node tree.
diff --git a/functions/XML/xmlFindChild.yaml b/functions/XML/xmlFindChild.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlFindChild'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: findChild
   description: |
     This function returns a named child node of an XML node.
diff --git a/functions/XML/xmlLoadFile.yaml b/functions/XML/xmlLoadFile.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlLoadFile'
   oop:
-    entity: XML
+    element: xmlnode # This will actually show as XML
     static: true
     method: load
   description: |
diff --git a/functions/XML/xmlLoadString.yaml b/functions/XML/xmlLoadString.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlLoadString'
   oop:
-    entity: XML
+    element: xmlnode # This will actually show as XML
     static: true
     method: loadstring
   description: |
diff --git a/functions/XML/xmlNodeGetAttribute.yaml b/functions/XML/xmlNodeGetAttribute.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: 'xmlNodeGetAttribute'
   pair: 'xmlNodeSetAttribute'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: getAttribute
   description: |
     This function is used to return an attribute of a node in a configuration file.
diff --git a/functions/XML/xmlNodeGetAttributes.yaml b/functions/XML/xmlNodeGetAttributes.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlNodeGetAttributes'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: getAttributes
     variable: attributes
   description: |
diff --git a/functions/XML/xmlNodeGetChildren.yaml b/functions/XML/xmlNodeGetChildren.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlNodeGetChildren'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: getChildren
     variable: children
   description: |
diff --git a/functions/XML/xmlNodeGetName.yaml b/functions/XML/xmlNodeGetName.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: 'xmlNodeGetName'
   pair: 'xmlNodeSetName'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: getName
     variable: name
   description: |
diff --git a/functions/XML/xmlNodeGetParent.yaml b/functions/XML/xmlNodeGetParent.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlNodeGetParent'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: getParent
     variable: parent
   description: |
diff --git a/functions/XML/xmlNodeGetValue.yaml b/functions/XML/xmlNodeGetValue.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: 'xmlNodeGetValue'
   pair: 'xmlNodeSetValue'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: getValue
     variable: value
   description: |
diff --git a/functions/XML/xmlNodeSetAttribute.yaml b/functions/XML/xmlNodeSetAttribute.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: 'xmlNodeSetAttribute'
   pair: 'xmlNodeGetAttribute'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: setAttribute
   description: |
     This function is used to edit an attribute of a node in a configuration file.
diff --git a/functions/XML/xmlNodeSetName.yaml b/functions/XML/xmlNodeSetName.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: 'xmlNodeSetName'
   pair: 'xmlNodeGetName'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: setName
     variable: name
   description: |
diff --git a/functions/XML/xmlNodeSetValue.yaml b/functions/XML/xmlNodeSetValue.yaml
@@ -2,7 +2,7 @@ shared: &shared
   name: 'xmlNodeSetValue'
   pair: 'xmlNodeGetValue'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: setValue
     variable: value
   description: |
diff --git a/functions/XML/xmlSaveFile.yaml b/functions/XML/xmlSaveFile.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlSaveFile'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: saveFile
   description: |
     This function saves a loaded XML file.
diff --git a/functions/XML/xmlUnloadFile.yaml b/functions/XML/xmlUnloadFile.yaml
@@ -1,7 +1,7 @@
 shared: &shared
   name: 'xmlUnloadFile'
   oop:
-    entity: xmlnode
+    element: xmlnode
     method: unload
   description: |
     Unloads an XML document from memory.
diff --git a/schemas/common-defs.yaml b/schemas/common-defs.yaml
diff --git a/schemas/function.yaml b/schemas/function.yaml
diff --git a/web/src/components/CodeExamplesSection.astro b/web/src/components/CodeExamplesSection.astro
diff --git a/web/src/components/ElementOOPInfo.astro b/web/src/components/ElementOOPInfo.astro
diff --git a/web/src/pages/[func].astro b/web/src/pages/[func].astro
diff --git a/web/src/utils/elements.ts b/web/src/utils/elements.ts
diff --git a/web/src/utils/functions.ts b/web/src/utils/functions.ts
