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

На главную

## common.CreateValuedObject( text, table, handledMouseButtons, handledMouseButtonsDbl )

Создает и возвращает новый экземпляр ValuedObject.

Для него можно указать таблицу, которая будет присылаться в обработчик сообщения при клике или наведении курсора мыши на объект. Также можно переназначить клавиши мыши, которые будут вызывать сообщение о клике. Если какая-то клавиша будет отменена для обработки, то объект станет прозрачным для клика этой клавишей мыши.

Замечание: поскольку ValuedObject это userdata, то Lua работает с ними по ссылке, а не по значению.

См. MOUSE_BUTTON_....

    -- библиотека:
    сommon

    -- объявление:
    function CreateValuedObject( text, table, handledMouseButtons, handledMouseButtonsDbl )

    -- параметры:
    text: WString or ValuedText - текстовое описание, впоследствие может быть получено из ValuedObject методом GetText()
    table: table - таблица произвольного вида, содержащая элементы простых типов (boolean, number, string, WString, table); впоследствие может быть получено из ValuedObject методом GetId()
    handledMouseButtons: nil or number (enum MOUSE_BUTTON_...) - если задана, битовая маска, задающая набор клавиш мыши, которые должны обрабатываться при одинарном клике по объекту. По умолчанию обрабатываются все клавиши
    handledMouseButtonsDbl: nil or number (enum MOUSE_BUTTON_...) - если задана, битовая маска, задающая набор клавиш мыши, которые должны обрабатываться при двойном клике по объекту. По умолчанию обрабатываются все клавиши

    -- возвращаемые значения:
    ValuedObject - новый экземпляр ValuedObject

    -- примеры:
    local valuedObject = common.CreateValuedObject( text, {a=1, b="b", c={ 1, 2 }} )
    local valuedObjectLeftClick = common.CreateValuedObject( text, {}, MOUSE_BUTTON_LEFT )
    local valuedObjectNotLeftClick = common.CreateValuedObject( text, {}, common.GetBitOr( MOUSE_BUTTON_RIGHT, MOUSE_BUTTON_MIDDLE ) )

#### Search: CategoryLuaApi CategoryValuedText

CategoryValuedText
EventValuedObjectClicked
EventValuedObjectDoubleClicked
EventValuedObjectMouseOver
FunctionAvatarGetAbilityValuedObject
FunctionAvatarGetBuffValuedObject
FunctionAvatarGetItemValuedObject
FunctionCommonCreateValuedObject
FunctionCommonCreateValuedText
FunctionCommonExtractWStringFromValuedText
FunctionCommonFormatFloat
FunctionCommonFormatInt
FunctionCommonGetApiType
FunctionCommonIsEmptyValuedObject
FunctionCommonIsValuedObject
FunctionCommonIsValuedText
FunctionCommonSetTextValues
FunctionMountGetValuedObject
FunctionSpellLibGetValuedObject
FunctionTextViewSetValuedText
FunctionUnitGetPlayerValuedObject
FunctionUnitGetUnitValuedObject
FunctionValuedObjectGetId
FunctionValuedObjectGetImage
FunctionValuedObjectGetText
FunctionValuedObjectGetType
FunctionValuedTextClearValues
FunctionValuedTextCreateCopy
FunctionValuedTextSetClassVal
FunctionValuedTextSetFormat
FunctionValuedTextSetPlainText
FunctionValuedTextSetVal
TypeValuedObject
TypeValuedText

CategoryLuaApi CategoryFunction CategoryCommon CategoryValuedText CategoryTypes

На главную