classDocs / console / Variable

console.Variable

classsharedsource

Object → console.Command → console.Variable

The console variable object.

Constructor

console.Variable(options: console.VariableOptions): console.Variable

Fields

Name	Type	Description
`value`	`T`	The value of the variable.
`type`	`console.VariableType`	The type of the variable (e.g., "int", "string").
`name`	`string`	The name of the variable.
`description`	`string`	The description of the variable.
`flags`	`integer`	The flags of the variable.
`default`	`T`	The default value of the variable.
`min`	`T \| nil`	The minimum value of the variable (if applicable).
`max`	`T \| nil`	The maximum value of the variable (if applicable).

Static functions

`get`	Gets a console.Variable object by its name.
`getBoolean`	Gets the value of the console.Variable object as a boolean.
`getBounds`	Returns the minimum and maximum values of the console.Variable object.
`getDefault`	Gets the default value of the console.Variable object.
`getDescription`	Gets the help text of the console.Variable object.
`getFlags`	Gets the flags of the console.Variable object.
`getFloat`	Gets the value of the console.Variable object as a float/double.
`getInteger`	Gets the value of the console.Variable object as an integer.
`getMax`	Gets the maximum value of the console.Variable object.
`getMin`	Gets the minimum value of the console.Variable object.
`getString`	Gets the value of the console.Variable object as a string.
`isFlagSet`	Checks if the flag is set on the console.Variable object.
`revert`	Reverts the value of the console.Variable object to its default value.
`set`	Sets the value of the console.Variable object.

#console.Variable.get

sharednodiscardsource

function console.Variable.get(name: string, cvar_type: console.VariableType): console.Variable

Gets a console.Variable object by its name.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.
`cvar_type`	`console.VariableType`	The type of the console variable.

Returns

Type	Name	Description
`console.Variable`	`variable`	The `console.Variable` object.

Overloads

function console.Variable.get(name: string, cvar_type: "boolean"): console.Variable<boolean>

function console.Variable.get(name: string, cvar_type: "integer"): console.Variable<integer>

function console.Variable.get(name: string, cvar_type: "number"): console.Variable<number>

function console.Variable.get(name: string, cvar_type: "string"): console.Variable<string>

#console.Variable.getBoolean

sharednodiscardsource

function console.Variable.getBoolean(name: string): boolean

Gets the value of the console.Variable object as a boolean.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`boolean`	`value`	The value of the `console.Variable` object.

#console.Variable.getBounds

sharednodiscardsource

function console.Variable.getBounds(name: string): number, number

Returns the minimum and maximum values of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`number`	`minimum`	The minimum value of the `console.Variable` object.
`number`	`maximum`	The maximum value of the `console.Variable` object.

#console.Variable.getDefault

sharednodiscardsource

function console.Variable.getDefault(name: string): string

Gets the default value of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`string`	`default`	The default value of the `console.Variable` object.

#console.Variable.getDescription

sharednodiscardsource

function console.Variable.getDescription(name: string): string

Gets the help text of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`string`	`help`	The help text of the `console.Variable` object.

#console.Variable.getFlags

sharednodiscardsource

function console.Variable.getFlags(name: string): integer

Gets the flags of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`integer`	`flags`	The flags of the `console.Variable` object.

#console.Variable.getFloat

sharednodiscardsource

function console.Variable.getFloat(name: string): number

Gets the value of the console.Variable object as a float/double.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`number`	`value`	The value of the `console.Variable` object.

#console.Variable.getInteger

sharednodiscardsource

function console.Variable.getInteger(name: string): integer

Gets the value of the console.Variable object as an integer.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`integer`	`value`	The value of the `console.Variable` object.

#console.Variable.getMax

sharednodiscardsource

function console.Variable.getMax(name: string): number

Gets the maximum value of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`number`	`maximum`	The maximum value of the `console.Variable` object.

#console.Variable.getMin

sharednodiscardsource

function console.Variable.getMin(name: string): number

Gets the minimum value of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`number`	`minimum`	The minimum value of the `console.Variable` object.

#console.Variable.getString

sharednodiscardsource

function console.Variable.getString(name: string): string

Gets the value of the console.Variable object as a string.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`string`	`value`	The value of the `console.Variable` object.

#console.Variable.isFlagSet

sharednodiscardsource

function console.Variable.isFlagSet(name: string, flags: integer): boolean

Checks if the flag is set on the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.
`flags`	`integer`	The flags to check.

Returns

Type	Name	Description
`boolean`	`is_set`	`true` if the flag is set on the `console.Variable` object, `false` otherwise.

#console.Variable.revert

sharedsource

function console.Variable.revert(name: string): boolean

Reverts the value of the console.Variable object to its default value.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.

Returns

Type	Name	Description
`boolean`	`success`	`true` if the value was set (or the command to set it was sent), `false` otherwise.

#console.Variable.set

sharedsource

function console.Variable.set(name: string, value: console.VariableValue): boolean

Sets the value of the console.Variable object.

Parameters

Name	Type	Description
`name`	`string`	The name of the console variable.
`value`	`console.VariableValue`	The value to set.

Returns

Type	Name	Description
`boolean`	`success`	`true` if the value was set (or the command to set it was sent), `false` otherwise.

Methods

`attach`	Attaches a handler called on every change of the variable, attaching the same handler twice is a no-op.
`await`	Waits for the console.Variable object to change.
`clear`	Removes every handler of the variable, pending handlers of a running change are skipped.
`detach`	Detaches a handler previously passed to attach or once.
`once`	Attaches a one-shot handler, detached right before the next change calls it.
`revert`	Reverts the value of the console.Variable object to its default value.

#Variable:attach

sharedsource

function console.Variable:attach(handler: fun( variable: console.Variable<T>, value: T ) | Hook | Event)

Attaches a handler called on every change of the variable, attaching the same handler twice is a no-op.

Handlers run in protected mode, one failing handler is reported and never stops the others. While they run variable.value still holds the old value, the new one is passed as value.

Parameters

Name	Type	Description
`handler`	`fun( variable: console.Variable<T>, value: T ) \| Hook \| Event`	The callback or callable object.

#Variable:await

sharedasyncsource

async function console.Variable:await(): console.Variable<T>, T

Waits for the console.Variable object to change.

Returns

Type	Name	Description
`console.Variable<T>`	`variable`
`T`	`new_value`

#Variable:clear

sharedsource

function console.Variable:clear()

Removes every handler of the variable, pending handlers of a running change are skipped.

#Variable:detach

sharedsource

function console.Variable:detach(handler: fun( variable: console.Variable<T>, value: T ) | Hook | Event): boolean

Detaches a handler previously passed to attach or once.

Parameters

Name	Type	Description
`handler`	`fun( variable: console.Variable<T>, value: T ) \| Hook \| Event`	The exact handler reference.

Returns

Type	Name	Description
`boolean`	`removed`	`true` if the handler was attached.

#Variable:once

sharedsource

function console.Variable:once(handler: fun( variable: console.Variable<T>, value: T ) | Hook | Event)

Attaches a one-shot handler, detached right before the next change calls it.

Parameters

Name	Type	Description
`handler`	`fun( variable: console.Variable<T>, value: T ) \| Hook \| Event`	The callback or callable object.

#Variable:revert

sharedsource

function console.Variable:revert(): T

Reverts the value of the console.Variable object to its default value.

Returns

Type	Name	Description
`T`	`default`	The default value of the `console.Variable` object.

Inherited methods

From console.Command 2

isBlacklisted run