👁 Image
Breakdown.Tools 1.24.9

Breakdown.Tools

Considered a core part of the 'Breakdown' project for Unturned. Breakdown is a set of libraries and modules for Unturned that assist in the creation of plugins and modules for the game.

ReflectionTool

Provides simple helper methods when it comes to reflection. An example of this would include GetFieldValue<T>(this object? obj, string field) and SetFieldValue<T>(this object obj, string field, T value) which allow developers to more easily access private fields within objects.

DependentTool

Uses the dependent system originally introduced in JDE2 (JStudio Development Editor). Developers simply activate the rest of their plugin/module using RegisterNexusPoint(Assembly key). All classes that inherit INexusDependent will be activated (assuming the constructor has no parameters). Alongside that, classes that rely on another class that inherits IDependent can be be activated at the same time as the required class by using IBranchedDependent<T>.

PluginTool

Simple plugin system. To support plugins for your assembly, simply create a class inheriting Plugin. Other developers who wish to create plugins for your assembly should then use this class within their projects. In your assembly, make sure to invoke LoadPlugins<T>(Assembly nexusAssembly, string directory). Please note that the directory is not created for you.

Zones

You can create PolygonZone and RadiusZone that be used to monitoring or whatnot. Those classes inherit Zone, which has a IsPointInsideZone(Vector3 point) for implementing a dectection system. Alternatively you can pass a Zone into a ZoneMonitor that is attached to a GameObject.

DispatcherTool

Similar setup to RocketMod, the DispatcherTool has methods for executing code on the main thread (QueueOnMainThread(Action action)).

Logging

While not properly setup just yet, you can use the static Logger class to log to a console on Windows or the Unturned log file. Breakdown automatically figures out what logging setup is best for the environment it is executing in.