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

UO.moveCheckStamina

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

ClassicUO • Runtime API

Минимальная выносливость для команд движения.

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

UO.moveCheckStamina() -> Any
UO.moveCheckStamina(value:Any) -> Any

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

Параметры

  • value — Необязательное новое значение. Целое >=0; отрицательное становится 0. Ноль выключает проверку порога.

Возвращает

Integer — текущее сохранённое значение. Без аргумента только читает; с аргументом возвращает значение после применения правил выше. Это настройка, не результат движения.

Поведение

  • Настройка хранится в состоянии runtime и используется соответствующими командами при запуске; изменение не переписывает уже построенный путь автоматически.
  • Возврат исходного значения показан для обычного завершения. После аварийной остановки следующие строки восстановления не выполняются.
  • По умолчанию 1. Значение 0 отключает эту локальную проверку; положительное задаёт минимальную выносливость. Ниже порога запуск отклоняется или движение останавливается, а не ждёт восстановления выносливости.

Примеры

Пример 1. Прочитать настройку

# Прочитать настройку
#
# Минимальная выносливость для команд движения.
#
# Integer — текущее сохранённое значение. Без аргумента только читает; с аргументом возвращает
# значение после применения правил выше. Это настройка, не результат движения.

SUB Main()
    # Аргументов нет, состояние не меняется.
    # value — числовое значение этой настройки.

    VAR value = UO.moveCheckStamina()
    UO.Print(STR(value))
END SUB

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

  • Аргументов нет, состояние не меняется.
  • value — числовое значение этой настройки.

Пример 2. Установить явное значение

# Установить явное значение
#
# Минимальная выносливость для команд движения.
#
# Integer — текущее сохранённое значение. Без аргумента только читает; с аргументом возвращает
# значение после применения правил выше. Это настройка, не результат движения.

SUB Main()
    # value=15. Целое >=0; отрицательное становится 0. Ноль выключает проверку порога.
    # applied показывает сохранённое значение, а не успешное достижение цели.

    VAR applied = UO.moveCheckStamina(15)
    UO.Print('Applied: ' + STR(applied))
END SUB

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

  • value=15. Целое >=0; отрицательное становится 0. Ноль выключает проверку порога.
  • applied показывает сохранённое значение, а не успешное достижение цели.

Пример 3. Применить на один участок скрипта

# Применить на один участок скрипта
#
# Минимальная выносливость для команд движения.
#
# Integer — текущее сохранённое значение. Без аргумента только читает; с аргументом возвращает
# значение после применения правил выше. Это настройка, не результат движения.

SUB Main()
    # previous хранит исходную настройку; NewMoveXY ограничен 3000 мс.
    # Последняя команда восстанавливает настройку после обычного возврата движения.

    VAR previous = UO.moveCheckStamina()
    UO.moveCheckStamina(15)
    VAR ok = UO.NewMoveXY(UO.GetX() + 2, UO.GetY(), TRUE, 0, FALSE, 0, 3000)
    UO.moveCheckStamina(previous)
    UO.Print(STR(ok))
END SUB

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

  • previous хранит исходную настройку; NewMoveXY ограничен 3000 мс.
  • Последняя команда восстанавливает настройку после обычного возврата движения.