Skip to content

Framework Definitions

Jump to bottom
Garrett Luskey edited this page Jun 19, 2026 · 5 revisions

Threading and Sync Utilities

AllowedThread

[AllowedThread](https://github.com/Bannerlord-Coop-Team/BannerlordCoop/blob/development/source/Common/Util/AllowedThread.cs) is used to temporarily allow original game code to run on the current thread.

Example: [MobilePartyAIPatches.cs](https://github.com/Bannerlord-Coop-Team/BannerlordCoop/blob/development/source/GameInterface/Services/MobilePartyAIs/Patches/MobilePartyAIPatches.cs#L42)

Allowed threads are checked by [CallOriginalPolicy](https://github.com/Bannerlord-Coop-Team/BannerlordCoop/blob/development/source/GameInterface/Policies/CallOriginalPolicy.cs). This is useful when patch logic would normally block or redirect the original game call, but a specific section of code needs to execute the original behavior safely.

Notes:

  • Supports nested usage.
  • Should be used narrowly around the code that needs to bypass patch restrictions.
  • Do not use this as a general workaround for threading issues.

AutoSync

AutoSync automatically sends synchronized value updates from the server to clients.

Example: [MobilePartyAiSync.cs](https://github.com/Bannerlord-Coop-Team/BannerlordCoop/blob/development/source/GameInterface/Services/MobilePartyAIs/MobilePartyAiSync.cs)

Use AutoSync when a server-owned value needs to stay updated on connected clients.

Notes:

  • The server is authoritative.
  • Clients receive updates automatically when synced values change.
  • Custom sync policies are supported, but most use cases should not need them.

GameThread

GameThread is used to run code on the game thread.

Example: [MobilePartyAiHandler.cs](https://github.com/Bannerlord-Coop-Team/BannerlordCoop/blob/development/source/GameInterface/Services/MobilePartyAIs/Handlers/MobilePartyAiHandler.cs#L76)

Use GameThread whenever network code needs to mutate game state. Network handlers run on a separate thread from the game thread, and directly modifying game objects from the network thread can cause unsafe behavior, including unpredictable AccessViolationExceptions.

General rule:

  • Reading simple immutable/network-safe data may be okay from a network handler.
  • Mutating Bannerlord game state should be dispatched through GameThread.
  • When in doubt, use GameThread for game object changes triggered by network messages.

Clone this wiki locally