Skip to content

Runtime API 24 Persistent State

Codex edited this page Sep 22, 2026 · 10 revisions

Runtime API — Постоянное состояние

Символов: 187

Новые тематические разделы · Алфавитный указатель · Правила и сценарии

Для каждой команды доступна отдельная карточка: актуальные перегрузки, параметры, ограничения и несколько примеров.

Movement

Добавляет переданные значения в одноимённый список совместимости текущего runtime. Элементы сериализуются через |; это изменение локального списка, а не самостоятельное игровое действие.

Client UI

Creates a persistent client-side overlay entry used by the actual ClassicUO WorldMapGump. The map renders line, ellipse, rectangle, direction-arrow and text figure kinds. World-coordinate figures follow the current map transform/zoom; screen-coordinate figures are relative to the map gump. The returned ID is used by UpdateFigure and RemoveFigure.

Magic

Команда служит для добавления заряда гейта в стандартный рунбук Object.

Sound & Visual Environment

Печатает слово Alarm в локальный системный журнал ClassicUO. Используйте как заметку о наступившем условии в скрипте.

Movement

Изменяет состояние галочки в опциях клиента Always Run (если клиент поддерживает эту опцию).

Diagnostics & Introspection

Возвращает 1, если указанное имя вызываемой команды зарегистрировано в runtime, иначе 0. Для проверки числа аргументов используйте ApiSignatureExists, для значений без вызова — ApiParameterExists.

Diagnostics & Introspection

Проверяет зарегистрированное runtime-значение или именованный объект. Возвращает 1 или 0. Пустое имя даёт 0; проверяются варианты с UO. и без префикса.

Diagnostics & Introspection

Возвращает 1, если существует регистрация указанного имени с заданным числом аргументов. Это проверка имени и арности, а не подтверждение типов значений или доступности игрового объекта.

Character

Снимает всё оружие, потом вооружается набором my_name, запомненым предварительно командой SetArm.

Shops & Vendors

Устанавливает автоматический хук для покупки у вендоров.

Shops & Vendors

Расширенная версия AutoBuy с дополнительной фильтрацией по цене и имени предмета.

Shops & Vendors

Устанавливает автоматический хук для продажи вендорам.

Combat

Пытается использовать бинты на текущем персонаже.

Books

Finds the currently open ModernBookGump, verifies that it is editable, updates the visible title/author controls and sends Send_BookHeaderChanged (or the old-protocol header packet when required by the client version).

Speech & Chat

Выполняет жест «поклон» — персонаж кланяется.

Conversion & Compatibility

Устаревшая команда исправления другого нативного клиента. В ClassicUO только печатает сообщение, что такой патч не требуется. Не меняет движение, речь или контейнеры.

Shops & Vendors

К имени вендора name дописывает ключевое слово покупки из файла injection.ini (обычно это buy) и произносит эту фразу, после чего покупает в меню покупки, которое покажет вендор, вещи согласно списку list.

Mobiles

Возвращает указатель на возможность изменения имени указанного персонажа.

Client & Connection

Sends a tokenized 0x73 ping packet and waits for the matching server echo up to timeoutMS. It does not substitute IsOnline() for a network round trip.

World & Geometry

Положительный результат требует достижения конечной точки. Превышение лимита обхода и недопустимые координаты не считаются успехом.

Client UI

Изменяет состояние галочки в опциях клиента Transparency Circle.

Client UI

Clears every client-side map figure created through the Basic AddFigure API. Normal World Map marker files/user markers are not affected.

Client UI

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

Client & Connection

Закрыть окно клиента Ultima Online.

Client UI

Меняет цвет текста, который пишет Injection в консоли.

Client & Connection

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

Menus & Context Menus

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

Menus & Context Menus

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

World & Geometry

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

Character

Снимает предметы из обеих рук (правой и левой) в рюкзак персонажа.

Client & Connection

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

Character

Слезть с коня, причём в бекпак положить "седло" - обьект связаный с лошадью, см.

World & Geometry

Возвращает расстояние в тайлах между двумя точками ( X1 , Y1 ) и ( X2 , Y2 ).

Items

Reads or mutates the current ClassicUO item/equipment state through the registered runtime route and client action queue.

Diagnostics & Introspection

Записывает все вещи известные в мире в лог-файл, с указанием основных параметров.

