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.

338 lines
21 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class OnStartAttribute
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class OnStartAttribute
  11. ">
  12. <meta name="generator" content="docfx 2.48.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.OnStartAttribute">
  74. <h1 id="IPA_OnStartAttribute" data-uid="IPA.OnStartAttribute" class="text-break">Class OnStartAttribute
  75. </h1>
  76. <div class="markdown level0 summary"><p>Indicates that the target method should be called when the game starts.</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  82. <div class="level1"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
  83. <div class="level2"><span class="xref">OnStartAttribute</span></div>
  84. </div>
  85. <div classs="implements">
  86. <h5>Implements</h5>
  87. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.runtime.interopservices._attribute">_Attribute</a></div>
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <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>
  93. </div>
  94. <div>
  95. <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>
  96. </div>
  97. <div>
  98. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#System_Attribute_GetCustomAttributes_System_Reflection_MemberInfo_">Attribute.GetCustomAttributes(MemberInfo)</a>
  99. </div>
  100. <div>
  101. <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>
  102. </div>
  103. <div>
  104. <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>
  105. </div>
  106. <div>
  107. <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>
  108. </div>
  109. <div>
  110. <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>
  111. </div>
  112. <div>
  113. <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>
  114. </div>
  115. <div>
  116. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#System_Attribute_GetCustomAttributes_System_Reflection_ParameterInfo_">Attribute.GetCustomAttributes(ParameterInfo)</a>
  117. </div>
  118. <div>
  119. <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>
  120. </div>
  121. <div>
  122. <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>
  123. </div>
  124. <div>
  125. <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>
  126. </div>
  127. <div>
  128. <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>
  129. </div>
  130. <div>
  131. <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>
  132. </div>
  133. <div>
  134. <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>
  135. </div>
  136. <div>
  137. <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>
  138. </div>
  139. <div>
  140. <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>
  141. </div>
  142. <div>
  143. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#System_Attribute_GetCustomAttributes_System_Reflection_Module_">Attribute.GetCustomAttributes(Module)</a>
  144. </div>
  145. <div>
  146. <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>
  147. </div>
  148. <div>
  149. <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>
  150. </div>
  151. <div>
  152. <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>
  153. </div>
  154. <div>
  155. <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>
  156. </div>
  157. <div>
  158. <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>
  159. </div>
  160. <div>
  161. <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>
  162. </div>
  163. <div>
  164. <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>
  165. </div>
  166. <div>
  167. <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>
  168. </div>
  169. <div>
  170. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.getcustomattributes#System_Attribute_GetCustomAttributes_System_Reflection_Assembly_">Attribute.GetCustomAttributes(Assembly)</a>
  171. </div>
  172. <div>
  173. <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>
  174. </div>
  175. <div>
  176. <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>
  177. </div>
  178. <div>
  179. <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>
  180. </div>
  181. <div>
  182. <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>
  183. </div>
  184. <div>
  185. <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>
  186. </div>
  187. <div>
  188. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.equals#System_Attribute_Equals_System_Object_">Attribute.Equals(Object)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.gethashcode#System_Attribute_GetHashCode">Attribute.GetHashCode()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.match#System_Attribute_Match_System_Object_">Attribute.Match(Object)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.isdefaultattribute#System_Attribute_IsDefaultAttribute">Attribute.IsDefaultAttribute()</a>
  198. </div>
  199. <div>
  200. <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>
  201. </div>
  202. <div>
  203. <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>
  204. </div>
  205. <div>
  206. <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>
  207. </div>
  208. <div>
  209. <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>
  210. </div>
  211. <div>
  212. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.attribute.typeid#System_Attribute_TypeId">Attribute.TypeId</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  216. </div>
  217. <div>
  218. <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>
  219. </div>
  220. <div>
  221. <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>
  222. </div>
  223. <div>
  224. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  228. </div>
  229. </div>
  230. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.html">IPA</a></h6>
  231. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  232. <h5 id="IPA_OnStartAttribute_syntax">Syntax</h5>
  233. <div class="codewrapper">
  234. <pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
  235. public sealed class OnStartAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute</code></pre>
  236. </div>
  237. <h5 id="IPA_OnStartAttribute_remarks"><strong>Remarks</strong></h5>
  238. <div class="markdown level0 remarks"><p>
  239. This attribute is interchangable with <a class="xref" href="IPA.OnEnableAttribute.html">OnEnableAttribute</a>, and is treated identically.
  240. They are seperate to allow plugin code to more clearly describe the intent of the methods.
  241. </p>
  242. <p>
  243. Typically, this will be used when the <a class="xref" href="IPA.RuntimeOptions.html">RuntimeOptions</a> parameter of the plugins&apos;s
  244. <a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a> is <a class="xref" href="IPA.RuntimeOptions.html#IPA_RuntimeOptions_SingleStartInit">SingleStartInit</a>.
  245. </p>
  246. </div>
  247. <h3 id="implements">Implements</h3>
  248. <div>
  249. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.runtime.interopservices._attribute">System.Runtime.InteropServices._Attribute</a>
  250. </div>
  251. <h3 id="extensionmethods">Extension Methods</h3>
  252. <div>
  253. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField_System_Object_System_String_System_Object_">ReflectionUtil.SetField(Object, String, Object)</a>
  254. </div>
  255. <div>
  256. <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>
  257. </div>
  258. <div>
  259. <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>
  260. </div>
  261. <div>
  262. <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>
  263. </div>
  264. <div>
  265. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetProperty(Object, String, Object)</a>
  266. </div>
  267. <div>
  268. <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>
  269. </div>
  270. <div>
  271. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod(Object, String, Object[])</a>
  272. </div>
  273. <div>
  274. <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>
  275. </div>
  276. <div>
  277. <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>
  278. </div>
  279. <div>
  280. <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>
  281. </div>
  282. <h3 id="seealso">See Also</h3>
  283. <div class="seealso">
  284. <div><a class="xref" href="IPA.PluginAttribute.html">PluginAttribute</a></div>
  285. <div><a class="xref" href="IPA.OnEnableAttribute.html">OnEnableAttribute</a></div>
  286. </div>
  287. </article>
  288. </div>
  289. <div class="hidden-sm col-md-2" role="complementary">
  290. <div class="sideaffix">
  291. <div class="contribution">
  292. <ul class="nav">
  293. <li>
  294. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_OnStartAttribute.md&amp;value=---%0Auid%3A%20IPA.OnStartAttribute%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>
  295. </li>
  296. <li>
  297. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/9705692cbf53e5b1f7667f378696cf6ea482054b/IPA.Loader/PluginInterfaces/Attributes/LifecycleAttributes.cs/#L53" class="contribution-link">View Source</a>
  298. </li>
  299. </ul>
  300. </div>
  301. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  302. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  303. </nav>
  304. </div>
  305. </div>
  306. </div>
  307. </div>
  308. <footer>
  309. <div class="grad-bottom"></div>
  310. <div class="footer">
  311. <div class="container">
  312. <span class="pull-right">
  313. <a href="#top">Back to top</a>
  314. </span>
  315. <span>Generated by <strong>DocFX</strong></span>
  316. </div>
  317. </div>
  318. </footer>
  319. </div>
  320. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  321. <script type="text/javascript" src="../styles/docfx.js"></script>
  322. <script type="text/javascript" src="../styles/main.js"></script>
  323. </body>
  324. </html>