v6.0.2: add "loadRawData" setting - passes file content to engineLoad* functions instead of file path

Author: Fernando-A-Rocha

[examples]/sampobj_red/meta.xml

@@ -5,7 +5,7 @@
 
     <info author="Fernando" name="SAMP Objects Red"
      description="uses newmodels functions to add all SA-MP objects"
-     version="6.0.1"
+     version="6.0.2"
      type="script" />
 
     <!-- IMPORTANT TO HAVE THIS VERSION OR HIGHER SO THAT IT WORKS AS EXPECTED

[examples]/test_vehicles/meta.xml

@@ -1,5 +1,5 @@
 <meta>
-    <include resource="newmodels_red" minversion="6.0.1"/>
+    <include resource="newmodels_red" minversion="6.0.2"/>
     <script src="s_vehicles.lua" type="server"/>
     <script src="s_vehicles_alt.lua" type="server"/>
     <script src="s_test_cmd.lua" type="server"/>

newmodels_red/meta.xml

@@ -1,5 +1,5 @@
 <meta>
-    <info author="FernandoMTA" version="6.0.1" type="script" name="newmodels_red"
+    <info author="FernandoMTA" version="6.0.2" type="script" name="newmodels_red"
     description="Codename Newmodels Red - Adds new vehicle/ped/object models, automatically synced with all players."/>
 
     <!-- IMPORTANT TO HAVE THIS VERSION OR HIGHER SO THAT IT WORKS AS EXPECTED

newmodels_red/models/README.md

