C_CVar.GetCVarInfo

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Returns information on a console variable.

value, defaultValue, isStoredServerAccount, isStoredServerCharacter, isLockedFromUser, isSecure, isReadOnly = C_CVar.GetCVarInfo(name)
value, defaultValue, isStoredServerAccount, isStoredServerCharacter, isLockedFromUser, isSecure, isReadOnly = GetCVarInfo(name)

Arguments

name

string - Name of the CVar to query the value of. Only accepts console variables (i.e. not console commands).

Returns

value

string - Current value of the CVar.

defaultValue

string - Default value of the CVar.

isStoredServerAccount

boolean - If the CVar scope is set WoW account-wide. Stored on the server per CVar synchronizeConfig

isStoredServerCharacter

boolean - If the CVar scope is character-specific. Stored on the server per CVar synchronizeConfig

isLockedFromUser

boolean

isSecure

boolean - If the CVar cannot be set with SetCVar while in combat, which would fire ADDON_ACTION_BLOCKED. It's also not possible to set these via /console. Most nameplate cvars are secure.

isReadOnly

boolean - Returns true for portal, serverAlert, timingTestError. These CVars cannot be changed.

Patch changes

Patch 10.2.0 (PTR): Moved to the C_CVar namespace. An alias from the old function name still exists but will be removed in a future patch.
Patch 3.0.2 (2008-10-14): Added.