Items

Старая команда поддерживаемая для совместимости.

Speech & Chat

Передаёт строковое имя анимации/действия в GameActions.EmoteAction. Это действие персонажа, а не печать обычного текста в журнал.

Conversion & Compatibility

Декодирует буквенную запись EasyUO в числовой идентификатор. Обе команды используют DecodeEasyUoId; результат — Integer, а не hex-строка.

Conversion & Compatibility

Преобразует буквенную запись serial EasyUO (основание 26, A=0) в hex-строку Injection. Буквы нечувствительны к регистру; небуквенные символы пропускаются. Обратная функция — Inj2EUO.

Items

Проверяет, присутствует ли serial в загруженном мире клиента: 1 — объект найден, 0 — нет. Строковая перегрузка сначала разрешает имя объекта. Отсутствие в клиентском мире не доказывает удаление на сервере.

Diagnostics & Introspection

Возвращает расширенную информацию о персонаже в виде записи TExtendedInfo .

Client UI

Writes to the Info Window through the client text-information route. It does not merely emit a normal in-game/system chat message.

Client UI

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

Speech & Chat

Reads, filters or emits speech/journal data through the registered ClassicUO runtime route.

Sound & Visual Environment

Включает/выключает разрешение на изменение погоды.

Speech & Chat

Устаревшая команда исправления другого нативного клиента. В ClassicUO только печатает сообщение, что такой патч не требуется. Не меняет движение, речь или контейнеры.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Client UI

Устанавливает цвет речи вашего персонажа.

Items

Удаляет обьект из памяти Injection.

Journal

Compatibility alias for the pattern-selection state used by journal searches. For 'first|second|third', matching second sets FoundedParamId() to 1. It no longer exposes the internal ClassicUO journal text/message type.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Scripts & Runtime

Возвращает 1, если процедура найдена менеджером Basic и сейчас выполняется, иначе 0. Аргумент — имя процедуры.

Client & Connection

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Items

Возвращает «альтернативное имя» объекта с ObjID .

Shops & Vendors

Возвращает задержку (в миллисекундах), применяемую после каждой операции авто-покупки через AutoBuy или AutoBuyEx .

Shops & Vendors

Возвращает задержку (в миллисекундах), применяемую после каждой операции авто-продажи через AutoSell .

Buffs & Effects

Возвращает список активных баффов и дебаффов персонажа.

Localization

Возвращает текст тултипа объекта с ObjID в виде готовой строки.

Localization

Возвращает локализованную cliloc-строку по указанному ClilocID .

Items

Возвращает цвет (hue) объекта с ObjID .

Containers

Возвращает содержимое контейнера с ID в виде массива записей TContentItemData .

Character

Reads Dexterity from PlayerMobile. UO.GetDex() is equivalent to reading the active player's value. UO.GetDex(self) reads the same value.

Movement

Возвращает параметр обьекта (по умолчанию - персонажа игрока) - направление, от 0 до 7

Profiles & Configuration

Возвращает значение глобальной переменной EasyUO по её индексу num .

Items

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Items

Возвращает параметр обьекта (по умолчанию - персонажа игрока) - тип обьекта

Diagnostics & Introspection

В текущей реализации принимает точную строку "character" и возвращает имя своего персонажа. Для любого другого значения возвращает строку "UNKNOWN". Это не команда окна Info и не универсальный запрос произвольного свойства.

Character

Reads Intelligence from PlayerMobile. UO.GetInt() is equivalent to reading the active player's value. UO.GetInt(self) reads the same value.

Items

Читает флаг паралича загруженного персонажа: 1 — IsParalyzed установлен, иначе 0. Не проверяет замок сундука или двери.

World & Geometry

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Mobiles

Возвращает детальные данные о мобайле с ID в виде записи TMobileData .

Mobiles

Enumerates loaded World.Mobiles only; ordinary Item objects are excluded. Optional filters and nearest ordering are applied by the shared Search Core.

Items

Возвращает имя объекта с ObjID .

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Containers

Возвращает ID родительского контейнера объекта с ObjID .

Shops & Vendors

Возвращает цену объекта с ObjID .

Items

Возвращает размер стека (количество) объекта с ObjID .

Quests & Virtues

