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

UO.GetPing

ClassicUO / Basic IDE

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

Без аргумента возвращает сохранённый ServerPing из статистики соединения. Форма с timeout инициирует проверку ping через клиентское соединение и ждёт ответ до указанного срока в миллисекундах. Не перепутайте с отдельной функцией ICMP Ping произвольного узла.

Синтаксис

UO.GetPing() -> Integer
UO.GetPing(timeout:Any) -> Integer

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

Параметры

Имя Назначение
timeout Время в миллисекундах, если в описании команды не указана другая единица. Проверяйте отдельно значение 0.

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

Примеры

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

Пример 1

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

Пример 2

SUB Main()
    VAR arg1 = 1000 # timeout
    VAR result = UO.GetPing(arg1)
    UO.Print(CStr(result))
END SUB

Пример 3

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

Пример 4

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

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

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

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