Power devices

What it is

Many things in the game need power: lamps, fridges and other furniture, crafting stations such as generators and stoves, and batteries. This API gives your mod one list of all of them. For each device you can see whether it is switched on, whether it really has power, how much fuel or charge it has, and you can switch it on or off. You also get events when a device gains or loses power and when a fuel burner runs out of fuel.

It covers three kinds of power object:

  • Furniture power devices, the lamps and machines the player places in a room.
  • Crafting stations that have a power source, including generators and stoves that burn fuel.
  • Batteries, which use up stored fuel items over time.

Blackouts and generator switches are on the World page (WorldPower) and are not repeated here. The gas pumps are on the Fuel page.

When to use it

  • Switch a device on or off as part of a quest.
  • Show how much fuel a generator or a stove has left.
  • React when a device loses power, or when a generator runs out of fuel.
  • Find every power source in a room.

Quick example

This mod writes a log line when a furniture device or a battery gains or loses power, and when a fuel burner runs out of fuel. Once a save is loaded, it also logs how many power sources the scene has.

using ObenseuerCore;

[ModInfo("example.powerwatch", "Power Watch", "0.1.0")]
[ModDependency("obenseuer.moddingframework", "0.11.0")]
public sealed class PowerWatch : FrameworkMod
{
    protected override void OnLoad()
    {
        PowerDevices.PoweredChanged += args => Log.Info(args.Id + (args.IsPowered ? " now has power." : " lost power."));
        PowerDevices.FuelRanOut += args => Log.Info(args.Id + " ran out of fuel.");
        Events.WhenReady(() =>
        {
            int sources = 0;
            foreach (PowerDeviceInfo device in PowerDevices.All())
                if (device.Kind == PowerDeviceKind.Source) sources++;
            Log.Info("This scene has " + sources + " power sources.");
        });
    }
}

PoweredChanged and FuelRanOut are events: the framework calls your code each time they happen. Events.WhenReady waits until a save is loaded before it runs your code. See Using events.

Table of contents