Returns the quest-arrow state directly as [exists, x, y]. This is the Basic adaptation of the historical Pascal var/out point.

Character

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Movement

Возвращает параметр обьекта (по умолчанию - персонажа игрока) - бежит ли он.

Character

Возвращает состояние блокировки указанной характеристики.

Character

Reads Strength from PlayerMobile. UO.GetStr() is equivalent to reading the active player's value. UO.GetStr(self) reads the same value.

World & Geometry

Возвращает среднюю высоту поверхности (Z) ландшафтных тайлов в указанной точке карты.

Character

Возвращает титул (суффикс) объекта или мобила с указанным ObjID .

Items

Reads the current Object Property List. If the OPL is not cached yet, Basic requests it from the shard and waits up to approximately 200 ms, polling without blocking the ClassicUO UI thread. If data arrives, the object name and property text are combined into one string.

Items

If structured OPL data is not cached, requests it and waits up to approximately 120 ms without blocking the UI thread.

Localization

Возвращает CodePage кодировки Encoding.Default текущего .NET runtime. Это не переключатель языка клиента и не обещание Windows ANSI-кодировки; современный .NET обычно возвращает UTF-8 (65001).

Files / JSON / Data

Разбивает строку на слова и возвращает слово с индексом ОТ НУЛЯ. Без delimiter используются пробельные символы, пустые части удаляются. Недоступный индекс возвращает пустую строку.

Containers

Возвращает специальное значение, обозначающее землю как цель или место назначения в методах работы с предметами и поиска.

Diagnostics & Introspection

Печатает подсказку об использовании UO.* и пути к Manual в настройках Basic. Это краткая подсказка, а не загрузка справки из интернета.

Client UI

Отправляет серверу запрос на показ окна помощи (аналогично нажатию кнопки «Help» в игровом клиенте).

Conversion & Compatibility

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

HTTP

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

HTTP

Performs an HTTP GET. The one-argument form returns/uses the registered text semantics; the LStream overload writes raw response bytes to a supported Basic MemoryStream/File target.

HTTP

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

HTTP

Operates on the active Basic/ClassicUO runtime, network or profile state through the registered implementation route.

Diagnostics & Introspection

Без аргумента включает локальный прицел для выбора загруженного предмета или персонажа. После выбора открывает окно Basic Object Information и выводит информацию в журнал. Форма Info(serial) сразу выводит текст об указанном объекте в журнал и не открывает инспектор. Если интерактивный выбор недоступен, форма без аргумента использует lasttarget. Для земли и статических тайлов служит InfoTile.

Diagnostics & Introspection

Выводит цвет объекта в журнал в шестнадцатеричном виде 0xHHHH. Без аргумента используется lasttarget; возвращаемого значения нет.

Conversion & Compatibility

Преобразует 32-битный serial в буквенную запись с основанием 26 (A=0). Serial=0 даёт "A". Обратная функция — EUO2Inj.

Party

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Character

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Conversion & Compatibility

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Party

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Character

мобайл has the female flag set, False otherwise.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Multis & Houses

Возвращает True , если указанный объект является мульти-объектом (дом, корабль или другая многотайловая структура), иначе False .

Items

Возвращает True , если указанный объект является перемещаемым, иначе False .

Character

Читает зарегистрированное значение текущего состояния персонажа/клиента или runtime. Тип указан в сигнатуре; для записи используйте соответствующий Set-метод, если он зарегистрирован.

Character

мобайл is paralyzed (frozen), False otherwise.

Movement

мобайл is currently running, False otherwise.

Character

Возвращает True , если у указанного мобайла жёлтая полоса здоровья (указывает на неуязвимость или особый статус), иначе False .

Mouse & Keyboard

Эмулирует нажатие клавиши по Windows virtual-key коду. Необязательные count и delay задают число повторений и задержку после каждого нажатия: по умолчанию 1 и 105 мс. Press является алиасом KeyPress. Ввод получает активное окно ОС; команда сама не активирует клиент.

Scripts & Runtime

Запускает внешнюю программу filename с параметрами parameter

Sound & Visual Environment

Изменяет освещение в игре.

Journal

Возвращает серийный номер (ID) говорящего из последней найденной записи журнала.

Journal

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Journal

Возвращает имя говорящего из последней найденной записи журнала.

