Scaleform
The Scaleform library provides GTA V scaleform movie rendering utilities.
Side: Client
Functions
Load
Loads a scaleform movie by name.
local scaleform = Bridge.Scaleform.Load(scaleformName)
-- Returns: number (scaleform handle)
| Parameter | Type | Description |
|---|---|---|
| scaleformName | string | Scaleform movie name |
Unload
Unloads a loaded scaleform.
Bridge.Scaleform.Unload(scaleform)
| Parameter | Type | Description |
|---|---|---|
| scaleform | number | Scaleform handle |
RenderFullscreen
Renders a scaleform fullscreen.
Bridge.Scaleform.RenderFullscreen(scaleform)
| Parameter | Type | Description |
|---|---|---|
| scaleform | number | Scaleform handle |
CallFunction
Calls a function on a scaleform movie.
Bridge.Scaleform.CallFunction(scaleform, functionName, ...)
| Parameter | Type | Description |
|---|---|---|
| scaleform | number | Scaleform handle |
| functionName | string | Function name to call |
| ... | any | Function arguments |
SetupInstructionalButtons
Creates and configures an instructional buttons scaleform.
local scaleform = Bridge.Scaleform.SetupInstructionalButtons(buttons)
-- Returns: number (scaleform handle)
| Parameter | Type | Description |
|---|---|---|
| buttons | table | Array of button definitions { { control, text }, ... } |
RenderInstructionalButtons
Renders an instructional buttons scaleform (call each frame).
Bridge.Scaleform.RenderInstructionalButtons(scaleform)
| Parameter | Type | Description |
|---|---|---|
| scaleform | number | Scaleform handle |