Core Framework API

This section covers the core simulation and communication logic of the BiguaSim engine. These classes manage the Unreal Engine game loop and the shared memory communication with the Python client.

Game Mode & State

The main GameMode handles the initialization of the world, spawns agents, and registers the server for communication. The GameInstance persists throughout the simulation.

Warning

doxygenclass: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/biguasim-engine/checkouts/v1.0.0/biguasim-engine-docs/xml/index.xml

Warning

doxygenclass: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/biguasim-engine/checkouts/v1.0.0/biguasim-engine-docs/xml/index.xml

Server & Communication

The server classes are responsible for packing and unpacking data via shared memory.

Warning

doxygenclass: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/biguasim-engine/checkouts/v1.0.0/biguasim-engine-docs/xml/index.xml

Warning

doxygenclass: Cannot find file: /home/docs/checkouts/readthedocs.org/user_builds/biguasim-engine/checkouts/v1.0.0/biguasim-engine-docs/xml/index.xml