Skip to content

BML+ script API reference

The downloadable reference files describe the AngelScript API exposed by BML+. They are intended for editor completion and API lookup; they are not runtime script files and must not be included in a mod package.

  • as.predefined — complete definitions for AngelScript Language Server, including CKAngelScript and BML+.
  • bml-script-mod-api.as — BML+ script mod types, functions, callbacks, and properties.
  • bml-imgui-api.as — Dear ImGui bindings available to scripts.

The SDK installs the same files locally under docs/api. Use <BML-SDK>/docs/api/as.predefined for editor configuration without a network dependency.

An accessor named get_Name() defines an AngelScript property and is normally used as object.Name. A declaration containing @+ transfers a retained reference to BML+ when the corresponding registration succeeds.

Use as.predefined for editor tooling. Use the two smaller files when looking up only the BML+-owned API surface.