Настройка
Объект настройка (setting)
Информация
Как создать настройку?
Думаю, вы и так знаете, что такое настройки и зачем они нужны. Есть функции, которые есть у всех настроек, а есть те, которые есть только у определённых настроек.
Как создавать настройки? Рассмотрим создание чекбокса
Первым аргументом идёт модуль, в который необходимо добавить настройку, а вторым отображаемое имя. То. что мы прописываем :set(true)
при создании настройки делает чекбокс включенным по умолчанию.
Как получить настройку клиента?
Если вы хотите получить значение настройки, установить значение и т д, то вы можете воспользоваться функцией client:get().
Ниже описаны функции, которые есть у всех настроек. Использовать их можно сразу после создания, как в примере выше.
Функции всех настроек
example
- название переменной с настройкой, которая создана при помощи example = checkbox.new(test, "Test Value")
. Вместо неё может быть любой другая настройка. (Например слайдер)
example:name()
Возвращает отображаемое имя настройки.
Тип возвращаемого значения - текст.
example:info(text)
Аргумент | Тип | Описание |
---|---|---|
text | текст | Укажите описание настройки |
Устанавливает описание для настройки.
example:hide(func)
Аргумент | Тип | Описание |
---|---|---|
func | функция | Укажите условие при котором функция будет скрываться |
Используется для того, чтобы настройка скрывалась при определённом условии
Если вы что-либо не поняли, можете ознакомиться с примером.
Функции CheckBox
example:set(value)
Аргумент | Тип | Описание |
---|---|---|
value | логическое | Укажите новое значение чекбокса |
Устанавливает значение чекбоксу (включен/выключен).
example:get()
Возвращает значение чекбокса (включен/выключен).
Тип возвращаемого значения - логическое.
Функции Slider
example:set(value)
Аргумент | Тип | Описание |
---|---|---|
value | число | Укажите новое значение слайдера |
Устанавливает значение слайдеру
example:min(value)
Аргумент | Тип | Описание |
---|---|---|
value | число | Укажите новое минимальное значение слайдера |
Устанавливает минимальное значение слайдеру
example:max(value)
Аргумент | Тип | Описание |
---|---|---|
value | число | Укажите новое максимальное значение слайдера |
Устанавливает максимальное значение слайдеру
example:inc(value)
Аргумент | Тип | Описание |
---|---|---|
value | число | Укажите новый шаг слайдера |
Устанавливает шаг слайдеру. Т.е. значение будет прибавляться/убавляться с этим шагом. (
example:get()
Возвращает значение слайдера.
Тип возвращаемого значения - число.
example:min()
Возвращает минимальное значение слайдера.
Тип возвращаемого значения - число.
example:max()
Возвращает максимальное значение слайдера.
Тип возвращаемого значения - число.
example:inc()
Возвращает шаг слайдера.
Тип возвращаемого значения - число.
Функции ColorPicker
example:set(value)
Аргумент | Тип | Описание |
---|---|---|
value | Укажите новый цвет колорпикера |
Устанавливает новый цвет колорпикеру.
example:get()
Возвращает цвет колорпикера.
Тип возвращаемого значения - цвет.
Функции Mode
example:add(mode)
Аргумент | Тип | Описание |
---|---|---|
mode | текст | Укажите имя нового режима |
Добавляет режим этой настройки
example:is(mode)
Аргумент | Тип | Описание |
---|---|---|
mode | текст | Укажите имя режима, который необходимо проверить |
Возвращает true если указанный режим равен выбранному.
example:get()
Возвращает выбранный режим.
Тип возвращаемого значения - текст
Функции Select
example:add(elmt)
Аргумент | Тип | Описание |
---|---|---|
elmt | текст | Укажите имя нового элемента |
Добавляет элемент этой настройки
example:is(elmt)
Аргумент | Тип | Описание |
---|---|---|
elmt | текст | Укажите имя элемента |
Возвращает true если указанный элемент включен.
Функции Info
Нету :D
Пример:
Функции Input
example:set(value)
Аргумент | Тип | Описание |
---|---|---|
value | текст | Укажите новое значение текстового поля |
Устанавливает новый текст
example:get()
Возвращает текст текстового поля
Тип возвращаемого значения - текст.
Функции Bind
example:key()
Возвращает код клавиши бинда.
Пример:
Last updated