World & Geometry

LOSOptions is no longer a state-only setting. UO.CheckLOS(...) consumes the current value on every check. The Basic implementation evaluates the currently loaded ClassicUO map, land, static, multi and world-item tile data. Walls and impassable tiles block LOS; RunUO mode also respects NoShoot; POL can opt into NoShoot and window-through behavior with the flags above.

Search

Выводит текущий список найденных serial через | в формате 0xXXXXXXXX. Не запускает новый поиск.

Mobiles

Возвращает True , если указанный мобайл может быть переименован (например, пет или фолловер), иначе False .

Client UI

Меняет тело вашего персонажа на указаный тип.

Speech & Chat

Выводит текст на сервер.

Movement

Отправляет серверу запрос на открытие двери перед персонажем.

Character

Возвращает True , если собственный персонаж в данный момент парализован (заморожен), иначе False .

Party

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Party

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Party

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Party

Reads the currently loaded ClassicUO map/tile/art asset data using the active client asset loaders.

Items

Возвращает 1, если курсор клиента удерживает поднятый предмет, иначе 0. Это состояние операции переноса, не состояние target.

Sound & Visual Environment

Воспроизводит WAV-файл асинхронно.

Movement

Возвращает предсказанную координату X персонажа на основе текущей траектории движения.

Movement

Возвращает предсказанную координату Y персонажа на основе текущей траектории движения.

Movement

Возвращает предсказанную координату Z (высоту) персонажа на основе текущей траектории движения.

Mouse & Keyboard

Эмулирует нажатие клавиши по Windows virtual-key коду. Необязательные count и delay задают число повторений и задержку после каждого нажатия: по умолчанию 1 и 105 мс. Press является алиасом KeyPress. Ввод получает активное окно ОС; команда сама не активирует клиент.

Proxy

Reports proxy state only. It deliberately does not return the game-server IP as a fake proxy address.

Proxy

Reports proxy state only and does not mirror the game-server port.

Quests & Virtues

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Files / JSON / Data

Возвращает случайное целое число в диапазоне 0..maxnumber

Mobiles

Посылает запрос переименования персонажа mobile в newName. Сервер решает, разрешено ли переименование. Команда ничего не возвращает.

Mobiles

Отправляет серверу запрос на переименование указанного мобайла.

Character

Отправляет серверу пакет запроса статуса для указанного мобайла.

Client & Connection

Обновляет как минимум точные координаты персонажа, а на многих шардах так же окружающие предметы.

Speech & Chat

Выполняет анимацию салюта (эмоцию) персонажем.

Conversion & Compatibility

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Profiles & Configuration

В этой реализации изменяет только три именованные настройки: finddistance (расстояние поиска), grabdelay (задержка переноса в мс), equipfordress (режим экипировки при Dress). Имена сравниваются без учёта регистра. Числовая и строковая перегрузки используют один путь; строка поддерживает 0x/0X, неверное число превращается в 0. Неизвестное имя не меняет настройки и не вызывает ошибку. Это не универсальный setter всех 310 runtime-значений.

Character

The values are no longer stored as inert runtime-only strings. Basic passes them into the actual ClassicUO reconnect selection pipeline:

Character

Запоминает одетое на персонаже вооружение под именем набора Name.

Shops & Vendors

Устанавливает задержку (в миллисекундах) между автоматическими покупками, запускаемыми AutoBuy / AutoBuyEx .

Shops & Vendors

Устанавливает задержку (в миллисекундах) между автоматическими продажами, запускаемыми AutoSell .

Search

Помечает тайл карты как непроходимый для системы поиска пути.

Containers

Назначает контейнер в качестве «catch bag» — все предметы, получаемые персонажем (добыча, обмен и т.д.), автоматически перемещаются в этот контейнер.

Profiles & Configuration

Команда служит для установки руны по умолчанию в стандартном рунбуке.

Profiles & Configuration

Записывает значение в общий реестр EasyUO (только Windows).

Scripts & Runtime

Registers or removes a legacy Basic event handler. Registration captures the current state and does not execute the handler immediately. Supported live events are SeeNewPlayer, Death, ChangeHitPoints, ChangeMana, and ChangeStamina; they are evaluated while the script yields through UO.Wait. repeat=FALSE/0 is one-shot and is automatically disabled after the first matching transition; repeat=TRUE/1 remains armed. For historical compatibility, a non-numeric third argument such as 'exec OnChange' is treated as the handler name and enables repeating mode.

