GET_TIMECYCLE_MODIFIER_VAR

Hash0xA7109E12

Runtime nameGetTimecycleModifierVar

NamespaceCFX

SideClient

NameOfficial

Docs

Signature

BOOL GET_TIMECYCLE_MODIFIER_VAR(char* modifierName, char* varName, float* value1, float* value2);

Parameters

Name	Type	Description
`modifierName`	`char*`	The name of timecycle modifier.
`varName`	`char*`	The name of timecycle variable.
`value1`	`float*`	—
`value2`	`float*`	—

Returns BOOL — Whether or not variable by name was found on the specified timecycle modifier.

Usage

Lua

local retval, value1, value2 = GetTimecycleModifierVar(modifierName, varName)

-- always works, by hash
local retval, value1, value2 = Citizen.InvokeNative(0xa7109e12, modifierName, varName, Citizen.PointerValueFloat(), Citizen.PointerValueFloat(), Citizen.ReturnResultAnyway())

JavaScript and C#

JavaScript

const [retval, value1, value2] = GetTimecycleModifierVar(modifierName, varName);

// by hash
const [retval, value1, value2] = Citizen.invokeNative('0xa7109e12', modifierName, varName, Citizen.pointerValueFloat(), Citizen.pointerValueFloat(), Citizen.returnResultAnyway());

var value1 = new OutputArgument();
var value2 = new OutputArgument();
bool retval = Function.Call<bool>((Hash)0xa7109e12, modifierName, varName, value1, value2);
// value1.GetResult<float>()
// value2.GetResult<float>()

Pointer (out) arguments are not passed in Lua/JS: their values are returned after the result, in order.

Examples

LUA · Cfx.re native reference

local modifierName = "superDARK"
local varName = "postfx_noise"

if DoesTimecycleModifierHasVar(modifierName, varName) then
  local success, value1, value2 = GetTimecycleModifierVar(modifierName, varName)

  if success then
    print(string.format("[%s] removed var %s with values: %f %f", modifierName, varName, value1, value2))
    RemoveTimecycleModifierVar(modifierName, varName)
  end
else
    SetTimecycleModifierVar(modifierName, varName, 1.0, 1.0)
    print(string.format("[%s] created var %s", modifierName, varName))
end

Sources

Cfx.re native reference

Something wrong or missing? Contribute a verified note — corrections ship through pull requests.