API 4: Plugin API redesign

[goaaats]

Old and busted

public class ScratchPlugin
{
    public void Initialize(DalamudPluginInterface pluginInterface)
    {
        ...stuff...
    }
}

New hotness

...in constructors

public class ScratchPlugin
{
    public ScratchPlugin(
        DalamudPluginInterface pluginInterface,
        BuddyList buddies,
        ChatGui chat,
        ChatHandlers chatHandlers,
        ClientState clientState,
        CommandManager commands,
        Condition condition,
        DataManager data,
        FateTable fates,
        FlyTextGui flyText,
        Framework framework,
        GameGui gameGui,
        GameNetwork gameNetwork,
        JobGauges gauges,
        KeyState keyState,
        LibcFunction libcFunction,
        ObjectTable objects,
        PartyFinderGui pfGui,
        PartyList party,
        SeStringManager seStringManager,
        SigScanner sigScanner,
        TargetManager targets,
        ToastGui toasts)
    {
        ...stuff...
    }
}

You only have to include WHAT YOU WANT. You even don't need to include the DalamudPluginInterface if you don't use it. Add them to static properties in your base class, pass them around, however you want to access the various API classes. The scratch constructor above is all the various possibilities that you can currently include. Any classes that have a [PluginInterface] attribute are available as parameters in your constructor.

If you would like to restrict the version of your dependency, i.e. you're worried about ClientState breaking, you should structure your parameters as such. If the API class version changes due to breaking updates, your plugin will gracefully not load, rather than break in unforeseen ways in-game.

    public ScratchPlugin(
        ...
        [RequiredVersion("1.0")] ClientState clientState,
        ...)

...in properties

You can do the same for public, private, static or instance properties.

public class ScratchPlugin
{
	[PluginService]
	[RequiredVersion("1.0")]
    public static CommandManager CmdManager { get; private set; }
	
    public ScratchPlugin()
    {
        CmdManager.AddHandler([...]);
    }
}

...for your own types and objects

You can inject into and create your own objects via DI.

var instance = pluginInterface.Create<MySubsystem>();

if (!pluginInterface.Inject(otherInstance))
	Log.Error("Could not satisfy requirements for otherInstance");
[...]