ReflectiveAngelScriptWrapper

An experimental C++ wrapper for AngelScript that makes use of the recently-implemented reflection features of C++26.

This library's documentation assumes you are already familiar with AngelScript and its features. If you are not, then visit the AngelScript website.

The primary goal of this template library is to greatly reduce the registration code required to set up your application interface. Without it, you would have to register all of your classes, global variables, global functions, enums, etc., manually, which is error prone and a headache to maintain.

This wrapper does not aim to put AngelScript in a black box: you can directly access, for example, the engine object, if you need to.

Table of Contents

0. Prerequisites
1. Wrappers
   • SharedObject and OwnedObject
   • Engine
2. Typenames
   • TypeName
     • Template Types
   • TmplTypeName
   • TypeOf
3. Properties
   • Engine::RegisterGlobalProperty()
   • Const Global Properties By Default
4. Functions
   • Engine::RegisterGlobalFunction()
   • Function Overloading
   • Call Convention
     • Generic Call Convention
   • GetFuncDecl()
     • Value Types
     • Reference Types
     • Default Values
     • Auto Handles
     • Variable Parameter Type
     • Const Qualification
   • Variadic Arguments and Template Functions
5. Funcdefs
   • Engine::RegisterFuncdef()
   • asIScriptFunction Pointers and the Funcdef Annotation
   • Scoped Funcdefs
6. Reference Types
   • RefType Annotation
   • Basic Behaviors
     • Factories
       • Factories With Auxiliary Objects
     • AddRef, Release and as::ReferenceType
       • as::WeakReferenceType
   • Naming Your Type
   • Methods
   • Properties
   • Property Accessors
   • Composite Members
   • Exclusion
   • Inheritance
7. Typedefs
8. Enums
9. Interfaces
   • Engine::RegisterInterface()
     • Interface Inheritance
     • Multiple Inheritance
     • What's Registered
     • C++ Namespaces Are Ignored
     • The Same Interface is Never Registered More Than Once
     • Excluding Interfaces From Registration
     • Mixin Interfaces
10. Value Types

GCC 16.1.0

You will need to separately build GCC 16.1.0 and install it at the root of this repository within a gcc-16.1.0 folder. In the future I want the ./set_up.sh script to carry this out for you, but I can't get it to work for now, so use these as starting points until I can figure it out:

• How to install gcc-14 on Ubuntu 22.04 and 24.04?.
• Building gcc from source.
• Installing GCC.

Scripts

All scripts must be executed whilst the current working directory is the root of the repository!

1. Execute ./set_up.sh. This will install clang-format-18 (not required for the build).
2. Execute ./build.sh. This will configure and build the AngelScript wrapper library.
   • You can execute ./build.sh -r to remove debug symbols from the build.
   • You can execute ./build.sh -c if you need to perform a clean configure and build.
   • You can execute ./build.sh -t to build and run the tests as well as the library.
   • You can execute ./build.sh -d to build and run the tests (via GDB) as well as the library.
   • Note the use of a pre-built version of GCC that supports C++26 features like reflection. It must live in a gcc-16.1.0 folder at the root of the repository.