Engine functions

Author: FileEX

assets/images/engineLoadTXD-1.png

@@ -0,0 +1,7 @@
+name: 'Engine'
+description: |
+    Engine is a static class that represents functions related to the game engine.
+
+see_also:
+  - 'functions:any:Engine'
+  - 'events:any:Engine'

assets/images/engineLoadTXD-2.png

@@ -0,0 +1,7 @@
+name: 'EngineStreaming'
+description: |
+    EngineStreaming is a static class that represents functions related to the game engine streaming branch.
+
+see_also:
+  - 'functions:any:Engine'
+  - 'events:any:Engine'

assets/images/gta_resource_loading.png

@@ -0,0 +1,8 @@
+name: 'ifp'
+description: |
+  The IFP class represents an archive that stores animations for peds and objects. A single IFP file can contain multiple different animations. 
+  An IFP file can be loaded using [[engineLoadIFP]], after which you can either replace an existing animation using [[engineReplaceAnimation]] or use entirely new custom animations.
+  
+see_also:
+  - 'functions:any:Engine'
+  - 'events:any:Engine'

elements/Engine/Engine.yaml

@@ -0,0 +1,9 @@
+name: 'img'
+description: |
+  The IMG class represents an archive that stores multiple files, including [DFF](/reference/dff), [TXD](/reference/txd), [IFP](/reference/ifp) and [COL](/reference/col) files. GTA uses archives, among other things, to load models and textures - an example of such an archive is `gta3.img`.
+
+  An archive can be loaded using the [engineLoadIMG](/reference/engineLoadIMG) function and then initialized using the [engineAddImage](/reference/engineAddImage) function.
+
+see_also:
+  - 'functions:any:Engine'
+  - 'events:any:Engine'

elements/Engine/EngineStreaming.yaml

@@ -1,5 +1,4 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/EngineAddClothingModel
-shared:
+client:
   name: engineAddClothingModel
   description: This function adds new CJ clothing model.
   parameters:
@@ -8,11 +7,13 @@ shared:
     description: The model that will be added.
   - name: fileName
     type: string
-    description: Name of the file containing the TXD/DFF extension.
-  examples: []
+    description: Name of the file containing the DFF extension.
+  examples: 
+    - path: examples/engineAddClothingModel-1.lua
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if the model was added, and false otherwise.
-  requires_review: true
+      name: result
+    description: Returns **true** if the model was added, and throws an **error** otherwise.
+  version:
+    added: 1.6.0 r23124

elements/Engine/ifp.yaml

@@ -1,5 +1,4 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/EngineAddClothingTXD
-shared:
+client:
   name: engineAddClothingTXD
   description: This function adds new CJ clothing texture.
   parameters:
@@ -9,10 +8,12 @@ shared:
   - name: fileName
     type: string
     description: Name of the file containing the TXD extension.
-  examples: []
+  examples: 
+    - path: examples/engineAddClothingTXD-1.lua
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if the texture was added, and false otherwise.
-  requires_review: true
+      name: result
+    description: Returns **true** if the texture was added, and throws an **error** otherwise.
+  version:
+    added: 1.6.0 r23124

elements/Engine/img.yaml

@@ -1,21 +1,24 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/EngineAddImage
-shared:
+client:
   name: engineAddImage
-  description: This function adds an IMG file container to GTA streamer. After this
-    GTA will asynchronously load models from IMG. **Only two additional archives can
-    be enabled once**
+  pair: engineRemoveImage
+  description: This function adds an IMG file container to GTA streamer. After this GTA will asynchronously load models from IMG.
   parameters:
   - name: imgArchive
     type: img
     description: The IMG file you want to add to GTA world.
-  examples: []
   returns:
     values:
-    - type: boolean
-      name: value
-    description: Returns true if the IMG element was successfully added, false otherwise.
+    - type: bool
+      name: result
+    description: Returns **true** if the IMG element was successfully added, **false** otherwise.
   oop:
     element: img
     method: add
     static: false
-  requires_review: true
+  version:
+    added: 1.6.0 r21695
+    updated: 1.6.0 r21892
+  meta:
+    - changelog:
+        - version: 1.6.0 r21892
+          description: The maximum number of archives that can be enabled once has been increased to **255**; previously, it was limited to just **2** archives enabled once.