This is a code generation template for the ApiGear integration suite. It generates an Unreal Engine C++ plugin with full blueprint support based on an object API model and eases the integration of external data into any Unreal Engine project.
Check out the quick start documentation. For more details on ApiGear please visit apigear.io or the ApiGear documentation.
We aim for full feature parity between usage from within Blueprints or UE C++.
| Client | Service | Network Client | Network Service | Simulation Client | |
|---|---|---|---|---|---|
| Blueprint | ✔️ | ✔️ | ✔️ | ✔️ (v3.x and later) | ✔️ |
| UE C++ | ✔️ | ✔️ | ✔️ | ✔️ (v3.x and later) | ✔️ |
💡 Explanation
An API has two sides. One client side which usually consumes events, data or triggers functions. And the service side which produces the data, events to be consumed by the client or reacts to function calls.
In modern architectures these two sides are often distributed in a network. Therefore the plugin can also connect to remote services as a network client.
Furthermore, the plugin can also be connected as simulation client to ApiGears simulation tools. More information
The generated plugin code is regularly tested in these configurations:
| platform | UE4.25 | UE4.27 | UE5.4 | UE5.5 |
|---|---|---|---|---|
| Windows | ✔️ (until v2.x) | ✔️ | ✔️ | ✔️ |
| Linux | ✔️ (until v2.x) | ✔️ | ✔️ | ✔️ |
The template offers the following feature switches which can be enabled during code generation:
api: create interface files and an abstract implementationstubs: create a stub implementation in C++ with some test casesplugin: create a fully functional plugin with including the stub implementations and testsmonitor: create a thin decorator class which can be used to log traffic going through API layerolink: create the adaption layer for the OLink protocol. This can be used to connect to the simulation.