API UO GetIgnoreList

UO.GetIgnoreList

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

ClassicUO • Runtime API

Создаёт снимок ID, исключённых из обычного поиска этим скриптом.

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

UO.GetIgnoreList() -> Any

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

Параметры

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

Возвращает

Array — serial из Ignore-списка по возрастанию числового ID. Пустой Array при пустом списке. ID могут уже не существовать в мире; это правила поиска, не список видимых предметов.

Поведение

• Читаются данные, уже загруженные клиентом. Команда не открывает контейнер, не перемещает предметы и не загружает объекты со всего сервера.
• Array — массив с индексами от 0. Сохраняйте его в VAR, проверяйте GetArrayLength перед доступом. Элементы могут исчезнуть из мира после создания снимка: перед действием проверяйте Exists(serial).
• Каждый runtime имеет свой набор Ignore. Массив является копией: для изменения правил нужны Ignore, IgnoreOff или IgnoreReset. GetContent/GetEquipment и GetWorldItems без аргументов сами этот фильтр не применяют.

Примеры

Пример 1. Получить размер списка

# Получить размер списка
#
# Создаёт снимок ID, исключённых из обычного поиска этим скриптом.
#
# Array<Integer> — serial из Ignore-списка по возрастанию числового ID. Пустой Array при пустом
# списке. ID могут уже не существовать в мире; это правила поиска, не список видимых предметов.

SUB Main()
    # Параметров нет; читается Ignore-список этого runtime.
    # Длина — число записей/ID. Это не сумма Amount в стопках. Пустой список даёт 0.

    VAR items = UO.GetIgnoreList()
    UO.Print(STR(GetArrayLength(items)))
END SUB

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

• Параметров нет; читается Ignore-список этого runtime.
• Длина — число записей/ID. Это не сумма Amount в стопках. Пустой список даёт 0.

Пример 2. Обойти все найденные ID

# Обойти все найденные ID
#
# Создаёт снимок ID, исключённых из обычного поиска этим скриптом.
#
# Array<Integer> — serial из Ignore-списка по возрастанию числового ID. Пустой Array при пустом
# списке. ID могут уже не существовать в мире; это правила поиска, не список видимых предметов.

SUB Main()
    # Параметров нет; читается Ignore-список этого runtime.
    # items[i] — числовой serial. Hex используется только для вывода. Цикл не обращается за
    # последним индексом.

    VAR items = UO.GetIgnoreList()
    VAR i = 0
    WHILE i < GetArrayLength(items)
        UO.Print('0x' + Hex(items[i]))
        i = i + 1
    WEND
END SUB

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

• Параметров нет; читается Ignore-список этого runtime.
• items[i] — числовой serial. Hex используется только для вывода. Цикл не обращается за последним индексом.

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

# Проверить первую запись перед чтением
#
# Создаёт снимок ID, исключённых из обычного поиска этим скриптом.
#
# Array<Integer> — serial из Ignore-списка по возрастанию числового ID. Пустой Array при пустом
# списке. ID могут уже не существовать в мире; это правила поиска, не список видимых предметов.

SUB Main()
    # Параметров нет; читается Ignore-список этого runtime.
    # Проверяются две разные вещи: запись в снимке и существование объекта сейчас. Порядок без явной
    # сортировки не означает близость.

    VAR items = UO.GetIgnoreList()
    IF GetArrayLength(items) > 0 THEN
        VAR first = items[0]
        IF UO.Exists(first) THEN
            UO.Print(UO.GetName(first))
        END IF
    ELSE
        UO.Print('Empty list')
    END IF
END SUB

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

• Параметров нет; читается Ignore-список этого runtime.
• Проверяются две разные вещи: запись в снимке и существование объекта сейчас. Порядок без явной сортировки не означает близость.