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

UO.Snap

ClassicUO / Basic IDE

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

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

Синтаксис

UO.Snap() -> Integer
UO.Snap(name:String) -> Integer
UO.Snap(name:String, quality:Integer) -> Integer
UO.Snap(file:Any, quality:Any, includeUI:Any) -> Integer

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

Параметры

Имя Назначение
name Значение для данной позиции; назначение и поддерживаемые варианты показаны в описании и примерах.
quality Позиционный аргумент этой перегрузки. Подробности использования указаны в описании/фактической ветви runtime ниже.
file Позиционный аргумент этой перегрузки. Подробности использования указаны в описании/фактической ветви runtime ниже.
includeUI Позиционный аргумент этой перегрузки. Подробности использования указаны в описании/фактической ветви runtime ниже.

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

Примеры

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

Пример 1

SUB Main()
    VAR result = UO.Snap()
    UO.Print(CStr(result))
END SUB

Пример 2

SUB Main()
    VAR arg1 = 'example.txt' # file
    VAR arg2 = 2 # quality
    VAR arg3 = 3 # includeUI
    VAR result = UO.Snap(arg1, arg2, arg3)
    UO.Print(CStr(result))
END SUB

Пример 3

SUB Main()
    VAR result = UO.Snap('example')
    UO.Print(CStr(result))
END SUB

Пример 4

SUB Main()
    VAR result = UO.Snap('example', 2)
    UO.Print(CStr(result))
END SUB

Пример 5

SUB Main()
    VAR result = UO.Snap()
    # Пример порога; выберите подходящий смыслу команды.
    IF result > 0 THEN
        UO.Print(CStr(result))
    END IF
END SUB

Пример 6

FUNCTION ReadResult()
    VAR result = UO.Snap()
    RETURN result
END FUNCTION

SUB Main()
    VAR answer = ReadResult()
    UO.Print(CStr(answer))
END SUB
Реализация и проверка контракта
  • InjectionScript.Runtime.InjectionApiUO.<Register>b__37_13
  • InjectionScript.Runtime.InjectionApiUO.Snap

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

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