AddConvarChangeListener - FiveM Natives @ Cfx.re Docs

FiveM Docs / Native Reference

Namespace: CFXAPI set: sharededitImprove

ADD_CONVAR_CHANGE_LISTENER

0xAB7F7241

// AddConvarChangeListener
int ADD_CONVAR_CHANGE_LISTENER(char* conVarFilter, func handler);

Parameters:

conVarFilter:
The Console Variable to listen for, this can be a pattern like "test:*", or null for any
handler:
The handler function.

Returns:

A cookie to remove the change handler.

Adds a listener for Console Variable changes.

The function called expects to match the following signature:

function ConVarChangeListener(conVarName: string, reserved: any);

conVarName: The ConVar that changed.
reserved: Currently unused.

Examples:

JavaScript

// listen for all convar changes
AddConvarChangeListener(null, (conVarName, reserved) => {
    print(GetConvarInt(conVarName))
})

// listen to convars that start with "script:"
AddConvarChangeListener("script:*", (conVarName, reserved) => {
    print(GetConvarInt(conVarName))
})

ACTIVATE_TIMECYCLE_EDITOR

ADD_AUDIO_SUBMIX_OUTPUT(int submixId, int outputSubmixId)

_ADD_BLIP_FOR_AREA(float x, float y, float z, float width, float height)

ADD_BLIP_FOR_COORD(float x, float y, float z)

ADD_BLIP_FOR_ENTITY(Entity entity)

ADD_BLIP_FOR_RADIUS(float posX, float posY, float posZ, float radius)

ADD_CONVAR_CHANGE_LISTENER(char* conVarFilter, func handler)

ADD_MINIMAP_OVERLAY(char* name)

ADD_MINIMAP_OVERLAY_WITH_DEPTH(char* name, int depth)

ADD_PED_DECORATION_FROM_HASHES(Ped ped, Hash collection, Hash overlay)

ADD_REPLACE_TEXTURE(char* origTxd, char* origTxn, char* newTxd, char* newTxn)

ADD_STATE_BAG_CHANGE_HANDLER(char* keyFilter, char* bagFilter, func handler)

ADD_TEXT_ENTRY(char* entryKey, char* entryText)

ADD_TEXT_ENTRY_BY_HASH(Hash entryKey, char* entryText)

APPLY_FORCE_TO_ENTITY(Entity entity, int forceType, float x, float y, float z, float offX, float offY, float offZ, int boneIndex, BOOL isDirectionRel, BOOL ignoreUpVec, BOOL isForceRel, BOOL p12, BOOL p13)

APPLY_WEATHER_CYCLES(int numEntries, int msPerCycle)

BREAK_OFF_VEHICLE_WHEEL(Vehicle vehicle, int wheelIndex, BOOL leaveDebrisTrail, BOOL deleteWheel, BOOL unknownFlag, BOOL putOnFire)

CALL_MINIMAP_SCALEFORM_FUNCTION(int miniMap, char* fnName)

CAN_PLAYER_START_COMMERCE_SESSION(char* playerSrc)

CLEAR_PED_PROP(Ped ped, int propId)

CLEAR_PED_SECONDARY_TASK(Ped ped)

CLEAR_PED_TASKS(Ped ped)

CLEAR_PED_TASKS_IMMEDIATELY(Ped ped)

CLEAR_PLAYER_WANTED_LEVEL(Player player)

CLEAR_VEHICLE_XENON_LIGHTS_CUSTOM_COLOR(Vehicle vehicle)

CLONE_TIMECYCLE_MODIFIER(char* sourceModifierName, char* clonedModifierName)

COMMIT_RUNTIME_TEXTURE(long tex)

CREATE_AUDIO_SUBMIX(char* name)

CREATE_DRY_VOLUME(float xMin, float yMin, float zMin, float xMax, float yMax, float zMax)

CREATE_DUI(char* url, int width, int height)

CREATE_OBJECT(Hash modelHash, float x, float y, float z, BOOL isNetwork, BOOL netMissionEntity, BOOL doorFlag)

CREATE_OBJECT_NO_OFFSET(Hash modelHash, float x, float y, float z, BOOL isNetwork, BOOL netMissionEntity, BOOL doorFlag)