Пользовательские дополнения

На главную


options.GetOptionInfo( optionId )

Возвращает информацию о данной опции.

-- библиотека:
options

-- объявление:
function GetOptionInfo( optionId )

-- параметры:
optionId: ObjectId - идентификатор опции

-- возвращаемые значения:
таблица с полями:
isEnabled: boolean - разрешена ли опция
isNeedPreview: boolean - нужно ли использовать режим предварительного просмотра
isPreview: boolean - находится ли опция в режиме предварительного просмотра

dataType: number( enum ) - тип данных для опции, возможные значения:
 UI_OPTION_DATA_FIXED - неизменяемая опция
 UI_OPTION_DATA_BOOLEAN - два состояния, 0 и 1
 UI_OPTION_DATA_DISCRETE - диапазон значений: [0..N]
 UI_OPTION_DATA_DISCRETE_FLOAT - диапазон значений [0..N] - число градаций, доступных через опции (в коде автоматически транслируется в вещественный диапазон [minRangeValue..maxRangeValue] - собственно значение опции, где minRangeValue и maxRangeValue - поля соответствующей опции в базе, скрипту они недоступны)
 UI_OPTION_DATA_ACTION - выполнение специального действия

viewType: number (enum) - стандартный тип визуализации для опции, возможные значения:
 UI_OPTION_VIEW_LABEL - Label, TextView и т.п. - для показа заголовков
 UI_OPTION_VIEW_CHECKBOX - CheckButton и т.п. - для показа состояния включено/выключено
 UI_OPTION_VIEW_RADIO - RadioButton, RadioGroup и т.п. - зарезервировано
 UI_OPTION_VIEW_SLIDER - показ диапазона в виде слайдера
 UI_OPTION_VIEW_LIST - показ диапазона в виде списка
 UI_OPTION_VIEW_PUSH_BUTTON - визуализация для UI_OPTION_DATA_ACTION

sysCustomId: string - идентификатор пользовательской опции

sysCustomType: string - уникальный идентификатор опции для возможной специальной визуализации и обработки

name: WString - название опции
description: WString - описание (или тултип/комментарий и т.п.) опции

useAttemptWarning: WString - предупреждение на попытку использования

minName: WString - название для минимальной границы диапазона значений опции (если используется)
minDescription: WString - описание для минимальной границы диапазона значений опции (если используется)
maxName: WString - название для максимальной границы диапазона значений опции (если используется)
maxDescription: WString - описание для максимальной границы диапазона значений опции (если используется)

currentIndex: number (int) - текущий индекс из диапазона значений опции - для дискретного типа данных

defaultIndex: number (int) - значение (индекс) по умолчанию опции - для дискретного типа данных
baseIndex: number (int) - значение (индекс) опции, которое используется в текущий момент (исключая превью) - для дискретного типа данных

values: таблица - описание и данные для всех элементов диапазона значений опции - для дискретного типа данных, если данная таблица не используется - она пуста (не содержит элементов), поля:
 name: WString - название для значения
 description: WString - описание для значения
 stringValue: String - текстовое значение, если используются символьные константы
 floatValue: number (float) - реальная величина, используемая для данного значения (индекса)

valueCount: number (int) - диапазон значений опции [0..valueCount - 1] для случая, когда не используется таблица "values" (пуста)

isRestartToApply: boolean - нужен ли перезапуск клиента для вступления настройки в силу

-- пример:
local optionInfo = options.GetOptionInfo( optionId )

Search: "CategoryLuaApi" "CategoryOptions"

EventOptionChanged
FunctionOptionsApply
FunctionOptionsCancel
FunctionOptionsCancelPreview
FunctionOptionsGetBlockIds
FunctionOptionsGetCollectionInfo
FunctionOptionsGetGroupIds
FunctionOptionsGetOptionByCustomId
FunctionOptionsGetOptionIds
FunctionOptionsGetOptionInfo
FunctionOptionsGetOptionsByCustomType
FunctionOptionsGetPageIds
FunctionOptionsPreview
FunctionOptionsResetToDefault
FunctionOptionsSetOptionCurrentIndex
FunctionOptionsUpdate


CategoryLuaApi CategoryFunction CategoryOptions

На главную