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

UO.CharacterTitle

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

ClassicUO • Runtime API

Читает титул персонажа.

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

UO.CharacterTitle() -> String

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

Параметры

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

Возвращает

String — известное клиенту титул. Пустая строка означает пустое/неизвестное значение либо отсутствие объекта. Это не serial и не путь профиля. Игровое имя/титул не переводится по языку IDE.

Поведение

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

Примеры

Пример 1. Показать текст после входа

# Показать текст после входа
#
# Читает титул персонажа.
#
# String — известное клиенту титул. Пустая строка означает пустое/неизвестное значение либо
# отсутствие объекта. Это не serial и не путь профиля. Игровое имя/титул не переводится по языку
# IDE.

SUB Main()
    # Параметров нет: читается self.
    # Пустая строка обрабатывается явно; это не текст "0".

    VAR text = UO.CharacterTitle()
    IF text <> '' THEN
        UO.Print(text)
    ELSE
        UO.Print('Text is unavailable')
    END IF
END SUB

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

  • Параметров нет: читается self.
  • Пустая строка обрабатывается явно; это не текст "0".

Пример 2. Добавить текст в сообщение журнала

# Добавить текст в сообщение журнала
#
# Читает титул персонажа.
#
# String — известное клиенту титул. Пустая строка означает пустое/неизвестное значение либо
# отсутствие объекта. Это не serial и не путь профиля. Игровое имя/титул не переводится по языку
# IDE.

SUB Main()
    # Читается свой персонаж, значение сохраняется строкой.
    # Оператор + соединяет строки; STR для этого результата не нужен.

    VAR text = UO.CharacterTitle()
    UO.Print('Player титул: ' + text)
END SUB

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

  • Читается свой персонаж, значение сохраняется строкой.
  • Оператор + соединяет строки; STR для этого результата не нужен.

Пример 3. Сравнить два снимка

# Сравнить два снимка
#
# Читает титул персонажа.
#
# String — известное клиенту титул. Пустая строка означает пустое/неизвестное значение либо
# отсутствие объекта. Это не serial и не путь профиля. Игровое имя/титул не переводится по языку
# IDE.

SUB Main()
    # Оба вызова относятся к self; WAIT задаёт паузу 1000 мс.
    # Различие может означать обновление данных либо выход из мира. Пример не меняет имя или титул.

    VAR previous = UO.CharacterTitle()
    WAIT(1000)
    VAR current = UO.CharacterTitle()
    IF previous <> current THEN
        UO.Print('Updated text: ' + current)
    END IF
END SUB

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

  • Оба вызова относятся к self; WAIT задаёт паузу 1000 мс.
  • Различие может означать обновление данных либо выход из мира. Пример не меняет имя или титул.