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 IBeatSaberPlugin   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Interface IBeatSaberPlugin   ">    <meta name="generator" content="docfx 2.43.2.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.IBeatSaberPlugin">      <h1 id="IPA_IBeatSaberPlugin" data-uid="IPA.IBeatSaberPlugin" class="text-break">Interface IBeatSaberPlugin  </h1>  <div class="markdown level0 summary"><p>Interface for Beat Saber plugins. Every class that implements this will be loaded if the DLL is placed atdata/Managed/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_IBeatSaberPlugin_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public interface IBeatSaberPlugin</code></pre>  </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/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnActiveSceneChanged_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_Scene_.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L52">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnActiveSceneChanged_" data-uid="IPA.IBeatSaberPlugin.OnActiveSceneChanged*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnActiveSceneChanged_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_Scene_" data-uid="IPA.IBeatSaberPlugin.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/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnApplicationQuit.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L22">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnApplicationQuit_" data-uid="IPA.IBeatSaberPlugin.OnApplicationQuit*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnApplicationQuit" data-uid="IPA.IBeatSaberPlugin.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/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnApplicationStart.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.OnApplicationStart%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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L17">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnApplicationStart_" data-uid="IPA.IBeatSaberPlugin.OnApplicationStart*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnApplicationStart" data-uid="IPA.IBeatSaberPlugin.OnApplicationStart">OnApplicationStart()</h4>  <div class="markdown level1 summary"><p>Gets invoked when the application is started.</p><p>THIS EVENT WILL NOT BE GUARANTEED TO FIRE. USE Init OR <a class="xref" href="IPA.IDisablablePlugin.html#IPA_IDisablablePlugin_OnEnable">OnEnable()</a> INSTEAD.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnApplicationStart()</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/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnFixedUpdate.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.OnFixedUpdate%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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L32">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnFixedUpdate_" data-uid="IPA.IBeatSaberPlugin.OnFixedUpdate*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnFixedUpdate" data-uid="IPA.IBeatSaberPlugin.OnFixedUpdate">OnFixedUpdate()</h4>  <div class="markdown level1 summary"><p>Gets invoked on ever physics update.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnFixedUpdate()</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/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnSceneLoaded_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_LoadSceneMode_.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L39">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnSceneLoaded_" data-uid="IPA.IBeatSaberPlugin.OnSceneLoaded*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnSceneLoaded_UnityEngine_SceneManagement_Scene_UnityEngine_SceneManagement_LoadSceneMode_" data-uid="IPA.IBeatSaberPlugin.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/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnSceneUnloaded_UnityEngine_SceneManagement_Scene_.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L45">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnSceneUnloaded_" data-uid="IPA.IBeatSaberPlugin.OnSceneUnloaded*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnSceneUnloaded_UnityEngine_SceneManagement_Scene_" data-uid="IPA.IBeatSaberPlugin.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>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_IBeatSaberPlugin_OnUpdate.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin.OnUpdate%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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L27">View Source</a>  </span>  <a id="IPA_IBeatSaberPlugin_OnUpdate_" data-uid="IPA.IBeatSaberPlugin.OnUpdate*"></a>  <h4 id="IPA_IBeatSaberPlugin_OnUpdate" data-uid="IPA.IBeatSaberPlugin.OnUpdate">OnUpdate()</h4>  <div class="markdown level1 summary"><p>Gets invoked on every graphic update.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void OnUpdate()</code></pre>  </div>  <h3 id="extensionmethods">Extension Methods</h3>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetPrivateField__1_System_Object_System_String_">ReflectionUtil.GetPrivateField&lt;T&gt;(Object, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod&lt;T&gt;(Object, 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/master/docs/override/new?filename=IPA_IBeatSaberPlugin.md&amp;value=---%0Auid%3A%20IPA.IBeatSaberPlugin%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/47b1e03a2daf94f30eb0ec27cd16036e6a6f1f95/IPA.Loader/PluginInterfaces/BeatSaber/IBeatSaberPlugin.cs/#L10" 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>