Mount & Blade II: Bannerlord Modding Documentation

MBDebug is a utility class providing helper functions to easily display debugging information in-game, such as rendering lines or arrows to visualize game state (e.g., caravan paths).

Note: Many of its visual debugging functions require the _RGL_KEEP_ASSERTS compilation flag to be active in your project to function.

A BasicCharacterObject is a data container representing the static, deserialized information for a character defined in the npccharacters XML file. It includes properties such as:

• BodyProperties
• Equipment
• Level
• Skills
• Culture

BasicCharacterObjects serve as the fundamental building blocks for creating Agents.

A MissionView is a specialized type of MissionBehaviour designed primarily for the client side. They are used to handle interactions with UI elements and client-side logic during a mission.

Common use cases include:

• Handling player movement via inputs.
• Managing UI-driven requests (e.g., checking if a player is requesting to spawn as a bot).
• Interacting with any mission-specific UI components.

A MissionBehaviour is a class used to control a Mission. It allows you to implement logic such as spawning Agents, adding mission boundaries, or managing mission-specific rules.

A single mission can have multiple MissionBehaviour instances attached to it.

Key inheritance notes:

• MissionLogic is a type of MissionBehaviour.
• MissionViews is a type of MissionBehaviour.

When creating your own behaviour, it is recommended to set the BehaviourType property to Other unless you are implementing mission logic.

Harmony is a library used to alter the functionality of applications and DLLs during runtime. These changes are non-permanent and only persist for the current session.

Common usage patterns include:

• Prefix: Execute code before a specific method runs.
• Postfix: Execute code after a specific method runs.
• Replacement: Replace an entire method with your own implementation.
• IL Patching: Patch individual IL instructions (use with caution).

Warning: Using Harmony can cause incompatibilities between mods if multiple mods attempt to patch the same method(s). Use it only when absolutely necessary.

If your mod intends to overwrite Gauntlet UIs from official TaleWorlds modules, your mod MUST be loaded BEFORE the official module.

To ensure this high priority in the load order, it is highly recommended to:

1. Use a prefix like an underscore (e.g., _ExampleUIMod) in your module name/ID.
2. Do not use <DependedModules/> for these types of mods, as dependencies can affect load order positioning.

String IDs are global. If two different modules use the same stringID, they will conflict. To avoid this, do not use semantically meaningful keys (like {=my_mod_text}). Instead, use short, random alphanumeric codes.

Best Practices:

• Use 8-digit alphanumeric codes (e.g., {=zmR6sT03}).
• Avoid long IDs as they can impact performance.
• You can generate these using services like random.org.

In Mount & Blade II: Bannerlord, Scenes are defined via XML. Depending on the module context, the root node for scenes is named either SPBattleScenes (in the SandBox module) or CustomBattleScenes (in the SandBoxCore module).

Each Scene node can contain child nodes of type Scene to define specific battle environments.