@@ -21,6 +21,7 @@ The available options are (any line that doesn't contain a valid setting string
 - `disableAutoFree`
 - `disableTXDTextureFiltering`
 - `enableDFFAlphaTransparency`
+- `loadRawData`
 - `txd=PATH_TO_TXD_FILE_INSIDE_models_FOLDER` (used for shared textures)
 - `dff=PATH_TO_DFF_FILE_INSIDE_models_FOLDER` (used for shared models)
 - `col=PATH_TO_COL_FILE_INSIDE_models_FOLDER` (used for shared collisions)

newmodels_red/models_alt/s_mod_list.lua

@@ -35,7 +35,8 @@
 --
 -- > New parameters added in newmodels v6:
 --
---     None.
+--     'loadRawData' : if true, the mod files will be loaded using the file content data,
+--          and not passing the file path to engineLoad* MTA functions.
 --
 -- ..........................
 -- AVAILABLE TYPES .....

newmodels_red/scripts/core/client_logic.lua

@@ -21,6 +21,13 @@ local LOADING_QUEUE_PHASES = {
 local currFreeIdDelay = 9500   -- ms
 local FREE_ID_DELAY_STEP = 500 -- ms
 
+local function getCustomModelSetting(settings, key)
+    if settings and settings[key] ~= nil then
+        return settings[key]
+    end
+    return DEFAULT_AUTO_MODEL_SETTINGS[key]
+end
+
 local function applyElementCustomModel(element)
     local customModel = elementModels[element]
     if not customModel then return end
@@ -87,7 +94,7 @@ local function finishLoadCustomModel(customModel)
         return
     end
 
-    local enableDFFAlphaTransparency = customInfo.settings.enableDFFAlphaTransparency
+    local enableDFFAlphaTransparency = getCustomModelSetting(customInfo.settings, "enableDFFAlphaTransparency")
 
     if (col and not engineReplaceCOL(col.element, allocatedModel))
         or (txd and not engineImportTXD(txd.element, allocatedModel))
@@ -114,14 +121,14 @@ local function finishLoadCustomModel(customModel)
         reusableModelElements[dff.path] = dff.element
     end
 
-    local disableAutoFree = customInfo.settings.disableAutoFree
-    local lodDistance = customInfo.settings.lodDistance
-    if lodDistance then
+    local disableAutoFree = getCustomModelSetting(customInfo.settings, "disableAutoFree")
+    local lodDistance = getCustomModelSetting(customInfo.settings, "lodDistance")
+    if type(lodDistance) == "number" then
         engineSetModelLODDistance(allocatedModel, lodDistance)
     end
 
-    local physicalPropsGroup = customInfo.settings.physicalPropsGroup
-    if physicalPropsGroup then
+    local physicalPropsGroup = getCustomModelSetting(customInfo.settings, "physicalPropsGroup")
+    if type(physicalPropsGroup) == "number" then
         engineSetModelPhysicalPropertiesGroup(allocatedModel, physicalPropsGroup)
     end
 
@@ -196,7 +203,8 @@ local function beginLoadCustomModelElements(customModel)
     end
 
     local colPath, txdPath, dffPath = customInfo.col, customInfo.txd, customInfo.dff
-    local disableTXDTextureFiltering = customInfo.settings.disableTXDTextureFiltering
+    local disableTXDTextureFiltering = getCustomModelSetting(customInfo.settings, "disableTXDTextureFiltering")
+    local loadRawData = getCustomModelSetting(customInfo.settings, "loadRawData")
 
     local decryptFunc = getNandoDecrypterFunction()
 
@@ -234,10 +242,9 @@ local function beginLoadCustomModelElements(customModel)
         end
         if not modElement then
             onFailedToLoadModFile(customModel, modPath, modType)
-            return false
+            return
         end
         onLoadedModFile(customModel, modType, modPath, modElement)
-        return true
     end
 
     local function loadOneMod(modType, modPath)
@@ -249,12 +256,19 @@ local function beginLoadCustomModelElements(customModel)
                     loadModElement(modType, modPath, data)
                 end) then
                 onFailedToLoadModFile(customModel, modPath, modType)
-                return
             end
-        else
-            if not loadModElement(modType, modPath) then
+        elseif loadRawData then
+            local file = fileOpen(modPath)
+            if not file then
+                onFailedToLoadModFile(customModel, modPath, modType)
                 return
             end
+            local data = fileRead(file, fileGetSize(file))
+            fileClose(file)
+            -- print("Loaded raw data for", modType, "of custom model", customModel)
+            loadModElement(modType, modPath, data)
+        else
+            loadModElement(modType, modPath)
         end
     end
 
@@ -357,7 +371,7 @@ local function beginDownloadModelFiles(customModel)
         return
     end
 
-    if (not customInfo.settings["downloadFilesOnDemand"]) then
+    if (not getCustomModelSetting(customInfo.settings, "downloadFilesOnDemand")) then
         -- No downloading needed, proceed to load model elements
         beginLoadCustomModelElements(customModel)
         return

newmodels_red/scripts/core/server_logic.lua

@@ -21,7 +21,8 @@ end
 -- .................................................................
 
 -- Model settings (from .txt files overriding defaults):
-local DECLARATIVE_SETTINGS = { "disableAutoFree", "disableTXDTextureFiltering", "enableDFFAlphaTransparency" }
+local DECLARATIVE_SETTINGS = { "disableAutoFree", "disableTXDTextureFiltering", "enableDFFAlphaTransparency",
+    "loadRawData" }
 --   - txd=path
 --   - dff=path
 --   - col=path
@@ -123,10 +124,6 @@ local function isAnyFileDownloadOnDemand(filePaths)
 end
 
 local function parseModelSettings(customModel, customModelInfo, thisFullPath, isFromSettingsOption)
-    local customModelSettings = {}
-    for key, value in pairs(DEFAULT_AUTO_MODEL_SETTINGS) do
-        customModelSettings[key] = value
-    end
     local file = fileOpen(thisFullPath, true)
     if not file then
         return false, "failed to open file: " .. thisFullPath
@@ -136,6 +133,7 @@ local function parseModelSettings(customModel, customModelInfo, thisFullPath, is
     if not info then
         return false, "failed to read file: " .. thisFullPath
     end
+    local customModelSettings = {}
     local lines = split(info, "\n")
     for _, settingStr in pairs(lines) do
         settingStr = settingStr:gsub("\r", "")
@@ -396,6 +394,10 @@ local function parseModListEntry(modelType, modInfo)
     if modInfo.metaDownloadFalse then
         settings["downloadFilesOnDemand"] = true
     end
+    -- New setting from v6
+    if modInfo.loadRawData then
+        settings["loadRawData"] = true
+    end
 
     local ncExt = NANDOCRYPT_EXT
 

newmodels_red/scripts/core/shared_config.lua

@@ -5,6 +5,7 @@ DEFAULT_AUTO_MODEL_SETTINGS = {
     ["disableAutoFree"] = false,
     ["disableTXDTextureFiltering"] = false,
     ["enableDFFAlphaTransparency"] = false,
+    ["loadRawData"] = true,
 }
 
 -- For downloadFile behavior