draugnorak/skills/nvgt-engine-dev/references/api-verification-workflow.md

API Verification Workflow

Use this order whenever a user asks NVGT API behavior, signatures, or edge cases.

Step 1: Locate candidate APIs in docs

1. Search doc/src/references/ for the symbol.
2. If the symbol looks include-specific, search doc/src/references/include/.
3. If built-in, search doc/src/references/builtin/.
4. If plugin-related, search doc/src/references/plugin/.

Step 2: Confirm scripted helper behavior

Search release/include/ for wrappers and defaults.

Why:

• Includes often add defaults, convenience behavior, and compatibility layers not visible in short reference pages.

Step 3: Confirm engine truth in C++

When still ambiguous, inspect src/*.cpp bindings:

• Search registration calls: RegisterGlobalFunction, RegisterObjectMethod, RegisterObjectProperty, RegisterFuncdef.
• Verify exact exposed signatures and overloads.
• Read nearby implementation for side effects and constraints.

Step 4: Produce answer/change with evidence

• Cite the exact file(s) used for verification.
• Prefer concise behavior statements over speculation.
• Mark inferred behavior explicitly when not directly declared.

Quick Commands

# Broad symbol search across NVGT docs/includes/source
python3 skills/nvgt-engine-dev/scripts/nvgt_lookup.py "screen_reader_speak" --root ./nvgt-git

# Direct C++ binding verification
rg -n "RegisterGlobalFunction|RegisterObjectMethod|screen_reader_speak" nvgt-git/src