Class RisingSharedPlugin<TContext>

Namespace

RisingV.Shared.Plugins

Assembly

RisingV.Shared.dll

Base class for shared RisingV plugins with a specific context.

public class RisingSharedPlugin<TContext> : RisingPluginBase, IPlugin<TContext>, IPlugin, IManageable<PluginManager>, IReloadable<PluginManager>, IReloadable, IDisposable, IHasPluginContext<TContext>, IPluginContext, IPluginComponent, IManageable<PluginComponentsManager>, IManageable where TContext : PluginContext

Type Parameters

TContext

The type of the plugin context, which must inherit from PluginContext.

Inheritance

object

RisingPluginBase

RisingSharedPlugin<TContext>

Implements

IPlugin<TContext>

IPlugin

IManageable<PluginManager>

IReloadable<PluginManager>

IReloadable

IDisposable

IHasPluginContext<TContext>

IPluginContext

IPluginComponent

IManageable<PluginComponentsManager>

IManageable

Derived

BootstrapPlugin

Inherited Members

RisingPluginBase.PluginInfo

RisingPluginBase.PluginConfig

RisingPluginBase.PluginTarget

RisingPluginBase.Harmony

RisingPluginBase.EventBus

RisingPluginBase.SystemManager

RisingPluginBase.ProcessorManager

RisingPluginBase.DatabaseManager

RisingPluginBase.EngineManager

RisingPluginBase.Composites

RisingPluginBase.Log

RisingPluginBase.OnPreLoad()

RisingPluginBase.OnInitialize()

RisingPluginBase.OnLoad()

RisingPluginBase.OnUnload()

RisingPluginBase.Load()

RisingPluginBase.OnReload(IManager, List<IPlugin>, ReloadReason)

RisingPluginBase.Unload()

RisingPluginBase.OnReload(PluginManager, List<IPlugin>, ReloadReason)

RisingPluginBase.Reload(PluginManager, List<IPlugin>, ReloadReason)

RisingPluginBase.Reload(PluginManager, ReloadReason)

RisingPluginBase.OnGameDataInitialized(EventBridge.OnGameDataInitializedEvent)

RisingPluginBase.OnPluginsInitializing(EventBridge.OnPluginsInitializingEvent)

RisingPluginBase.OnPluginsLoading(EventBridge.OnPluginsLoadingEvent)

RisingPluginBase.SetupConfiguration(PluginConfig)

RisingPluginBase.SetupSharedEventBus(ManagedEventBus)

RisingPluginBase.GetSharedComponent(Type)

RisingPluginBase.GetSharedComponent<TX>()

RisingPluginBase.AddSharedComponent<T>(IPlugin, bool)

RisingPluginBase.AddSharedComponent<T>(IPlugin, T, bool)

RisingPluginBase.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EntityExtensions.IsAspect<TAspect>(object)

Constructors

RisingSharedPlugin()

public RisingSharedPlugin()

RisingSharedPlugin(TContext)

public RisingSharedPlugin(TContext context)

Parameters

context TContext

Properties

Context

Gets the context for the plugin, which contains information about the plugin's configuration, target, and other details.

public TContext Context { get; }

Property Value

TContext

Methods

Get()

Gets the current instance of the RisingPlugin.

public static RisingSharedPlugin<TContext>? Get()

Returns

RisingSharedPlugin<TContext>

Returns the current instance of the RisingPlugin, or null if it has not been initialized.

Get<TX>()

Gets the current instance of the RisingPlugin as a specific type.

public static TX Get<TX>() where TX : RisingSharedPlugin<TContext>

Returns

TX

Returns the current instance of the RisingPlugin as the specified type, or throws an exception if it is not loaded.

Type Parameters

TX

The type of the plugin to retrieve, which must inherit from RisingSharedPlugin<TContext>.

Exceptions

InvalidOperationException

Thrown if the plugin of the specified type is not loaded.

OnPluginsLoaded(OnPluginsLoadedEvent)

Called when all the plugins are loaded. This method is triggered by the EventBridge.OnPluginsLoadedEvent.

protected override void OnPluginsLoaded(EventBridge.OnPluginsLoadedEvent @event)

Parameters

event EventBridge.OnPluginsLoadedEvent

The event containing the state of the plugins are loaded.