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.

359 lines
21 KiB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>BeatSaberCustomUI</name>
  5. </assembly>
  6. <members>
  7. <member name="M:CustomUI.BeatSaber.BeatSaberUI.DisplayKeyboard(System.String,System.String,System.Action{System.String},System.Action{System.String},System.Action)">
  8. <summary>
  9. Display a keyboard interface to accept user input.
  10. </summary>
  11. <param name="title">The title to be displayed above the keyboard.</param>
  12. <param name="initialValue">The starting value of the keyboard.</param>
  13. <param name="TextChangedEvent">Callback when the text is modified by the user (when any key is pressed basically).</param>
  14. <param name="TextEntrySuccessEvent">Callback when the user successfully submits the changed text.</param>
  15. <param name="TextEntryCancelledEvent">Callback when the user presses the cancel button.</param>
  16. <returns></returns>
  17. </member>
  18. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateUIButton(UnityEngine.RectTransform,System.String,UnityEngine.Vector2,UnityEngine.Vector2,UnityEngine.Events.UnityAction,System.String,UnityEngine.Sprite)">
  19. <summary>
  20. Creates a copy of a template button and returns it.
  21. </summary>
  22. <param name="parent">The transform to parent the button to.</param>
  23. <param name="buttonTemplate">The name of the button to make a copy of. Example: "QuitButton", "PlayButton", etc.</param>
  24. <param name="anchoredPosition">The position the button should be anchored to.</param>
  25. <param name="sizeDelta">The size of the buttons RectTransform.</param>
  26. <param name="onClick">Callback for when the button is pressed.</param>
  27. <param name="buttonText">The text that should be shown on the button.</param>
  28. <param name="icon">The icon that should be shown on the button.</param>
  29. <returns>The newly created button.</returns>
  30. </member>
  31. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateUIButton(UnityEngine.RectTransform,System.String,UnityEngine.Vector2,UnityEngine.Events.UnityAction,System.String,UnityEngine.Sprite)">
  32. <summary>
  33. Creates a copy of a template button and returns it.
  34. </summary>
  35. <param name="parent">The transform to parent the button to.</param>
  36. <param name="buttonTemplate">The name of the button to make a copy of. Example: "QuitButton", "PlayButton", etc.</param>
  37. <param name="anchoredPosition">The position the button should be anchored to.</param>
  38. <param name="onClick">Callback for when the button is pressed.</param>
  39. <param name="buttonText">The text that should be shown on the button.</param>
  40. <param name="icon">The icon that should be shown on the button.</param>
  41. <returns>The newly created button.</returns>
  42. </member>
  43. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateUIButton(UnityEngine.RectTransform,System.String,UnityEngine.Events.UnityAction,System.String,UnityEngine.Sprite)">
  44. <summary>
  45. Creates a copy of a template button and returns it.
  46. </summary>
  47. <param name="parent">The transform to parent the button to.</param>
  48. <param name="buttonTemplate">The name of the button to make a copy of. Example: "QuitButton", "PlayButton", etc.</param>
  49. <param name="onClick">Callback for when the button is pressed.</param>
  50. <param name="buttonText">The text that should be shown on the button.</param>
  51. <param name="icon">The icon that should be shown on the button.</param>
  52. <returns>The newly created button.</returns>
  53. </member>
  54. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateBackButton(UnityEngine.RectTransform,UnityEngine.Events.UnityAction)">
  55. <summary>
  56. Creates a copy of a back button.
  57. </summary>
  58. <param name="parent">The transform to parent the new button to.</param>
  59. <param name="onClick">Callback for when the button is pressed.</param>
  60. <returns>The newly created back button.</returns>
  61. </member>
  62. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateViewController``1">
  63. <summary>
  64. Creates a VRUIViewController of type T, and marks it to not be destroyed.
  65. </summary>
  66. <typeparam name="T">The variation of VRUIViewController you want to create.</typeparam>
  67. <returns>The newly created VRUIViewController of type T.</returns>
  68. </member>
  69. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateCustomMenu``1(System.String)">
  70. <summary>
  71. Creates a CustomMenu, which is basically a custom panel that handles UI transitions for you automatically.
  72. </summary>
  73. <typeparam name="T">The type of CustomMenu to instantiate.</typeparam>
  74. <param name="title">The title of the new CustomMenu.</param>
  75. <returns>The newly created CustomMenu of type T.</returns>
  76. </member>
  77. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateLoadingSpinner(UnityEngine.Transform)">
  78. <summary>
  79. Creates a loading spinner.
  80. </summary>
  81. <param name="parent">The transform to parent the new loading spinner to.</param>
  82. <returns>The newly created loading spinner.</returns>
  83. </member>
  84. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateText(UnityEngine.RectTransform,System.String,UnityEngine.Vector2)">
  85. <summary>
  86. Creates a TextMeshProUGUI component.
  87. </summary>
  88. <param name="parent">Thet ransform to parent the new TextMeshProUGUI component to.</param>
  89. <param name="text">The text to be displayed.</param>
  90. <param name="anchoredPosition">The position the button should be anchored to.</param>
  91. <returns>The newly created TextMeshProUGUI component.</returns>
  92. </member>
  93. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateText(UnityEngine.RectTransform,System.String,UnityEngine.Vector2,UnityEngine.Vector2)">
  94. <summary>
  95. Creates a TextMeshProUGUI component.
  96. </summary>
  97. <param name="parent">Thet transform to parent the new TextMeshProUGUI component to.</param>
  98. <param name="text">The text to be displayed.</param>
  99. <param name="anchoredPosition">The position the text component should be anchored to.</param>
  100. <param name="sizeDelta">The size of the text components RectTransform.</param>
  101. <returns>The newly created TextMeshProUGUI component.</returns>
  102. </member>
  103. <member name="M:CustomUI.BeatSaber.BeatSaberUI.AddHintText(UnityEngine.RectTransform,System.String)">
  104. <summary>
  105. Adds hint text to any component that handles pointer events.
  106. </summary>
  107. <param name="parent">Thet transform to parent the new HoverHint component to.</param>
  108. <param name="text">The text to be displayed on the HoverHint panel.</param>
  109. <returns>The newly created HoverHint component.</returns>
  110. </member>
  111. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateUISlider(UnityEngine.Transform,System.Single,System.Single,System.Single,System.Boolean,UnityEngine.Events.UnityAction{System.Single})">
  112. <summary>
  113. Creates a custom slider.
  114. </summary>
  115. <param name="parent">Thet transform to parent the new slider component to.</param>
  116. <param name="min">The minimum value of the slider.</param>
  117. <param name="max">The maximum value of the slider.</param>
  118. <param name="increment">The amount to increment the slider by.</param>
  119. <param name="intValues">True if the value represented by the slider is an int, false if it's a float.</param>
  120. <param name="onValueChanged">Callback when the sliders value changes.</param>
  121. <returns></returns>
  122. </member>
  123. <member name="M:CustomUI.BeatSaber.BeatSaberUI.CreateColorPicker(UnityEngine.RectTransform,UnityEngine.Vector2,UnityEngine.Vector2)">
  124. <summary>
  125. Creates a color picker.
  126. </summary>
  127. <param name="parent">Thet transform to parent the new color picker to.</param>
  128. <param name="anchoredPosition">The position the color picker should be anchored to.</param>
  129. <param name="sizeDelta">The size of the color picker's RectTransform.</param>
  130. <returns></returns>
  131. </member>
  132. <member name="F:CustomUI.BeatSaber.CustomFlowCoordinator.parentFlowCoordinator">
  133. <summary>
  134. The FlowCoordinator that presented this FlowCoordinator
  135. </summary>
  136. </member>
  137. <member name="F:CustomUI.BeatSaber.CustomFlowCoordinator.customPanel">
  138. <summary>
  139. The CustomMenu this FlowCoordinator is representing.
  140. </summary>
  141. </member>
  142. <member name="M:CustomUI.BeatSaber.CustomFlowCoordinator.Dismiss(System.Boolean)">
  143. <summary>
  144. Back out to the previous flow coordinator.
  145. </summary>
  146. <param name="immediately">If set to true, no animation will be shown and the transition will be instant.</param>
  147. </member>
  148. <member name="M:CustomUI.BeatSaber.CustomFlowCoordinator.Dismiss">
  149. <summary>
  150. Back out to the previous flow coordinator with an animation.
  151. </summary>
  152. </member>
  153. <member name="F:CustomUI.BeatSaber.CustomListViewController.includePageButtons">
  154. <summary>
  155. Whether or not to include a back button when the ViewController is activated.
  156. </summary>
  157. </member>
  158. <member name="F:CustomUI.BeatSaber.CustomListViewController._pageUpButton">
  159. <summary>
  160. A reference to the page up button, if it exists.
  161. </summary>
  162. </member>
  163. <member name="F:CustomUI.BeatSaber.CustomListViewController._pageDownButton">
  164. <summary>
  165. A reference to the page down button, if it exists.
  166. </summary>
  167. </member>
  168. <member name="F:CustomUI.BeatSaber.CustomListViewController._customListTableView">
  169. <summary>
  170. The TableView associated with the current CustomListViewController.
  171. </summary>
  172. </member>
  173. <member name="F:CustomUI.BeatSaber.CustomListViewController.Data">
  174. <summary>
  175. The data to be displayed in the table.
  176. </summary>
  177. </member>
  178. <member name="F:CustomUI.BeatSaber.CustomListViewController.DidSelectRowEvent">
  179. <summary>
  180. An event fired when the user selects a cell in the TableView.
  181. </summary>
  182. </member>
  183. <member name="F:CustomUI.BeatSaber.CustomListViewController.reuseIdentifier">
  184. <summary>
  185. The reuse identifier, which is used to recycle cells instead of instantiating new instances of them.
  186. </summary>
  187. </member>
  188. <member name="F:CustomUI.BeatSaber.CustomListViewController._songListTableCellInstance">
  189. <summary>
  190. The prefab used to instantiate new table cells.
  191. </summary>
  192. </member>
  193. <member name="M:CustomUI.BeatSaber.CustomListViewController.GetTableCell(System.Int32,System.Boolean)">
  194. <summary>
  195. Instantiates a new LevelListTableCell (or recycles an old one).
  196. </summary>
  197. <param name="row">This param does nothing, and was left in by mistake.</param>
  198. <param name="beatmapCharacteristicImages">If set to false, the BeatmapCharacteristicImages will be destroyed.</param>
  199. <returns></returns>
  200. </member>
  201. <member name="M:CustomUI.BeatSaber.CustomListViewController.GetTableCell(System.Boolean)">
  202. <summary>
  203. Instantiates a new LevelListTableCell (or recycles an old one).
  204. </summary>
  205. <param name="beatmapCharacteristicImages">If set to false, the BeatmapCharacteristicImages will be destroyed.</param>
  206. <returns></returns>
  207. </member>
  208. <member name="P:CustomUI.BeatSaber.CustomMenu.customFlowCoordinator">
  209. <summary>
  210. The CustomFlowCoordinator associated with this CustomMenu. This will not be populated if you have no main CustomViewController.
  211. </summary>
  212. </member>
  213. <member name="F:CustomUI.BeatSaber.CustomMenu.mainViewController">
  214. <summary>
  215. The main CustomViewController associated with this menu.
  216. </summary>
  217. </member>
  218. <member name="F:CustomUI.BeatSaber.CustomMenu.leftViewController">
  219. <summary>
  220. The left CustomViewController associated with this menu.
  221. </summary>
  222. </member>
  223. <member name="F:CustomUI.BeatSaber.CustomMenu.rightViewController">
  224. <summary>
  225. The right CustomViewController associated with this menu.
  226. </summary>
  227. </member>
  228. <member name="F:CustomUI.BeatSaber.CustomMenu.bottomViewController">
  229. <summary>
  230. The bottom CustomViewController associated with this menu.
  231. </summary>
  232. </member>
  233. <member name="M:CustomUI.BeatSaber.CustomMenu.SetMainViewController(CustomUI.BeatSaber.CustomViewController,System.Boolean,System.Action{System.Boolean,VRUI.VRUIViewController.ActivationType},System.Action{VRUI.VRUIViewController.DeactivationType})">
  234. <summary>
  235. Sets up the main CustomViewController.
  236. </summary>
  237. <param name="viewController">The viewcontroller to set.</param>
  238. <param name="includeBackButton">Whether or not to generate a back button.</param>
  239. <param name="DidActivate">Optional, a callback when the ViewController becomes active (when you open it).</param>
  240. <param name="DidDeactivate">Optional, a callback when the ViewController becomes inactive (when you close it).</param>
  241. </member>
  242. <member name="M:CustomUI.BeatSaber.CustomMenu.SetLeftViewController(CustomUI.BeatSaber.CustomViewController,System.Boolean,System.Action{System.Boolean,VRUI.VRUIViewController.ActivationType},System.Action{VRUI.VRUIViewController.DeactivationType})">
  243. <summary>
  244. Sets up the left CustomViewController.
  245. </summary>
  246. <param name="viewController">The viewcontroller to set.</param>
  247. <param name="includeBackButton">Whether or not to generate a back button.</param>
  248. <param name="DidActivate">Optional, a callback when the ViewController becomes active (when you open it).</param>
  249. <param name="DidDeactivate">Optional, a callback when the ViewController becomes inactive (when you close it).</param>
  250. </member>
  251. <member name="M:CustomUI.BeatSaber.CustomMenu.SetRightViewController(CustomUI.BeatSaber.CustomViewController,System.Boolean,System.Action{System.Boolean,VRUI.VRUIViewController.ActivationType},System.Action{VRUI.VRUIViewController.DeactivationType})">
  252. <summary>
  253. Sets up the right CustomViewController.
  254. </summary>
  255. <param name="viewController">The viewcontroller to set.</param>
  256. <param name="includeBackButton">Whether or not to generate a back button.</param>
  257. <param name="DidActivate">Optional, a callback when the ViewController becomes active (when you open it).</param>
  258. <param name="DidDeactivate">Optional, a callback when the ViewController becomes inactive (when you close it).</param>
  259. </member>
  260. <member name="M:CustomUI.BeatSaber.CustomMenu.SetBottomViewController(CustomUI.BeatSaber.CustomViewController,System.Boolean,System.Action{System.Boolean,VRUI.VRUIViewController.ActivationType},System.Action{VRUI.VRUIViewController.DeactivationType})">
  261. <summary>
  262. Sets up the bottom CustomViewController.
  263. </summary>
  264. <param name="viewController">The viewcontroller to set.</param>
  265. <param name="includeBackButton">Whether or not to generate a back button.</param>
  266. <param name="DidActivate">Optional, a callback when the ViewController becomes active (when you open it).</param>
  267. <param name="DidDeactivate">Optional, a callback when the ViewController becomes inactive (when you close it).</param>
  268. </member>
  269. <member name="M:CustomUI.BeatSaber.CustomMenu.Present(System.Boolean)">
  270. <summary>
  271. Opens the menu.
  272. </summary>
  273. <param name="immediately">If set to true, no animation will be shown and the transition will be instant.</param>
  274. <returns></returns>
  275. </member>
  276. <member name="M:CustomUI.BeatSaber.CustomMenu.Present">
  277. <summary>
  278. Opens the menu with an animation.
  279. </summary>
  280. </member>
  281. <member name="M:CustomUI.BeatSaber.CustomMenu.Dismiss(System.Boolean)">
  282. <summary>
  283. Closes the menu.
  284. </summary>
  285. <param name="immediately">If set to true, no animation will be shown and the transition will be instant.</param>
  286. </member>
  287. <member name="M:CustomUI.BeatSaber.CustomMenu.Dismiss">
  288. <summary>
  289. Closes the menu with an animation.
  290. </summary>
  291. </member>
  292. <member name="F:CustomUI.BeatSaber.CustomViewController.backButtonPressed">
  293. <summary>
  294. The event that's fired when the back button is pressed.
  295. </summary>
  296. </member>
  297. <member name="F:CustomUI.BeatSaber.CustomViewController._backButton">
  298. <summary>
  299. A reference to the current back button, if it exists.
  300. </summary>
  301. </member>
  302. <member name="F:CustomUI.BeatSaber.CustomViewController.includeBackButton">
  303. <summary>
  304. When set to true, a back button will be automatically generated.
  305. </summary>
  306. </member>
  307. <member name="F:CustomUI.BeatSaber.CustomViewController.DidActivateEvent">
  308. <summary>
  309. The event that's fired when the CustomViewController is activated (when you open it).
  310. </summary>
  311. </member>
  312. <member name="F:CustomUI.BeatSaber.CustomViewController.DidDeactivateEvent">
  313. <summary>
  314. The event that's fired when the CustomViewController is deactivated (when you close it).
  315. </summary>
  316. </member>
  317. <member name="M:CustomUI.BeatSaber.CustomViewController.ClearBackButtonCallbacks">
  318. <summary>
  319. Clears any back button callbacks.
  320. </summary>
  321. </member>
  322. <member name="M:CustomUI.UIElements.ColorPicker.SetPreviewColor(UnityEngine.Color)">
  323. <summary>
  324. Sets the <see cref="F:CustomUI.UIElements.ColorPicker.ColorPickerPreview"/> color while also updating all associated <see cref="T:CustomUI.UIElements.CustomSlider"/> components.
  325. </summary>
  326. <param name="color">The <see cref="T:UnityEngine.Color"/> to set the preview image</param>
  327. </member>
  328. <member name="M:CustomUI.UIElements.ColorPicker.GetSelectedColorFromImage(UnityEngine.EventSystems.PointerEventData,HMUI.Image)">
  329. <summary>
  330. Get the color of a sprite contained in an <see cref="T:HMUI.Image"/> on pointer click
  331. </summary>
  332. <param name="pointerData">The <see cref="T:UnityEngine.EventSystems.PointerEventData"/> given by OnPointerDown</param>
  333. <param name="image">The <see cref="T:HMUI.Image"/> instance</param>
  334. </member>
  335. <member name="M:CustomUI.UIElements.ColorPickerCore.Initialize(System.Action{UnityEngine.Color})">
  336. <summary>
  337. Initialize the <see cref="T:CustomUI.UIElements.ColorPickerCore"/> (should be called after assigning the <see cref="F:CustomUI.UIElements.ColorPickerCore.ColorPickerPreview"/> variable)
  338. </summary>
  339. </member>
  340. <member name="M:CustomUI.UIElements.ColorPickerCore.OnPointerDown(UnityEngine.EventSystems.PointerEventData)">
  341. <summary>
  342. Method called when the pointer is clicked inside the <see cref="T:CustomUI.UIElements.ColorPickerCore"/>
  343. </summary>
  344. <param name="eventData">Some informations about the pointer</param>
  345. </member>
  346. <member name="M:CustomUI.UIElements.ColorPickerCore.OnPointerUp(UnityEngine.EventSystems.PointerEventData)">
  347. <summary>
  348. Method called when the pointer is released inside the <see cref="T:CustomUI.UIElements.ColorPickerCore"/>
  349. </summary>
  350. <param name="eventData">Some informations about the pointer</param>
  351. </member>
  352. <member name="M:CustomUI.UIElements.ColorPickerCore.OnPointerExit(UnityEngine.EventSystems.PointerEventData)">
  353. <summary>
  354. Method called when the pointer is exiting the <see cref="T:CustomUI.UIElements.ColorPickerCore"/>
  355. </summary>
  356. <param name="eventData">Some informations about the pointer</param>
  357. </member>
  358. </members>
  359. </doc>