API UO RemoveFigure

UO.RemoveFigure

ClassicUO / Basic IDE

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

Removes the corresponding client-side overlay from WorldMapGump and from Basic runtime figure state.

Синтаксис

UO.RemoveFigure(FigureID:Any) -> Any

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

Параметры

Имя	Назначение
FigureID	Позиционный аргумент этой перегрузки. Подробности использования указаны в описании/фактической ветви runtime ниже.

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

Ограничения

Local client operation only; no server packet is sent.

Примеры

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

Пример 1

SUB Main()
    IF UO.RemoveFigure(figureId) = 0 THEN
        UO.Print('Figure already absent')
    END IF
END SUB

Пример 2

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

Пример 3

SUB Main()
    VAR arg1 = 1 # FigureID
    VAR result = UO.RemoveFigure(arg1)
    UO.Print(CStr(result))
END SUB

Пример 4

SUB ReadResult()
    VAR arg1 = 1 # FigureID
    VAR result = UO.RemoveFigure(arg1)
    UO.Print(CStr(result))
END SUB

SUB Main()
    ReadResult()
END SUB

Реализация и проверка контракта

• InjectionScript.Runtime.InjectionApiUO+<>c__DisplayClass38_0.<RegisterStealthCompatibility>b__0

Соответствующая ветвь совместимого обработчика в InjectionApiUO.cs. Arg(i)/Text(i) читают позицию с нуля; bridge обращается к клиенту. Прямые типизированные перегрузки перечислены выше и могут иметь отдельный маршрут.

{
                    int id = Arg(0);
                    int removed = bridge.RemoveMapFigure(id);
                    state.MapFigures.Remove(id);
                    return new InjectionValue(removed);
                }

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