Interface IConVar

Namespace: SwiftlyS2.Shared.Convars

Assembly: SwiftlyS2.CS2.dll

public interface IConVar<T> : IConVar

• T

Implements

• IConVar

Properties

DefaultValue

The default value of the convar.

T DefaultValue { get; set; }

• T

Flags

The flags of the convar.

ConvarFlags Flags { get; set; }

• ConvarFlags

HasDefaultValue

Whether the convar has a default value.

bool HasDefaultValue { get; }

• bool

HasMaxValue

Whether the convar has a max value.

bool HasMaxValue { get; }

• bool

HasMinValue

Whether the convar has a min value.

bool HasMinValue { get; }

• bool

MaxValue

The max value of the convar.

Thrown when the convar is not a min/max type or doesn't have a max value.

T MaxValue { get; set; }

• T

MinValue

The min value of the convar.

Thrown when the convar is not a min/max type or doesn't have a min value.

T MinValue { get; set; }

• T

Value

The value of the convar. When setting, if the convar can be replicated, it will automatically replicate to all clients. Also, setting value with this method will internally put it into a set queue, Which means that for some special case ( e.g. setting sv_enablebunnyhopping inside a hook ) it won't work, in such cases you should use the SetInternal method instead.

T Value { get; set; }

• T

Methods

QueryClient(int, Action<string>)

Query the value of the convar from specified client.

void QueryClient(int clientId, Action<string> callback)

• clientId int
• callback Action<string> — The action to execute with the value.

ReplicateToClient(int, T)

Replicate the value of the convar to specified client.

void ReplicateToClient(int clientId, T value)

• clientId int — The client id to replicate to.
• value T

SetInternal(T)

Internally set the value of the convar. Won't replicate the change to clients.

void SetInternal(T value)

• value T — The value to set.

TryGetDefaultValue(out T)

Try to get the default value of the convar.

bool TryGetDefaultValue(out T defaultValue)

• defaultValue T — The default value of the convar.

• bool — True if the default value is found, false otherwise.

TryGetMaxValue(out T)

Try to get the max value of the convar.

bool TryGetMaxValue(out T maxValue)

• maxValue T — The max value of the convar.

• bool — True if the max value is found, false otherwise.

TryGetMinValue(out T)

Try to get the min value of the convar.

bool TryGetMinValue(out T minValue)

• minValue T — The min value of the convar.

• bool — True if the min value is found, false otherwise.