Class ConVarBase

Namespace

CounterStrikeSharp.API.Modules.Cvars

Assembly

CounterStrikeSharp.API.dll

public class ConVarBase : IEquatable<ConVarBase>

Inheritance

object

ConVarBase

Implements

IEquatable<ConVarBase>

Derived

ConVar<T>

Constructors

ConVarBase(ushort)

public ConVarBase(ushort accessIndex)

Parameters

accessIndex ushort

Properties

AccessIndex

public ushort AccessIndex { get; protected set; }

Property Value

ushort

Description

public string Description { get; }

Property Value

string

Flags

The ConVar flags as defined by ConVarFlags.

public ConVarFlags Flags { get; set; }

Property Value

ConVarFlags

IsValid

public bool IsValid { get; }

Property Value

bool

Name

public string Name { get; }

Property Value

string

Public

Shorthand for checking the FCVAR_NOTIFY flag.

public bool Public { get; set; }

Property Value

bool

Type

The underlying data type of the ConVar.

public ConVarType Type { get; }

Property Value

ConVarType

ValueAsString

public string ValueAsString { get; set; }

Property Value

string

Methods

As<T>()

public ConVar<T> As<T>()

Returns

ConVar<T>

Type Parameters

T

Delete()

public void Delete()

Equals(ConVarBase?)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ConVarBase? other)

Parameters

other ConVarBase

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.