Overview

The API Reference is the technical companion to add-on development.

Use it when you need precise information about a specific function, type, constant, or behavior. It is designed to answer practical questions quickly: how something is called, what values it expects, what it returns, and what constraints apply.

This guide is intentionally factual. It does not try to teach every concept from the beginning. Instead, it provides clear reference material you can return to while building, debugging, or maintaining an add-on.

How to read this reference

Most pages follow the same structure: a short description, syntax, parameters, return value, remarks, examples, requirements, and related entries.

Read the description first to confirm you are looking at the right entry. Then use the syntax and parameter sections when writing code. Use the remarks section for important details, limitations, or recommended usage.

Examples are meant to show typical usage. They are not exhaustive.

For new add-on developers

If you are new to add-on development, start with the Add-ons Development Guide.

That guide explains the overall workflow and the concepts behind add-ons. The API Reference becomes more useful once you know what you are trying to build and need exact details.

Conventions

Function names are written with parentheses, such as FormatString().

Parameter names are shown in code style, such as message or formatString.

Optional parameters are shown in square brackets in the syntax section.

Unless stated otherwise, text values use UTF-8 and numeric values use SI units.