View source for CCVar

The <code>CCVar</code> class represents a custom server console variable.
To create a custom cvar, it is done as follows:
<pre>CCVar myCvar( <your cvar name>", <default value>, "Description of the CVar goes here." );</pre>

Using the cvar is done via:
<pre>as_command <your cvar name></pre>
This can be put in the CFG file or in the console.

== Constructors ==
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Constructor
! Description
|-
| <code>CCVar(const string& in szName, float flValue = 0, const string& in szHelpInfo = "", const ConCommandFlags_t flags = ConCommandFlag::None, CVarCallback@ pCallback = null)
| Creates a cvar with the given name, float value, help info, flags and callback.
|-
| <code>CCVar(const string& in szName, const string& in szValue, const string& in szHelpInfo = "", const ConCommandFlags_t flags = ConCommandFlag::None, CVarCallback@ pCallback = null)
| Creates a cvar with the given name, string value, help info, flags and callback.
|}

== Methods ==
{| class="wikitable" style="vertical-align:middle;"
|- style="font-weight:bold; text-align:center;"
! Function
! Description
|-
| <code>const string& GetName() const
| Gets the name of this command.
|-
| <code>const string& GetFullyQualifiedName() const
| Gets the fully qualified name of this command. This is the name that the command is referred to when called.
|-
| <code>const string& GetHelpInfo() const
| Gets the help info describing this command.
|-
| <code>ConCommandKind::Type GetKind() const
| Gets the type of this console command.
|-
| <code>const string& GetOwningModuleName() const
| Gets the name of the module that owns (created) this command.
|-
| <code>bool HasBeenAdded() const
| Whether this command was added to the list of commands. Must be added to be usable from the console.
|-
| <code>const string& GetDefaultValue() const
| Gets the default value for this cvar.
|-
| <code>const string& GetString() const
| Converts the value to a string.
|-
| <code>float GetFloat() const
| Converts the value to a float.
|-
| <code>int GetInt() const
| Converts the value to an integer.
|-
| <code>bool GetBool() const
| Converts the value to a boolean.
|-
| <code>void SetString(const string& in szValue)
| Sets the given string as the value.
|-
| <code>void SetFloat(const float flValue)
| Sets the given float as the value.
|-
| <code>void SetInt(const int iValue)
| Sets the given integer as the value.
|-
| <code>void SetBool(const bool bValue)
| Sets the given boolean as the value.
|}

== Funcdefs ==
<pre>void CVarCallback(CCVar@ cvar, const string& in szOldValue, float flOldValue)</pre>
Called when the command is executed.

[[Category:Scripting]]