asbind20: C++20 AngelScript binding library

asbind20 is a C++20 AngelScript binding library powered by templates.

Although the interface of AngelScript is very friendly to C++ comparing to most binding APIs from other script languages, it still needs many additional proxy functions, e.g., when binding a constructor. However, most of these proxies have similar logic, so they can be generated by some template tricks.

Besides, this library provides tools for easily calling a script function, as well as RAII helpers for managing lifetime of AngelScript objects.

In general, this library aims to automate everything that can be generated by template meta-programming.

The name and API design are inspired by the famous pybind11 library.

Core Features

• Conveniently bind C++ functions / classes to AngelScript, including auto-generated wrappers for constructors / factories / operators.

• Tools for passing arguments to and receiving return value from script functions, without manually choosing the correct function for different types.

• Generating generic wrapper for functions of any parameter count at compile-time, without using any macro.

• RAII tools for managing lifetime of script objects.

• Container for storing script objects.

Extension Library

The extension library was developed for personal project at first, but most of them are general purpose and can be used in other projects. Actually, the whole asbind20 was a submodule of personal project long time ago.

It also contains demonstration for how to register some common types like array or string by asbind20.

License

This library is licensed under the MIT License.

Contents:

• Changelog

Getting Started

• Prerequisites
• Supported Platforms
• Integrate into Your Project
  • 1. Copy into Your Project
  • 2. Integration Using CMake
  • 3. Integration with XMake Projects

Registering Application Interfaces

• Registering an Object Type
  • Registering a Reference Type
  • Registering a Value Type
  • Object Methods
  • Object Properties
  • Registering Types with Similar Interfaces
  • Operator Overloads
  • Member Aliases
  • Template Types
• Global Functions and Properties
  • Registering Global Functions
  • Registering Global Properties
  • Special Functions
• Auxiliary Interfaces
  • Registering an Interface
  • Type Aliases
  • Enumerations

Using AngelScript Interfaces

• Invoking Script Interfaces
  • Invoking a Script Function
  • Using a Script Class
  • Reference of Invocation Tools
• Storing Script Objects
  • Storing a Single Script Object
  • Containers

Utilities

• RAII Helpers
• IO Helpers
• Miscellaneous Utilities
• Debugging

Advanced Topics

• Customize Type Conversion Rules
• Script Initialization List
• Handling AngelScript Types
• Garbage Collected Types
• Generic Wrappers
• Multithreading

Extra Resources

• Troubleshooting
• Known Issues
• Build Guide for Contributors

Extension Library

• Extension Library