ValueParam

This type represents a value data used by some control types.

circle-info

Note, that this part: <type> is used to designate what exact type the instance of this type is holding. For example, when it says ValueParam<bool>, it means that Get will return a bool value, and Set will accept only the type bool as it's val parameter.

Get

Method

Returns the value.

Arguments

None.

Returns

Type

Description

<type>

Value.

Example

ctrl:GetValue():Get();

GetDirect

Method

Returns the value disrgarding any active keybinds.

Arguments

None.

Returns

Type

Description

<type>

Value.

Example

Set

Method

Sets the value.

circle-info

It is advised to use SetValue method of the control, if any.

Arguments

Name

Type

Description

val

<type>

Value.

Returns

Nothing.

Example

GetHotkeyState

Method

Returns true if there's any active hotkeys.

Arguments

None.

Returns

Type

Description

bool

true if any hotkey is active.

Example

DisableHotkeys

Method

Disables all active hotkeys. This allows you to override the value.

Arguments

None.

Returns

Nothing.

Example

Last updated