Native extension XML reference

Extension reference combines registered API structure with explanations you write. A generator obtains classes and constants, not their purpose, units, or limitations.

Export structure

The extension must load at project startup. This example needs DocsNativeProbe, ProductVersion=10000, and EntityPathVariant=22. Loading inside _Ready() is too late for --doctool, which does not run the ordinary game level.

Set $Editor to the installed editor, $Project to the project directory, and $Output to a separate existing documentation directory:

& $Editor --headless --path "$Project" --doctool "$Output" --reckfellextension-docs --quit

Extension output goes to $Output/doc_classes/. The check produced DocsNativeProbe.xml with parent Entity and two constants. Do not choose unrelated documentation: the tool loads/merges existing XML and regenerates output. This exports reference data, not engine sources.

Add useful prose

Write the brief description, class purpose, constants, methods, parameters, and returns. Include units, refusal conditions, and a reproducible example. Keep names and types consistent with registration.

The C ABI provides editor_help_load_xml_from_utf8_chars and a length-taking variant for supplying editor descriptions. Obtain the function through get_proc and supply valid UTF-8 XML; placing XML beside a DLL alone is insufficient. Editor help interfaces do not imply that window exists in exported games.

After changing registration, compare XML with the actually loaded class. Separately open editor help and inspect prose and links: a valid XML file does not prove correct rendering.

Export and XML parsing checked class name, parent, and constant values. Editor help rendering, localization of custom XML, and distribution with game exports were not tested.