C_CVar.
functionimplementedavailable in: camelot
Returns information on a console variable.
function C_CVar.GetCVarInfo( name: string): (string, string, boolean, boolean, boolean, boolean, boolean)Parameters
| name | type | description |
|---|---|---|
name | string | Name of the CVar to query the value of. Only accepts console variables (i.e. not console commands). |
Returns
| # | name | type | description |
|---|---|---|---|
| 1 | value | string | Current value of the CVar. |
| 2 | defaultValue | string | Default value of the CVar. |
| 3 | isStoredServerAccount | boolean | If the CVar scope is set WoW account-wide. Stored on the server per CVar synchronizeConfig |
| 4 | isStoredServerCharacter | boolean | If the CVar scope is character-specific. Stored on the server per CVar synchronizeConfig |
| 5 | isLockedFromUser | boolean | |
| 6 | 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. |
| 7 | isReadOnly | boolean | Returns true for portal, serverAlert, timingTestError. These CVars cannot be changed. |
In wowlua's emulated client
implementedwowlua models the system behind it. what the statuses mean
Restrictions
sources
Signature and flags: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (CVarScripts system, camelot 1.60.1). Description: warcraft.wiki.gg's API pages ↗, by its contributors, CC BY-SA 4.0 ↗.