Subscribe to download
Heir Blocking Framework

HBF is a framework mod, meaning it's supposed to be used by other mods you may be using as a basis for a certain feature.

HBF adds a simple method for modders to block the generation of random heirs, since this is otherwise not possible in Vic3 out of the box.

Installing HBF does NOT block random heirs by itself - a separate mod needs to come in and do that.

If a mod or multiple mods you are using requires this mod to be installed, please follow instructions on those mods, if provided.

HBF should otherwise be able to be placed anywhere due to it leveraging specific mod-loading behaviors of Vic3 that makes it largely agnostic to playset orders.

HBF is best integrated into your mod by requiring players to install HBF separately.

To block heir generation for a given country, please set a variable in the country's scope named no_heirs like so:The type does not matter since HBF only does a has_variable check for it.

If this variable is defined for the given country, then every heir that gets generated will be silently killed. This means the player will not receive a notification about their death (and thus, to them, it will appear as if no heir is being generated at all). This may also affect any logic tied to the on_character_death on action, since I believe it does not fire for any character with hidden kills. Take that into consideration when using HBF.

HBF does not block the generation of heirs created via create_character and makes no attempt to. The primary use case for HBF would be to implement a system for historical heirs to be born without worrying that a randomly generated one will get in the way.

HBF provides changes to the effect block of the following on action:
HBF implements its changes in its own file to take advantage of Vic3 loading behavior and enforce its changes over vanilla, but it leaves room for other mods to take priority should a mod want to do it. If your mod makes changes to the same effect block, you may find that HBF overwrites changes your mod have made or vice-versa. In those cases, you should either integrate HBF's changes manually or create a compatibility patch.

HBF can be placed anywhere in the user's playset for correct functionality. All you have to do is go and set the variable as needed.

• YES, you may include this mod in any modpacks/collections/whatever.
• YES, you may embed this mod into any mods you are creating, as well as making whatever tweaks are necessary for it to work with your mod. Credit and a link back here would be very much appreciated!

• Victoria 3 Modding Co-op Discord server[discord.gg]