Details

Target: Obenseuer 0.5.08 (buildid 25969064), Unity 6000.0.77f1 Mono, BepInEx 6 Unity.Mono (be.788, the tested build) or BepInEx 5 (5.4.23 or later). Namespace: ObenseuerCore. Logs go to BepInEx\logs\obenseuer.moddingframework.furniture.log.

Everything not listed in this reference is internal and may change without notice. Items marked experimental may change too.

The framework changes some of the game’s methods when it starts, so it can add furniture, blueprints and flatpacks. This page calls that group of changes a feature group: its name is obenseuer.moddingframework.furniture, the name you will see in the log.

When you can call it

  • Call everything from your mod’s normal code (OnLoad, event handlers, Update), not from a background thread you started. The game and Unity only run safely on the main thread (see the glossary).
  • Calls that change the game wait while a save is loading or being written. Give and the shop stock do not work then. Shop stock queued during a load is applied once the furniture state is restored, or at the next in-game hour.

What to check for and what comes back

  • FurnitureRegistry.IsAvailable tells you whether furniture can be added. It is false when the framework could not set up its furniture features, or when the feature group was turned off. Define, DefineBlueprint, GiveBlueprint, MailBlueprint and AddFlatpackLoot need it to be true.
  • A bad value throws an ArgumentException, a null definition throws an ArgumentNullException, and a refusal returns null or false. The rules for each call are in the reference above.

If something fails to set up

The framework changes some of the game’s methods when it starts. If a game update breaks one of them, the framework turns off the feature group that depends on it, and writes error lines to the group’s log file in BepInEx\logs. The rest of the framework keeps working.

  • If the framework cannot change the game’s furniture methods, the whole feature group turns off. IsAvailable becomes false, Define returns null, and mod furniture does not appear in the game.
  • If the framework cannot change the game’s build menu code, the pieces keep their template’s group. One warning goes to the log at startup.