Description

A mod, for modders.

A central location for access to mod config UIs. Modders can simply register their mod with this one and then no more messy radial menu with tons of config menu entries. Accessed via the Pause Menu

Registration Process

Register your UI buff with my singleton. I recommend doing it via your own singleton. Create the graph as shown below to register your UI buff with my system. I recommend doing something very similar to what is shown, as to avoid any potential race conditions depending on mod load orders. The class array is the PrimalBuff class of your UI buff. The int array are registration options. https://i.imgur.com/kbq3PR2.png or https://blueprintue.com/blueprint/drm6hpbs

Registration Options

Registration Options : Integer Index 0

This determines whether or not the PrimalBuff is created for the player OR a callback function is triggered on an existing instance of the PrimalBuff.
0 = A buff will be created(static add buff).
1 = A callback will be fired, if your buff instance exists.
The callback will activate the BPGetCustomBlueprintData function on your buff instance and pass in the tag ModAdminPanelCallback for you can differentiate between other potential calls. This occurs on the server. What you do at that point is up to you(call to client and display widget, load data, etc). https://i.imgur.com/NiJKEsI.png

Registration Options : Integer Index 1

This determines visibility of the entry based on admin status.
0 = Entry will be visible to all players.
1 = Visible to admins only.

Note: If you use the spawn buff method, the buff is simply added to the calling player(Static Add Buff). Everything else is to be handled by you, the modder.

Compatability

In order to be compatible, in case someone is not using this mod, something like access via a radial menu is recommended. You can toggle entry visibility simply enough, as to show it if the mod is not active and hide it if it is. https://i.imgur.com/a0mxmqJ.png and https://i.imgur.com/8oDmyqq.png The end result, assuming done correctly, would be the removal of your entry from the radial menu and an addition to the Mod Settings Panel.

Results

Pause Menu: https://i.imgur.com/55nkGHN.png
Mod Settings Panel: https://i.imgur.com/8zjFPWS.png
Without mod installed: https://i.imgur.com/edxZoYA.jpeg
With mod installed and buff registered: https://i.imgur.com/0heuH5k.jpeg
In Game Demo: https://www.youtube.com/watch?v=Hvzn3D3Z7KY

Notes

If you want the display to be prettier, make sure your mods have a Descriptive Name and an icon, otherwise it falls back to using the buff class name and the repair icon.

Bugs

When reporting bugs, it is very important to include as much detail as possible. How you caused the bug? What it is? What should happen? Singleplayer? Dedicated server? PC? Console?

Join My Discord