|
|
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Class PluginAttribute
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Class PluginAttribute
- ">
- <meta name="generator" content="docfx 2.59.4.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.PluginAttribute">
-
-
- <h1 id="IPA_PluginAttribute" data-uid="IPA.PluginAttribute" class="text-break">Class PluginAttribute
- </h1>
- <div class="markdown level0 summary"><p>Marks a class as being a BSIPA plugin.</p>
- </div>
- <div class="markdown level0 conceptual"></div>
- <div class="inheritance">
- <h5>Inheritance</h5>
- <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
- <div class="level1"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
- <div class="level2"><span class="xref">PluginAttribute</span></div>
- </div>
- <div class="implements">
- <h5>Implements</h5>
- <div><a class="xref" href="https://learn.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://learn.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://learn.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://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>
- </div>
- <div>
- <a class="xref" href="https://learn.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://learn.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://learn.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://learn.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://learn.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://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>
- </div>
- <div>
- <a class="xref" href="https://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>
- </div>
- <div>
- <a class="xref" href="https://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.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://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>
- </div>
- <div>
- <a class="xref" href="https://learn.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://learn.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://learn.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://learn.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://learn.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://learn.microsoft.com/dotnet/api/system.attribute.equals#system-attribute-equals(system-object)">Attribute.Equals(Object)</a>
- </div>
- <div>
- <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode#system-attribute-gethashcode">Attribute.GetHashCode()</a>
- </div>
- <div>
- <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.match#system-attribute-match(system-object)">Attribute.Match(Object)</a>
- </div>
- <div>
- <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute#system-attribute-isdefaultattribute">Attribute.IsDefaultAttribute()</a>
- </div>
- <div>
- <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfoCount(System.UInt32)</span>
- </div>
- <div>
- <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetTypeInfo(System.UInt32, System.UInt32, System.IntPtr)</span>
- </div>
- <div>
- <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.GetIDsOfNames(System.Guid, System.IntPtr, System.UInt32, System.UInt32, System.IntPtr)</span>
- </div>
- <div>
- <span class="xref">System.Attribute.System.Runtime.InteropServices._Attribute.Invoke(System.UInt32, System.Guid, System.UInt32, System.Int16, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr)</span>
- </div>
- <div>
- <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid#system-attribute-typeid">Attribute.TypeId</a>
- </div>
- <div>
- <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
- </div>
- <div>
- <a class="xref" href="https://learn.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://learn.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://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
- </div>
- <div>
- <a class="xref" href="https://learn.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_PluginAttribute_syntax">Syntax</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
- public sealed class PluginAttribute : Attribute, _Attribute</code></pre>
- </div>
- <h3 id="constructors">Constructors
- </h3>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_PluginAttribute__ctor_IPA_RuntimeOptions_.md&value=---%0Auid%3A%20IPA.PluginAttribute.%23ctor(IPA.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">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/055778cc9d21c84349ea929f513db5e728767192/IPA.Loader/PluginInterfaces/Attributes/PluginAttribute.cs/#L27">View Source</a>
- </span>
- <a id="IPA_PluginAttribute__ctor_" data-uid="IPA.PluginAttribute.#ctor*"></a>
- <h4 id="IPA_PluginAttribute__ctor_IPA_RuntimeOptions_" data-uid="IPA.PluginAttribute.#ctor(IPA.RuntimeOptions)">PluginAttribute(RuntimeOptions)</h4>
- <div class="markdown level1 summary"><p>Initializes a <a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a> with the given <a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a>
- to indicate the runtime capabilities of the plugin.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public PluginAttribute(RuntimeOptions runtimeOptions)</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><a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a></td>
- <td><span class="parametername">runtimeOptions</span></td>
- <td><p>the options to use for this plugin</p>
- </td>
- </tr>
- </tbody>
- </table>
- <h3 id="properties">Properties
- </h3>
- <span class="small pull-right mobile-hide">
- <span class="divider">|</span>
- <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_PluginAttribute_RuntimeOptions.md&value=---%0Auid%3A%20IPA.PluginAttribute.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">Improve this Doc</a>
- </span>
- <span class="small pull-right mobile-hide">
- <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/055778cc9d21c84349ea929f513db5e728767192/IPA.Loader/PluginInterfaces/Attributes/PluginAttribute.cs/#L21">View Source</a>
- </span>
- <a id="IPA_PluginAttribute_RuntimeOptions_" data-uid="IPA.PluginAttribute.RuntimeOptions*"></a>
- <h4 id="IPA_PluginAttribute_RuntimeOptions" data-uid="IPA.PluginAttribute.RuntimeOptions">RuntimeOptions</h4>
- <div class="markdown level1 summary"><p>The <a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a> passed into the constructor of this attribute.</p>
- </div>
- <div class="markdown level1 conceptual"></div>
- <h5 class="decalaration">Declaration</h5>
- <div class="codewrapper">
- <pre><code class="lang-csharp hljs">public RuntimeOptions RuntimeOptions { get; }</code></pre>
- </div>
- <h5 class="propertyValue">Property Value</h5>
- <table class="table table-bordered table-striped table-condensed">
- <thead>
- <tr>
- <th>Type</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a></td>
- <td></td>
- </tr>
- </tbody>
- </table>
- <h3 id="implements">Implements</h3>
- <div>
- <a class="xref" href="https://learn.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.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>
- </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_PluginAttribute.md&value=---%0Auid%3A%20IPA.PluginAttribute%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/055778cc9d21c84349ea929f513db5e728767192/IPA.Loader/PluginInterfaces/Attributes/PluginAttribute.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">
- <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>
|
