Class Plugin
Base class for RisingV plugins.
Example Usage:
using BepInEx;
using RisingV.Shared.Plugins;
using RisingV.Shared.Engines;
using RisingV.Core.Engines;
public class MyCoolPluginConfig() : PluginConfig(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_GUID)
{
public ConfigEntry<float> AttackModifier { get; set; } =
new("Gameplay", "AttackModifier", 1f, "Modifier for attack damage");
}
public class MyCoolPluginContext() : PluginContext(typeof(MyPluginInfo), new MyCoolPluginConfig());
[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
[BepInDependency("RisingV.Core")]
[BepInDependency("RisingV.Scripting")]
public class Plugin : RisingPlugin<MyCoolPluginContext>
{
protected override void OnInitialize()
{
EngineManager.AddEngine<ScriptingEngine>(this);
EngineManager.AddEngine<DamageEngine>(this);
EngineManager.AddEngine<DeathEngine>(this);
// You can also register other systems, databases, or processors here
}
protected override void OnLoad()
{
// Plugin startup logic (pre-initialization)
}
protected override bool OnUnload()
{
return true;
}
}
[BepInPlugin("RisingV.Core", "RisingV.Core", "1.0.0")]
[BepInDependency("RisingV.Shared", BepInDependency.DependencyFlags.HardDependency)]
public class Plugin : RisingPlugin<CorePluginContext>, IPlugin<CorePluginContext>, IPlugin, IManageable<PluginManager>, IReloadable<PluginManager>, IReloadable, IDisposable, IHasPluginContext<CorePluginContext>, IPluginContext, IPluginComponent, IManageable<PluginComponentsManager>, IManageable
- Inheritance
-
BasePluginPlugin
- Implements
- Inherited Members
-
BasePlugin.AddComponent<T>()BasePlugin.LogBasePlugin.Config
- Extension Methods
Methods
OnInitialize()
Called when the plugin is initialized (after OnPreLoad()).
public override void OnInitialize()
OnLoad()
Called when the plugin is loaded (after OnInitialize()).
public override void OnLoad()
OnPreLoad()
Called when the BepInEx plugin Load
is called.
public override void OnPreLoad()
OnUnload()
Called when the plugin is unloaded.
public override bool OnUnload()