You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

204 lines
8.9 KiB

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum RuntimeOptions
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum RuntimeOptions
">
<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 rel="stylesheet" href="../styles/fix.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.RuntimeOptions">
<h1 id="IPA_RuntimeOptions" data-uid="IPA.RuntimeOptions" class="text-break">Enum RuntimeOptions
</h1>
<div class="markdown level0 summary"><p>Options that a plugin must specify to describe how it expects to be run.</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_RuntimeOptions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum RuntimeOptions</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="IPA_RuntimeOptions_DynamicInit">DynamicInit</td>
<td><p>
Indicates that this plugin supports runtime enabling and disabling.
</p>
<p>
When this is set, the plugin may be disabled at reasonable points during runtime. As with <a class="xref" href="IPA.RuntimeOptions.html#IPA_RuntimeOptions_SingleStartInit">SingleStartInit</a>,
it will be initialized and enabled with the game if it is enabled on startup, and disabled with the game if it is enabled
on shutdown.
</p>
<p>
When a plugin with this set is enabled mid-game, the first time it is enabled, its initialization methods will be called,
then its enable methods. All subsequent enables will <strong>NOT</strong> re-initialize, however the enable methods will be called.
</p>
<p>
When a plugin with this set is disabled mid-game, the plugin instance will <strong>NOT</strong> be destroyed, and will instead be
re-used for subsequent enables. The plugin is expected to handle this gracefully, and behave in a way that makes sense.
</p>
</td>
</tr>
<tr>
<td id="IPA_RuntimeOptions_SingleStartInit">SingleStartInit</td>
<td><p>
Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game.
</p>
<p>
With this option set, whether or not the plugin is disabled during a given run is constant for that entire run.
</p>
</td>
</tr>
</tbody>
</thead></thead></table>
<h5 id="IPA_RuntimeOptions_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a></div>
<div><a class="xref" href="IPA.InitAttribute.html">InitAttribute</a></div>
<div><a class="xref" href="IPA.OnEnableAttribute.html">OnEnableAttribute</a></div>
<div><a class="xref" href="IPA.OnDisableAttribute.html">OnDisableAttribute</a></div>
<div><a class="xref" href="IPA.OnStartAttribute.html">OnStartAttribute</a></div>
<div><a class="xref" href="IPA.OnExitAttribute.html">OnExitAttribute</a></div>
</div>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;RuntimeOptions, U&gt;(String, U)</a>
</div>
<div>
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, RuntimeOptions&gt;(String)</a>
</div>
<div>
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;RuntimeOptions, U&gt;(String, U)</a>
</div>
<div>
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, RuntimeOptions&gt;(String)</a>
</div>
<div>
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, RuntimeOptions&gt;(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_RuntimeOptions.md&amp;value=---%0Auid%3A%20IPA.RuntimeOptions%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/edde8681c9a02cfad875814dbdf60383b240762b/IPA.Loader/PluginInterfaces/Attributes/PluginAttribute.cs/#L43" 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>