API UO SetGump - LIHACHTETAN/ClassicUO-BadNewbie-BasicIDE GitHub Wiki

UO.SetGump

ClassicUO / Basic IDE

Оглавление · Алфавитный указатель · Gumps

Reads or updates the current client UI/Gump state through the registered Basic/ClassicUO UI route.

Синтаксис

UO.SetGump(identifier:Any, key:Any, stateValue:Any) -> Unit
UO.SetGump(gumpId:Any, identifier:Any, key:Any, stateValue:Any) -> Unit

Регистр имени не важен. Any — динамическое значение Basic; Unit — отсутствие возвращаемого значения. Integer — знаковое 32-битное число, Decimal — число с плавающей точкой. Правила типов, serial, индексов и ожиданий.

Параметры

Имя Назначение
identifier Позиционный аргумент этой перегрузки. Подробности использования указаны в описании/фактической ветви runtime ниже.
key Named runtime value (String); use the exact registered/saved name expected by SetGump.
stateValue Boolean-like value: TRUE/1 enables the option and FALSE/0 disables it unless Behavior documents another numeric mode.
gumpId Numeric identifier (Variant). Use the ID domain documented by this command; 0 is a sentinel only when Behavior/Notes explicitly says so.

Параметры обязательны внутри каждой показанной сигнатуры. Опустить аргумент можно только при наличии более короткой перегрузки; пропуск позиции посередине не подразумевается.

Возвращает: Unit — значения нет. Выполняйте вызов отдельной строкой; его нельзя использовать как проверку успеха. Эффект и ограничения зависят от команды.

Примеры

Каждый блок — самостоятельный скрипт из мануала проекта. Параметры демонстрационного объекта/контейнера и условия действия необходимо сопоставить с вашей игровой ситуацией.

Пример 1

SUB Main()
    UO.SetGump(0, 0, 0)
END SUB

Пример 2

SUB Main()
    UO.SetGump(0, 0, 0, 0)
END SUB

Пример 3

SUB Main()
    UO.SetGump(1, 2, 3)
END SUB

Пример 4

SUB Main()
    VAR arg1 = 0 # gumpId
    VAR arg2 = 2 # identifier
    VAR arg3 = 3 # key
    VAR arg4 = 4 # stateValue
    UO.SetGump(arg1, arg2, arg3, arg4)
END SUB

Пример 5

SUB Main()
    IF UO.Connected THEN
        VAR arg1 = 1 # identifier
        VAR arg2 = 2 # key
        VAR arg3 = 3 # stateValue
        UO.SetGump(arg1, arg2, arg3)
    END IF
END SUB

Пример 6

SUB RunAction()
    VAR arg1 = 1 # identifier
    VAR arg2 = 2 # key
    VAR arg3 = 3 # stateValue
    UO.SetGump(arg1, arg2, arg3)
END SUB

SUB Main()
    # Запуск процедуры выполняет действие:
    RunAction()
END SUB
Реализация и проверка контракта
  • InjectionScript.Runtime.InjectionApiUO.SetGump

Источник реестра и отчёт сверки. Примеры проверяются загрузчиком/парсером включённого runtime. Действия на игровом сервере этой проверкой не исполняются.

⚠️ **GitHub.com Fallback** ⚠️