API Manual and Inspector

Home · BASIC · UO API · A–Z · Examples · Languages

API Manual

The current reference contains 1103 symbols and all 1037 callable command names, with several examples per command. The client reads editable files from the external API Manual folder; reopen the manual in Theia to reload edits. Detailed cards are shared in Russian and partly English; changing the UI language does not translate command identifiers.

API · A–Z · Examples · Audit

Source of truth

The catalogue follows one rule:

Runtime registration → API Manual

Legacy reference text does not prove that a command exists. A symbol appears in the Runtime Manual only when it is registered by the current Basic Runtime. Registered symbols missing from old documentation are added from Runtime metadata; old but unregistered symbols are excluded.

What an entry contains

Each API element can describe:

• exact name and element kind;
• every registered overload and real signature;
• required and optional parameters;
• default and permitted values when defined;
• return value or side effect;
• data source and dispatch route into ClassicUO;
• ignored or compatibility parameters where relevant;
• related properties and elements;
• a valid example in Basic Script syntax.

Command identifiers, parameter names and source syntax are not translated.

User code is separate

User-defined SUB and FUNCTION from AutoLoad or Autoload\Scripts are not Runtime API. They appear in Outline, symbol navigation and static analysis for the selected document, but are not injected into the Runtime catalogue.

API command card modes

Selecting a command first shows a compact card with its exact name, kind, short signature, and return value (or effect).

Expanded information reveals every overload, parameter requirement, default and permitted values, constraints, dependencies, Runtime route, related elements, and a working Basic Script example. Syntax and return remain visible in both views.

Inspector, debugger and output

API Inspector answers “what does this command mean?” It shows the registered syntax, parameter semantics, return/effect, example and technical route. It does not continuously execute every API command.

To inspect the value returned by a concrete call:

1. assign it to a variable;
2. stop on the following line with a breakpoint;
3. inspect Variables or Watch;
4. or print it with UO.Print.

SUB Main()
    VAR hp = UO.GetHP()
    UO.Print('HP: ' + CStr(hp))
END SUB

Locals, globals, watches and call frames belong to debugger panels. Output and Debug Console contain chronological Runtime messages.

Languages

Manual explanations support the language codes EU, RU, UA, FR, DE, IT, ES, ZH, JA and KO. Runtime symbol names and Basic syntax remain unchanged so scripts are portable between UI languages.

Parity audit

A complete audit must report:

Missing from Manual: 0
Not registered in Runtime: 0
Invalid signatures: 0
Duplicate entries: 0
Invalid Basic Script examples: 0

This verifies catalogue parity; it does not replace server-side gameplay testing. If the navigation is empty, follow Troubleshooting.