API UO GetWorldNum

UO.GetWorldNum

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

ClassicUO • Runtime API

Читает номер текущей карты из модели клиента.

Точный синтаксис

UO.GetWorldNum() -> Integer

Выберите одну из зарегистрированных форм. Параметры передаются позиционно. Any означает значение BASIC с преобразованием внутри команды; Unit — отсутствие возвращаемого значения.

Параметры

Параметров нет.

Возвращает

Integer — индекс текущей карты клиента, обычно 0=Felucca, 1=Trammel, 2=Ilshenar, 3=Malas, 4=Tokuno, 5=Ter Mur. Пользовательский сервер может использовать иной набор карт. 0 — полноценная карта, не признак ошибки.

Поведение

• Читаются уже полученные локальные данные. Запрос не открывает status и не заставляет сервер прислать обновление. После смерти, перехода карты или удаления объекта значения могут измениться между двумя вызовами.
• Это функции чтения: присваивание результата переменной сохраняет снимок. Оно не изменяет характеристику персонажа. Имена нечувствительны к регистру; используйте именно показанную форму с нужным числом аргументов.

Примеры

Пример 1. Вывести текущее значение своего персонажа

# Вывести текущее значение своего персонажа
#
# Читает номер текущей карты из модели клиента.
#
# Integer — индекс текущей карты клиента, обычно 0=Felucca, 1=Trammel, 2=Ilshenar, 3=Malas,
# 4=Tokuno, 5=Ter Mur. Пользовательский сервер может использовать иной набор карт. 0 —
# полноценная карта, не признак ошибки.

SUB Main()
    # Вызов без аргументов относится к self. Номер текущей карты сохраняется в value.
    # STR преобразует число для вывода и не меняет смысл результата.

    VAR value = UO.GetWorldNum()
    UO.Print('GetWorldNum: ' + STR(value))
END SUB

Разбор параметров и выполнения:

• Вызов без аргументов относится к self. Номер текущей карты сохраняется в value.
• STR преобразует число для вывода и не меняет смысл результата.

Пример 2. Использовать значение в прикладной проверке

# Использовать значение в прикладной проверке
#
# Читает номер текущей карты из модели клиента.
#
# Integer — индекс текущей карты клиента, обычно 0=Felucca, 1=Trammel, 2=Ilshenar, 3=Malas,
# 4=Tokuno, 5=Ter Mur. Пользовательский сервер может использовать иной набор карт. 0 —
# полноценная карта, не признак ошибки.

SUB Main()
    # Значение читается один раз без аргументов. Номер текущей карты используется в показанном
    # расчёте или условии.
    # Числовые пороги — пример условий скрипта, а не новые пределы клиента. Поле сохраняет серверные
    # единицы и ограничения, описанные выше.

    VAR value = UO.GetWorldNum()
    VAR land = UO.GetLandscapeTile(UO.GetX(), UO.GetY(), value)
    UO.Print('Land record length: ' + STR(GetArrayLength(land)))
END SUB

Разбор параметров и выполнения:

• Значение читается один раз без аргументов. Номер текущей карты используется в показанном расчёте или условии.
• Числовые пороги — пример условий скрипта, а не новые пределы клиента. Поле сохраняет серверные единицы и ограничения, описанные выше.

Пример 3. Наблюдать изменение за одну секунду

# Наблюдать изменение за одну секунду
#
# Читает номер текущей карты из модели клиента.
#
# Integer — индекс текущей карты клиента, обычно 0=Felucca, 1=Trammel, 2=Ilshenar, 3=Malas,
# 4=Tokuno, 5=Ter Mur. Пользовательский сервер может использовать иной набор карт. 0 —
# полноценная карта, не признак ошибки.

SUB Main()
    # Оба вызова без аргумента читают своё текущее значение. WAIT(1000) даёт паузу в миллисекундах
    # между снимками.
    # Сравнивается изменение: номер текущей карты. Пример ничего не изменяет в мире и не ждёт
    # бесконечно. События внутри этой секунды могут быть пропущены.

    VAR before = UO.GetWorldNum()
    WAIT(1000)
    VAR after = UO.GetWorldNum()
    IF before <> after THEN
        UO.Print('Before: ' + STR(before) + '; after: ' + STR(after))
    END IF
END SUB

Разбор параметров и выполнения:

• Оба вызова без аргумента читают своё текущее значение. WAIT(1000) даёт паузу в миллисекундах между снимками.
• Сравнивается изменение: номер текущей карты. Пример ничего не изменяет в мире и не ждёт бесконечно. События внутри этой секунды могут быть пропущены.