From 1094efb80c45fb8cf36272e5bffa42a3a81b0c9b Mon Sep 17 00:00:00 2001
From: Kenshin13 <63159154+Kenshiin13@users.noreply.github.com>
Date: Sat, 4 Jan 2025 13:44:21 +0100
Subject: [PATCH] feat(es_extended/client/modules/scaleform): add
 ESX.Scaleform.Utils.RunScaleformMovieMethod util function

---
 .../es_extended/client/modules/scaleform.lua  | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/[core]/es_extended/client/modules/scaleform.lua b/[core]/es_extended/client/modules/scaleform.lua
index 66479685..cdb6c176 100644
--- a/[core]/es_extended/client/modules/scaleform.lua
+++ b/[core]/es_extended/client/modules/scaleform.lua
@@ -99,3 +99,40 @@ function ESX.Scaleform.Utils.RequestScaleformMovie(movie)
 
     return scaleform
 end
+
+--- Executes a method on a scaleform movie with optional arguments and return value.
+--- The caller is responsible for disposing of the scaleform using `SetScaleformMovieAsNoLongerNeeded`.
+---@param scaleform number|string # Scaleform handle or name to request the scaleform movie
+---@param methodName string # The method name to call on the scaleform
+---@param returnValue? boolean # Whether to return the value from the method
+---@param ... number|string|boolean # Arguments to pass to the method
+---@return number, number? # The scaleform handle, and the return value if `returnValue` is true
+function ESX.Scaleform.Utils.RunScaleformMovieMethod(scaleform, methodName, returnValue, ...)
+    scaleform = type(scaleform) == "number" and scaleform or ESX.Scaleform.Utils.RequestScaleformMovie(scaleform)
+    BeginScaleformMovieMethod(scaleform, methodName)
+
+    local args = { ... }
+    for i, arg in ipairs(args) do
+        local typeArg = type(arg)
+
+        if typeArg == "number" then
+            if math.type(arg) == "float" then
+                ScaleformMovieMethodAddParamFloat(arg)
+            else
+                ScaleformMovieMethodAddParamInt(arg)
+            end
+        elseif typeArg == "string" then
+            ScaleformMovieMethodAddParamTextureNameString(arg)
+        elseif typeArg == "boolean" then
+            ScaleformMovieMethodAddParamBool(arg)
+        end
+    end
+
+    if returnValue then
+        return scaleform, EndScaleformMovieMethodReturnValue()
+    end
+
+    EndScaleformMovieMethod()
+
+    return scaleform
+end