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.
328 lines
20 KiB
328 lines
20 KiB
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class OnEnableAttribute
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OnEnableAttribute
|
|
">
|
|
<meta name="generator" content="docfx 2.59.3.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">Search Results for <span></span></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.OnEnableAttribute">
|
|
|
|
|
|
<h1 id="IPA_OnEnableAttribute" data-uid="IPA.OnEnableAttribute" class="text-break">Class OnEnableAttribute
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Indicates that the target method should be called when the plugin is enabled.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
|
|
<div class="level1"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
|
<div class="level2"><span class="xref">OnEnableAttribute</span></div>
|
|
</div>
|
|
<div class="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.runtime.interopservices._attribute">_Attribute</a></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, Boolean)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.equals#system-attribute-equals(system-object)">Attribute.Equals(Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.gethashcode#system-attribute-gethashcode">Attribute.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.match#system-attribute-match(system-object)">Attribute.Match(Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefaultattribute#system-attribute-isdefaultattribute">Attribute.IsDefaultAttribute()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.system-runtime-interopservices-_attribute-gettypeinfocount#system-attribute-system-runtime-interopservices-attribute-gettypeinfocount(system-uint32@)">Attribute._Attribute.GetTypeInfoCount(UInt32)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.system-runtime-interopservices-_attribute-gettypeinfo#system-attribute-system-runtime-interopservices-attribute-gettypeinfo(system-uint32-system-uint32-system-intptr)">Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.system-runtime-interopservices-_attribute-getidsofnames#system-attribute-system-runtime-interopservices-attribute-getidsofnames(system-guid@-system-intptr-system-uint32-system-uint32-system-intptr)">Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.system-runtime-interopservices-_attribute-invoke#system-attribute-system-runtime-interopservices-attribute-invoke(system-uint32-system-guid@-system-uint32-system-int16-system-intptr-system-intptr-system-intptr-system-intptr)">Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.typeid#system-attribute-typeid">Attribute.TypeId</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
|
|
</div>
|
|
</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_OnEnableAttribute_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
|
|
public sealed class OnEnableAttribute : Attribute, _Attribute</code></pre>
|
|
</div>
|
|
<h5 id="IPA_OnEnableAttribute_remarks"><strong>Remarks</strong></h5>
|
|
<div class="markdown level0 remarks"><p>
|
|
This attribute is interchangable with <a class="xref" href="IPA.OnStartAttribute.html">OnStartAttribute</a>, and is treated identically.
|
|
They are seperate to allow plugin code to more clearly describe the intent of the methods.
|
|
</p>
|
|
<p>
|
|
Typically, this will be used when the <a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a> parameter of the plugins's
|
|
<a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a> is <a class="xref" href="IPA.RuntimeOptions.html#IPA_RuntimeOptions_DynamicInit">DynamicInit</a>.
|
|
</p>
|
|
<p>
|
|
The method marked by this attribute will always be called from the Unity main thread.
|
|
</p>
|
|
</div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.runtime.interopservices._attribute">System.Runtime.InteropServices._Attribute</a>
|
|
</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<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])</a>
|
|
</div>
|
|
<h3 id="seealso">See Also</h3>
|
|
<div class="seealso">
|
|
<div><a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a></div>
|
|
<div><a class="xref" href="IPA.OnStartAttribute.html">OnStartAttribute</a></div>
|
|
</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/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_OnEnableAttribute.md&value=---%0Auid%3A%20IPA.OnEnableAttribute%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/nike4613/BeatSaber-IPA-Reloaded/blob/757388ebd92c145e7ea246ff25edeac0185f7edd/IPA.Loader/PluginInterfaces/Attributes/LifecycleAttributes.cs/#L35" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</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>
|