DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Interface IPlugin   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Interface IPlugin   ">    <meta name="generator" content="docfx 2.48.0.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list"></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.IPlugin">      <h1 id="IPA_IPlugin" data-uid="IPA.IPlugin" class="text-break">Interface IPlugin  </h1>  <div class="markdown level0 summary"><p>Interface for BSIPA plugins. Every class that implements this will be loaded if the DLL is placed at&lt;install dir&gt;/Plugins.</p></div>  <div class="markdown level0 conceptual"></div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_IPlugin_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">[Obsolete(&quot;Use the attribute-based system instead.&quot;)]public interface IPlugin</code></pre>  </div>  <h5 id="IPA_IPlugin_remarks"><strong>Remarks</strong></h5>  <div class="markdown level0 remarks"><p>Mods implemented with this interface should handle being enabled at runtime properly, unless markedwith the &quot;no-runtime-enable&quot; feature.</p></div>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_IPlugin_OnActiveSceneChanged_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_Scene_.md&amp;value=---%0Auid%3A%20IPA.IPlugin.OnActiveSceneChanged(UnityEngine.SceneManagement.Scene%2CUnityEngine.SceneManagement.Scene)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/b22da6961244326963e19ed7bfc40f19d74909a7/IPA.Loader/PluginInterfaces/BeatSaber/IPlugin.cs/#L51">View Source</a>  </span>  <a id="IPA_IPlugin_OnActiveSceneChanged_" data-uid="IPA.IPlugin.OnActiveSceneChanged*"></a>  <h4 id="IPA_IPlugin_OnActiveSceneChanged_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_Scene_" data-uid="IPA.IPlugin.OnActiveSceneChanged(UnityEngine.SceneManagement.Scene,UnityEngine.SceneManagement.Scene)">OnActiveSceneChanged(Scene, Scene)</h4>  <div class="markdown level1 summary"><p>Gets invoked whenever a scene is changed</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnActiveSceneChanged(Scene prevScene, Scene nextScene)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">UnityEngine.SceneManagement.Scene</span></td>        <td><span class="parametername">prevScene</span></td>        <td><p>The Scene that was previously loaded</p></td>      </tr>      <tr>        <td><span class="xref">UnityEngine.SceneManagement.Scene</span></td>        <td><span class="parametername">nextScene</span></td>        <td><p>The Scene being loaded</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_IPlugin_OnApplicationQuit.md&amp;value=---%0Auid%3A%20IPA.IPlugin.OnApplicationQuit%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/b22da6961244326963e19ed7bfc40f19d74909a7/IPA.Loader/PluginInterfaces/BeatSaber/IPlugin.cs/#L31">View Source</a>  </span>  <a id="IPA_IPlugin_OnApplicationQuit_" data-uid="IPA.IPlugin.OnApplicationQuit*"></a>  <h4 id="IPA_IPlugin_OnApplicationQuit" data-uid="IPA.IPlugin.OnApplicationQuit">OnApplicationQuit()</h4>  <div class="markdown level1 summary"><p>Gets invoked when the application is closed.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnApplicationQuit()</code></pre>  </div>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_IPlugin_OnEnable.md&amp;value=---%0Auid%3A%20IPA.IPlugin.OnEnable%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/b22da6961244326963e19ed7bfc40f19d74909a7/IPA.Loader/PluginInterfaces/BeatSaber/IPlugin.cs/#L26">View Source</a>  </span>  <a id="IPA_IPlugin_OnEnable_" data-uid="IPA.IPlugin.OnEnable*"></a>  <h4 id="IPA_IPlugin_OnEnable" data-uid="IPA.IPlugin.OnEnable">OnEnable()</h4>  <div class="markdown level1 summary"><p>Called when a plugin is enabled. This is where you should set up Harmony patches and the like.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnEnable()</code></pre>  </div>  <h5 id="IPA_IPlugin_OnEnable_remarks">Remarks</h5>  <div class="markdown level1 remarks"><p>This will be called after <code>Init</code>, and will be called when the plugin loads normally too.When a plugin is disabled at startup, neither this nor Init will be called until it is enabled.</p><p>Init will only ever be called once.</p></div>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_IPlugin_OnSceneLoaded_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_LoadSceneMode_.md&amp;value=---%0Auid%3A%20IPA.IPlugin.OnSceneLoaded(UnityEngine.SceneManagement.Scene%2CUnityEngine.SceneManagement.LoadSceneMode)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/b22da6961244326963e19ed7bfc40f19d74909a7/IPA.Loader/PluginInterfaces/BeatSaber/IPlugin.cs/#L38">View Source</a>  </span>  <a id="IPA_IPlugin_OnSceneLoaded_" data-uid="IPA.IPlugin.OnSceneLoaded*"></a>  <h4 id="IPA_IPlugin_OnSceneLoaded_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_LoadSceneMode_" data-uid="IPA.IPlugin.OnSceneLoaded(UnityEngine.SceneManagement.Scene,UnityEngine.SceneManagement.LoadSceneMode)">OnSceneLoaded(Scene, LoadSceneMode)</h4>  <div class="markdown level1 summary"><p>Gets invoked whenever a scene is loaded.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnSceneLoaded(Scene scene, LoadSceneMode sceneMode)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">UnityEngine.SceneManagement.Scene</span></td>        <td><span class="parametername">scene</span></td>        <td><p>The scene currently loaded</p></td>      </tr>      <tr>        <td><span class="xref">UnityEngine.SceneManagement.LoadSceneMode</span></td>        <td><span class="parametername">sceneMode</span></td>        <td><p>The type of loading</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_IPlugin_OnSceneUnloaded_UnityEngine_SceneManagement_Scene_.md&amp;value=---%0Auid%3A%20IPA.IPlugin.OnSceneUnloaded(UnityEngine.SceneManagement.Scene)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/b22da6961244326963e19ed7bfc40f19d74909a7/IPA.Loader/PluginInterfaces/BeatSaber/IPlugin.cs/#L44">View Source</a>  </span>  <a id="IPA_IPlugin_OnSceneUnloaded_" data-uid="IPA.IPlugin.OnSceneUnloaded*"></a>  <h4 id="IPA_IPlugin_OnSceneUnloaded_UnityEngine_SceneManagement_Scene_" data-uid="IPA.IPlugin.OnSceneUnloaded(UnityEngine.SceneManagement.Scene)">OnSceneUnloaded(Scene)</h4>  <div class="markdown level1 summary"><p>Gets invoked whenever a scene is unloaded</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnSceneUnloaded(Scene scene)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">UnityEngine.SceneManagement.Scene</span></td>        <td><span class="parametername">scene</span></td>        <td><p>The unloaded scene</p></td>      </tr>    </tbody>  </table>  <h3 id="extensionmethods">Extension Methods</h3>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField_System_Object_System_String_System_Object_">ReflectionUtil.SetField(Object, String, Object)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__1___0_System_String_System_Object_">ReflectionUtil.SetField&lt;T&gt;(T, String, Object)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__1_System_Object_System_String_">ReflectionUtil.GetField&lt;T&gt;(Object, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;T, U&gt;(U, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetProperty(Object, String, Object)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__1___0_System_String_System_Object_">ReflectionUtil.SetProperty&lt;T&gt;(T, String, Object)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod(Object, String, Object[])</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1___0_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(T, String, Object[])</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(Object, String, Object[])</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T, U&gt;(U, String, Object[])</a>  </div></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_IPlugin.md&amp;value=---%0Auid%3A%20IPA.IPlugin%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>                  </li>                  <li>                    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/b22da6961244326963e19ed7bfc40f19d74909a7/IPA.Loader/PluginInterfaces/BeatSaber/IPlugin.cs/#L14" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>