ConVar < Handle

Last Updated2021-10-23
Created At2014-12-10

A ConVar is a configurable, named setting in the srcds console.

Methods14
SymbolDescription
AddChangeHookCreates a hook for when a console variable's value is changed.
GetBoundsRetrieves the specified bound of a console variable.
GetDefaultRetrieves the default string value of a console variable.
GetDescriptionRetrieves the description of a console variable.
GetNameRetrieves the name of a console variable.
GetStringRetrieves the string value of a console variable.
RemoveChangeHookRemoves a hook for when a console variable's value is changed.
ReplicateToClientReplicates a convar value to a specific client. This does not change the actual convar value.
RestoreDefaultResets the console variable to its default value. Note: The replicate and notify params are only relevant for the original, Dark Messiah, and Episode 1 engines. Newer engines automatically do these things when the convar value is changed.
SetBoolSets the boolean value of a console variable. Note: The replicate and notify params are only relevant for the original, Dark Messiah, and Episode 1 engines. Newer engines automatically do these things when the convar value is changed.
SetBoundsSets the specified bound of a console variable.
SetFloatSets the floating point value of a console variable. Note: The replicate and notify params are only relevant for the original, Dark Messiah, and Episode 1 engines. Newer engines automatically do these things when the convar value is changed.
SetIntSets the integer value of a console variable. Note: The replicate and notify params are only relevant for the original, Dark Messiah, and Episode 1 engines. Newer engines automatically do these things when the convar value is changed.
SetStringSets the string value of a console variable. Note: The replicate and notify params are only relevant for the original, Dark Messiah, and Episode 1 engines. Newer engines automatically do these things when the convar value is changed.
Properties5
SymbolTypeDescription
BoolValueboolRetrieves or sets a boolean value for the convar.
FlagsintGets or sets the flag bits (FCVAR_*) on the convar.
FloatValuefloatRetrieves or sets a float value for the convar.
IntValueintRetrieves or sets an integer value for the convar.
PluginHandleRetrieves the plugin handle of the convar's creator