Scripts & Runtime

Registers a repeating handler through the same live-state event engine as UO.SetEvent. Procname='' unregisters the event. Registration does not execute the handler immediately; the handler is evaluated on subsequent UO.Wait yields when the documented event transition occurs.

Record / Playback

UO.SetRec() is the one-shot recorder. It clears the previous recording, arms capture, then lets the next compatible legacy UO.* command execute normally while storing the command name together with its typed arguments. The recorder disarms immediately after that one capture; UO.UseRec() replays the saved action.

Sound & Visual Environment

Устанавливает сезон согласно season_num: 0 - по умолчанию (текущий) 1 - spring (весна) 2 - summer (лето) 3 - fall (осень) 4 - winter (зима) 5 - desolation (засуха)

Client UI

Сохраняет локальный флаг showZ (0/1). В этот флаг не подключён к отрисовке: команда сама не включает отображение высоты. Не следует описывать её как действующий переключатель UI.

Client UI

Controls automatic diagnostic output to the Info Window. When silent mode is disabled (False), Gump description/query helpers may both return their data and mirror the lines into the Info Window. When silent mode is enabled (True), those helpers return data without automatic Info Window output.

Character

Отправляет серверу запрос на изменение состояния блокировки характеристики персонажа.

Character

Алиас для SetStatLockState .

Client & Connection

Возвращает имя шарда, к которому персонаж сейчас подключён (или был подключён последним).

Conversion & Compatibility

Зарегистрированное совместимое имя, выполнение которого в ClassicUO явно запрещено: выбрасывает NativeSubrutineException. Windows не выключается. Не используйте как рабочую команду завершения системы.

Client UI

Сохраняет снимок клиента через TakeScreenshot. Без аргументов выбираются стандартное имя, quality=100 и includeUi=1. quality ограничивается 1–100; includeUi определяет включение интерфейса. Возвращает результат клиентской операции сохранения.

Skills

Открывает пустой контейнер, аналогичный Object, или показаному прицелом если параметры не указаны.

Sound & Visual Environment

Проигрывает игровой звук согласно номеру sndnumber.

Skills

Возвращает количество шагов, которые сделал персонаж в скрытном (Stealth) режиме.

Diagnostics & Introspection

Returns information about the actual product version and embedded ClassicUO / BadNewbie / Basic IDE runtime as [productName, productVersion, clientPath]. The version is sourced from the current Basic IDE product version instead of the old hard-coded compatibility value 1.0.

Character

Reads or changes the requested mobile/player stat/state through the current ClassicUO world model and registered API bridge.

Sound & Visual Environment

Возвращает сохранённую метку Timer в десятых долях секунды. В этой реализации она обновляется, в частности, при успешной проверке Move(). Это не отдельный счётчик кадров анимации.

Items

Возвращает сохранённую метку UO.Timer для применения объекта. Единица — десятая доля секунды.

Character

Переключает режим полёта для персонажа-Гаргульи.

Character

Убирает из памяти запомненый набор вооружения Name.

Containers

Сбрасывает текущий «catch bag».

Items

Ищет объект указанного типа и цвета на земле, затем использует (double-click) его.

Character

Открывает скролл статуса персонажа (Character Status, из окна папердолла) для указанного мобайла.

Proxy

Compatibility query for proxy mode. The current ClassicUO/Basic embedded runtime does not expose a separate proxy transport, so this returns 0 rather than pretending the normal game connection is a proxy.

Record / Playback

Replays the command and typed arguments stored by the UO.SetRec() recorder through the same legacy compatibility dispatcher. Replay does not consume the recording, so the same action can be executed repeatedly. If no valid recording exists, UO.UseRec() performs no action and reports the missing recording in a connected client.

Character

Открывает скролл статуса персонажа (Character Status, из окна папердолла) для текущего персонажа.

Quests & Virtues

Активирует указанную добродетель.

Diagnostics & Introspection

Prints the real Basic product version from the active ClassicUO / BadNewbie / Basic IDE client. The value is sourced from the live product-version bridge and is not a hard-coded compatibility placeholder.

Clone this wiki locally