Guest User

rage native ui

a guest
Jul 1st, 2016
629
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 40.09 KB | None | 0 0
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>RAGENativeUI</name>
  5. </assembly>
  6. <members>
  7. <member name="T:RAGENativeUI.Common.EFont">
  8. <summary>
  9. Fonts used by GTA V
  10. </summary>
  11. </member>
  12. <member name="M:RAGENativeUI.Common.IsDisabledControlPressed(System.Int32,Rage.GameControl)">
  13. <summary>
  14. Check if a Rage.GameControl is pressed while it's disabled
  15. </summary>
  16. <param name="index"></param>
  17. <param name="control"></param>
  18. <returns>true if a Rage.GameControl is pressed while it's disabled</returns>
  19. </member>
  20. <member name="M:RAGENativeUI.Common.IsDisabledControlJustPressed(System.Int32,Rage.GameControl)">
  21. <summary>
  22. Check if a Rage.GameControl is just pressed while it's disabled
  23. </summary>
  24. <param name="index"></param>
  25. <param name="control"></param>
  26. <returns>true if a Rage.GameControl is just pressed while it's disabled</returns>
  27. </member>
  28. <member name="M:RAGENativeUI.Common.IsDisabledControlJustReleased(System.Int32,Rage.GameControl)">
  29. <summary>
  30. Check if a Rage.GameControl is just released while it's disabled
  31. </summary>
  32. <param name="index"></param>
  33. <param name="control"></param>
  34. <returns>true if a Rage.GameControl is just released while it's disabled</returns>
  35. </member>
  36. <member name="P:RAGENativeUI.Elements.BarTimerBar.Percentage">
  37. <summary>
  38. Bar percentage. Goes from 0 to 1.
  39. </summary>
  40. </member>
  41. <member name="M:RAGENativeUI.Elements.InstructionalButton.#ctor(Rage.GameControl,System.String)">
  42. <summary>
  43. Add a dynamic button to the instructional buttons array.
  44. Changes whether the controller is being used and changes depending on keybinds.
  45. </summary>
  46. <param name="control">Rage.GameControl that gets converted into a button.</param>
  47. <param name="text">Help text that goes with the button.</param>
  48. </member>
  49. <member name="M:RAGENativeUI.Elements.InstructionalButton.#ctor(System.String,System.String)">
  50. <summary>
  51. Adds a keyboard button to the instructional buttons array.
  52. </summary>
  53. <param name="keystring">Custom keyboard button, like "I", or "O", or "F5".</param>
  54. <param name="text">Help text that goes with the button.</param>
  55. </member>
  56. <member name="M:RAGENativeUI.Elements.InstructionalButton.BindToItem(RAGENativeUI.Elements.UIMenuItem)">
  57. <summary>
  58. Bind this button to an item, so it's only shown when that item is selected.
  59. </summary>
  60. <param name="item">Item to bind to.</param>
  61. </member>
  62. <member name="T:RAGENativeUI.Elements.UIMenuSwitchMenusItem">
  63. <summary>
  64. List item that holds an <see cref="T:RAGENativeUI.UIMenu"/> list and allows to easily switch between those menus.
  65. </summary>
  66. <remarks>
  67. All the <see cref="T:RAGENativeUI.UIMenu"/>s must have the same instance of this <see cref="T:RAGENativeUI.Elements.UIMenuSwitchMenusItem"/> and
  68. is recommended to use the property <see cref="P:RAGENativeUI.Elements.UIMenuSwitchMenusItem.CurrentMenu"/> to make the menu visible without issues.
  69. </remarks>
  70. </member>
  71. <member name="P:RAGENativeUI.Elements.UIMenuSwitchMenusItem.CurrentMenu">
  72. <summary>
  73. The currently selected menu. Use this to make the proper menu visible when using this item.
  74. </summary>
  75. </member>
  76. <member name="P:RAGENativeUI.Elements.UIMenuSwitchMenusItem.Index">
  77. <summary>
  78. Returns the current selected index.
  79. </summary>
  80. </member>
  81. <member name="M:RAGENativeUI.Elements.UIMenuSwitchMenusItem.#ctor(System.String,System.Collections.Generic.List{RAGENativeUI.UIMenu},System.Int32)">
  82. <summary>
  83. List item, with left/right arrows that switches the current menu depending on the current <see cref="T:RAGENativeUI.UIMenu"/> item.
  84. Uses the menus titles as the names in the list.
  85. </summary>
  86. <param name="text">Item label.</param>
  87. <param name="menus">List that contains your <see cref="T:RAGENativeUI.UIMenu"/>s.</param>
  88. <param name="index">Index in the list. If unsure user 0.</param>
  89. </member>
  90. <member name="M:RAGENativeUI.Elements.UIMenuSwitchMenusItem.#ctor(System.String,System.Collections.Generic.List{RAGENativeUI.UIMenu},System.Int32,System.String)">
  91. <summary>
  92. List item, with left/right arrows that switches the current menu depending on the current <see cref="T:RAGENativeUI.UIMenu"/> item.
  93. Uses the menus titles as the names in the list.
  94. </summary>
  95. <param name="text">Item label.</param>
  96. <param name="menus">List that contains your <see cref="T:RAGENativeUI.UIMenu"/>s.</param>
  97. <param name="index">Index in the list. If unsure user 0.</param>
  98. <param name="description">Description for this item.</param>
  99. </member>
  100. <member name="M:RAGENativeUI.Elements.UIMenuSwitchMenusItem.#ctor(System.String,System.Collections.Generic.List{RAGENativeUI.UIMenu},System.Collections.Generic.List{System.String},System.Int32)">
  101. <summary>
  102. List item, with left/right arrows that switches the current menu depending on the current <see cref="T:RAGENativeUI.UIMenu"/> item.
  103. The menus list and the menus names list must have the same items count.
  104. </summary>
  105. <param name="text">Item label.</param>
  106. <param name="menus">List that contains your <see cref="T:RAGENativeUI.UIMenu"/>s.</param>
  107. <param name="menusNames">List that contains a name for each <see cref="T:RAGENativeUI.UIMenu"/> in the same order</param>
  108. <param name="index">Index in the list. If unsure user 0.</param>
  109. </member>
  110. <member name="M:RAGENativeUI.Elements.UIMenuSwitchMenusItem.#ctor(System.String,System.Collections.Generic.List{RAGENativeUI.UIMenu},System.Collections.Generic.List{System.String},System.Int32,System.String)">
  111. <summary>
  112. List item, with left/right arrows that switches the current menu depending on the current <see cref="T:RAGENativeUI.UIMenu"/> item.
  113. The menus list and the menus names list must have the same items count.
  114. </summary>
  115. <param name="text">Item label.</param>
  116. <param name="menus">List that contains your <see cref="T:RAGENativeUI.UIMenu"/>s.</param>
  117. <param name="menusNames">List that contains a name for each <see cref="T:RAGENativeUI.UIMenu"/> in the same order</param>
  118. <param name="index">Index in the list. If unsure user 0.</param>
  119. <param name="description">Description for this item.</param>
  120. </member>
  121. <member name="M:RAGENativeUI.Elements.UIMenuSwitchMenusItem.MenuToIndex(RAGENativeUI.UIMenu)">
  122. <summary>
  123. Find a menu in the list and return it's index.
  124. </summary>
  125. <param name="menu">Menu to search for.</param>
  126. <returns>Item index.</returns>
  127. </member>
  128. <member name="M:RAGENativeUI.Elements.UIMenuSwitchMenusItem.IndexToMenu(System.Int32)">
  129. <summary>
  130. Find a menu by it's index and return the menu.
  131. </summary>
  132. <param name="index">Menu's index.</param>
  133. <returns>Menu</returns>
  134. </member>
  135. <member name="M:RAGENativeUI.Elements.Sprite.#ctor(System.String,System.String,System.Drawing.Point,System.Drawing.Size,System.Single,System.Drawing.Color)">
  136. <summary>
  137. Creates a game sprite object from a texture dictionary and texture name.
  138. </summary>
  139. <param name="textureDict"></param>
  140. <param name="textureName"></param>
  141. <param name="position"></param>
  142. <param name="size"></param>
  143. <param name="heading"></param>
  144. <param name="color"></param>
  145. </member>
  146. <member name="M:RAGENativeUI.Elements.Sprite.#ctor(System.String,System.String,System.Drawing.Point,System.Drawing.Size)">
  147. <summary>
  148. Creates a game sprite object from a texture dictionary and texture name.
  149. </summary>
  150. <param name="textureDict"></param>
  151. <param name="textureName"></param>
  152. <param name="position"></param>
  153. <param name="size"></param>
  154. </member>
  155. <member name="M:RAGENativeUI.Elements.Sprite.Draw">
  156. <summary>
  157. Draws the sprite on a 1080-pixels height base.
  158. </summary>
  159. </member>
  160. <member name="M:RAGENativeUI.Elements.Sprite.DrawTexture(Rage.Texture,System.Drawing.Point,System.Drawing.Size,Rage.GraphicsEventArgs)">
  161. <summary>
  162. Draw a custom texture from a file on a 1080-pixels height base.
  163. </summary>
  164. <param name="texture">Your custom texture object.</param>
  165. <param name="position"></param>
  166. <param name="size"></param>
  167. </member>
  168. <member name="M:RAGENativeUI.Elements.Sprite.WriteFileFromResources(System.Reflection.Assembly,System.String)">
  169. <summary>
  170. Save an embedded resource to a temporary file.
  171. </summary>
  172. <param name="yourAssembly">Your executing assembly.</param>
  173. <param name="fullResourceName">Resource name including your solution name. E.G MyMenuMod.banner.png</param>
  174. <returns>Absolute path to the written file.</returns>
  175. </member>
  176. <member name="M:RAGENativeUI.Elements.Sprite.WriteFileFromResources(System.Reflection.Assembly,System.String,System.String)">
  177. <summary>
  178. Save an embedded resource to a concrete path.
  179. </summary>
  180. <param name="yourAssembly">Your executing assembly.</param>
  181. <param name="fullResourceName">Resource name including your solution name. E.G MyMenuMod.banner.png</param>
  182. <param name="savePath">Path to where save the file, including the filename.</param>
  183. <returns>Absolute path to the written file.</returns>
  184. </member>
  185. <member name="E:RAGENativeUI.Elements.UIMenuCheckboxItem.CheckboxEvent">
  186. <summary>
  187. Triggered when the checkbox state is changed.
  188. </summary>
  189. </member>
  190. <member name="M:RAGENativeUI.Elements.UIMenuCheckboxItem.#ctor(System.String,System.Boolean)">
  191. <summary>
  192. Checkbox item with a toggleable checkbox.
  193. </summary>
  194. <param name="text">Item label.</param>
  195. <param name="check">Boolean value whether the checkbox is checked.</param>
  196. </member>
  197. <member name="M:RAGENativeUI.Elements.UIMenuCheckboxItem.#ctor(System.String,System.Boolean,System.String)">
  198. <summary>
  199. Checkbox item with a toggleable checkbox.
  200. </summary>
  201. <param name="text">Item label.</param>
  202. <param name="check">Boolean value whether the checkbox is checked.</param>
  203. <param name="description">Description for this item.</param>
  204. </member>
  205. <member name="P:RAGENativeUI.Elements.UIMenuCheckboxItem.Checked">
  206. <summary>
  207. Change or get whether the checkbox is checked.
  208. </summary>
  209. </member>
  210. <member name="M:RAGENativeUI.Elements.UIMenuCheckboxItem.Position(System.Int32)">
  211. <summary>
  212. Change item's position.
  213. </summary>
  214. <param name="y">New Y value.</param>
  215. </member>
  216. <member name="M:RAGENativeUI.Elements.UIMenuCheckboxItem.Draw">
  217. <summary>
  218. Draw item.
  219. </summary>
  220. </member>
  221. <member name="T:RAGENativeUI.Elements.UIMenuItem">
  222. <summary>
  223. Simple item with a label.
  224. </summary>
  225. </member>
  226. <member name="E:RAGENativeUI.Elements.UIMenuItem.Activated">
  227. <summary>
  228. Called when user selects the current item.
  229. </summary>
  230. </member>
  231. <member name="M:RAGENativeUI.Elements.UIMenuItem.#ctor(System.String)">
  232. <summary>
  233. Basic menu button.
  234. </summary>
  235. <param name="text">Button label.</param>
  236. </member>
  237. <member name="M:RAGENativeUI.Elements.UIMenuItem.#ctor(System.String,System.String)">
  238. <summary>
  239. Basic menu button.
  240. </summary>
  241. <param name="text">Button label.</param>
  242. <param name="description">Description.</param>
  243. </member>
  244. <member name="P:RAGENativeUI.Elements.UIMenuItem.Selected">
  245. <summary>
  246. Whether this item is currently selected.
  247. </summary>
  248. </member>
  249. <member name="P:RAGENativeUI.Elements.UIMenuItem.Hovered">
  250. <summary>
  251. Whether this item is currently being hovered on with a mouse.
  252. </summary>
  253. </member>
  254. <member name="P:RAGENativeUI.Elements.UIMenuItem.Description">
  255. <summary>
  256. This item's description.
  257. </summary>
  258. </member>
  259. <member name="P:RAGENativeUI.Elements.UIMenuItem.Enabled">
  260. <summary>
  261. Whether this item is enabled or disabled (text is greyed out and you cannot select it).
  262. </summary>
  263. </member>
  264. <member name="M:RAGENativeUI.Elements.UIMenuItem.Position(System.Int32)">
  265. <summary>
  266. Set item's position.
  267. </summary>
  268. <param name="y"></param>
  269. </member>
  270. <member name="M:RAGENativeUI.Elements.UIMenuItem.Draw">
  271. <summary>
  272. Draw this item.
  273. </summary>
  274. </member>
  275. <member name="P:RAGENativeUI.Elements.UIMenuItem.Offset">
  276. <summary>
  277. This item's offset.
  278. </summary>
  279. </member>
  280. <member name="P:RAGENativeUI.Elements.UIMenuItem.Text">
  281. <summary>
  282. Returns this item's label.
  283. </summary>
  284. </member>
  285. <member name="M:RAGENativeUI.Elements.UIMenuItem.SetLeftBadge(RAGENativeUI.Elements.UIMenuItem.BadgeStyle)">
  286. <summary>
  287. Set the left badge. Set it to None to remove the badge.
  288. </summary>
  289. <param name="badge"></param>
  290. </member>
  291. <member name="M:RAGENativeUI.Elements.UIMenuItem.SetRightBadge(RAGENativeUI.Elements.UIMenuItem.BadgeStyle)">
  292. <summary>
  293. Set the right badge. Set it to None to remove the badge.
  294. </summary>
  295. <param name="badge"></param>
  296. </member>
  297. <member name="M:RAGENativeUI.Elements.UIMenuItem.SetRightLabel(System.String)">
  298. <summary>
  299. Set the right label.
  300. </summary>
  301. <param name="text">Text as label. Set it to "" to remove the label.</param>
  302. </member>
  303. <member name="P:RAGENativeUI.Elements.UIMenuItem.RightLabel">
  304. <summary>
  305. Returns the current right label.
  306. </summary>
  307. </member>
  308. <member name="P:RAGENativeUI.Elements.UIMenuItem.LeftBadge">
  309. <summary>
  310. Returns the current left badge.
  311. </summary>
  312. </member>
  313. <member name="P:RAGENativeUI.Elements.UIMenuItem.RightBadge">
  314. <summary>
  315. Returns the current right badge.
  316. </summary>
  317. </member>
  318. <member name="P:RAGENativeUI.Elements.UIMenuItem.Parent">
  319. <summary>
  320. Returns the menu this item is in.
  321. </summary>
  322. </member>
  323. <member name="E:RAGENativeUI.Elements.UIMenuListItem.OnListChanged">
  324. <summary>
  325. Triggered when the list is changed.
  326. </summary>
  327. </member>
  328. <member name="P:RAGENativeUI.Elements.UIMenuListItem.Index">
  329. <summary>
  330. Returns the current selected index.
  331. </summary>
  332. </member>
  333. <member name="M:RAGENativeUI.Elements.UIMenuListItem.#ctor(System.String,System.Collections.Generic.List{System.Object},System.Int32)">
  334. <summary>
  335. List item, with left/right arrows.
  336. </summary>
  337. <param name="text">Item label.</param>
  338. <param name="items">List that contains your items.</param>
  339. <param name="index">Index in the list. If unsure user 0.</param>
  340. </member>
  341. <member name="M:RAGENativeUI.Elements.UIMenuListItem.#ctor(System.String,System.Collections.Generic.List{System.Object},System.Int32,System.String)">
  342. <summary>
  343. List item, with left/right arrows.
  344. </summary>
  345. <param name="text">Item label.</param>
  346. <param name="items">List that contains your items.</param>
  347. <param name="index">Index in the list. If unsure user 0.</param>
  348. <param name="description">Description for this item.</param>
  349. </member>
  350. <member name="M:RAGENativeUI.Elements.UIMenuListItem.Position(System.Int32)">
  351. <summary>
  352. Change item's position.
  353. </summary>
  354. <param name="y">New Y position.</param>
  355. </member>
  356. <member name="M:RAGENativeUI.Elements.UIMenuListItem.ItemToIndex(System.Object)">
  357. <summary>
  358. Find an item in the list and return it's index.
  359. </summary>
  360. <param name="item">Item to search for.</param>
  361. <returns>Item index.</returns>
  362. </member>
  363. <member name="M:RAGENativeUI.Elements.UIMenuListItem.IndexToItem(System.Int32)">
  364. <summary>
  365. Find an item by it's index and return the item.
  366. </summary>
  367. <param name="index">Item's index.</param>
  368. <returns>Item</returns>
  369. </member>
  370. <member name="M:RAGENativeUI.Elements.UIMenuListItem.Draw">
  371. <summary>
  372. Draw item.
  373. </summary>
  374. </member>
  375. <member name="T:RAGENativeUI.Elements.ResRectangle">
  376. <summary>
  377. A rectangle in 1080 pixels height system.
  378. </summary>
  379. </member>
  380. <member name="T:RAGENativeUI.Elements.ResText">
  381. <summary>
  382. A Text object in the 1080 pixels height base system.
  383. </summary>
  384. </member>
  385. <member name="M:RAGENativeUI.Elements.ResText.AddLongString(System.String)">
  386. <summary>
  387. Push a long string into the stack.
  388. </summary>
  389. <param name="str"></param>
  390. </member>
  391. <member name="T:RAGENativeUI.MenuPool">
  392. <summary>
  393. Helper class that handles all of your Menus. After instatiating it, you will have to add your menu by using the Add method.
  394. </summary>
  395. </member>
  396. <member name="M:RAGENativeUI.MenuPool.Add(RAGENativeUI.UIMenu)">
  397. <summary>
  398. Add your menu to the menu pool.
  399. </summary>
  400. <param name="menu"></param>
  401. </member>
  402. <member name="M:RAGENativeUI.MenuPool.Remove(RAGENativeUI.UIMenu)">
  403. <summary>
  404. Removes the specified menu from the pool
  405. </summary>
  406. <param name="menu"></param>
  407. </member>
  408. <member name="M:RAGENativeUI.MenuPool.AddSubMenu(RAGENativeUI.UIMenu,System.String)">
  409. <summary>
  410. Create and add a submenu to the menu pool.
  411. Adds an item with the given text to the menu, creates a corresponding submenu, and binds the submenu to the item.
  412. The submenu inherits its title from the menu, and its subtitle from the item text.
  413. </summary>
  414. <param name="menu">The parent menu to which the submenu must be added.</param>
  415. <param name="text">The name of the submenu.</param>
  416. <returns>The newly created submenu.</returns>
  417. </member>
  418. <member name="M:RAGENativeUI.MenuPool.RefreshIndex">
  419. <summary>
  420. Refresh index of every menu in the pool.
  421. Use this after you have finished constructing the entire menu pool.
  422. </summary>
  423. </member>
  424. <member name="M:RAGENativeUI.MenuPool.ToList">
  425. <summary>
  426. Returns all of your menus.
  427. </summary>
  428. <returns></returns>
  429. </member>
  430. <member name="M:RAGENativeUI.MenuPool.ProcessControl">
  431. <summary>
  432. Processes all of your visible menus' controls.
  433. </summary>
  434. </member>
  435. <member name="M:RAGENativeUI.MenuPool.ProcessKey(System.Windows.Forms.Keys)">
  436. <summary>
  437. Processes all of your visible menus' keys.
  438. </summary>
  439. <param name="key"></param>
  440. </member>
  441. <member name="M:RAGENativeUI.MenuPool.ProcessMouse">
  442. <summary>
  443. Processes all of your visible menus' mouses.
  444. </summary>
  445. </member>
  446. <member name="M:RAGENativeUI.MenuPool.Draw">
  447. <summary>
  448. Draws all visible menus.
  449. </summary>
  450. </member>
  451. <member name="M:RAGENativeUI.MenuPool.IsAnyMenuOpen">
  452. <summary>
  453. Checks if any menu is currently visible.
  454. </summary>
  455. <returns>true if at least one menu is visible, false if not.</returns>
  456. </member>
  457. <member name="M:RAGENativeUI.MenuPool.ProcessMenus">
  458. <summary>
  459. Process all of your menus' functions. Call this in a tick event.
  460. </summary>
  461. </member>
  462. <member name="M:RAGENativeUI.MenuPool.DrawBanners(Rage.GraphicsEventArgs)">
  463. <summary>
  464. Draw all of your menus' custom banners.
  465. </summary>
  466. <param name="canvas">Canvas to draw on.</param>
  467. </member>
  468. <member name="M:RAGENativeUI.MenuPool.CloseAllMenus">
  469. <summary>
  470. Closes all of your menus.
  471. </summary>
  472. </member>
  473. <member name="M:RAGENativeUI.MenuPool.ResetMenus(System.Boolean,System.Boolean)">
  474. <summary>
  475. Sets the index of all lists to 0 and unchecks all the checkboxes from your menus.
  476. </summary>
  477. <param name="resetLists">If true the index of all lists will be set to 0.</param>
  478. <param name="resetCheckboxes">If true all the checkboxes will be unchecked.</param>
  479. </member>
  480. <member name="M:RAGENativeUI.PauseMenu.MissionLogo.#ctor(System.String,System.String)">
  481. <summary>
  482. Create a mission logo from a game texture.
  483. </summary>
  484. <param name="textureDict">Name of the texture dictionary</param>
  485. <param name="textureName">Name of the texture.</param>
  486. </member>
  487. <member name="M:RAGENativeUI.StringMeasurer.MeasureString(System.String)">
  488. <summary>
  489. Measures width of a 0.35 scale string.
  490. </summary>
  491. <param name="input"></param>
  492. <returns></returns>
  493. </member>
  494. <member name="T:RAGENativeUI.UIMenu">
  495. <summary>
  496. Base class for RAGENativeUI. Calls the next events: OnIndexChange, OnListChanged, OnCheckboxChange, OnItemSelect, OnMenuClose, OnMenuchange.
  497. </summary>
  498. </member>
  499. <member name="E:RAGENativeUI.UIMenu.OnIndexChange">
  500. <summary>
  501. Called when user presses up or down, changing current selection.
  502. </summary>
  503. </member>
  504. <member name="E:RAGENativeUI.UIMenu.OnListChange">
  505. <summary>
  506. Called when user presses left or right, changing a list position.
  507. </summary>
  508. </member>
  509. <member name="E:RAGENativeUI.UIMenu.OnCheckboxChange">
  510. <summary>
  511. Called when user presses enter on a checkbox item.
  512. </summary>
  513. </member>
  514. <member name="E:RAGENativeUI.UIMenu.OnItemSelect">
  515. <summary>
  516. Called when user selects a simple item.
  517. </summary>
  518. </member>
  519. <member name="E:RAGENativeUI.UIMenu.OnMenuClose">
  520. <summary>
  521. Called when user closes the menu or goes back in a menu chain.
  522. </summary>
  523. </member>
  524. <member name="E:RAGENativeUI.UIMenu.OnMenuChange">
  525. <summary>
  526. Called when user either clicks on a binded button or goes back to a parent menu.
  527. </summary>
  528. </member>
  529. <member name="M:RAGENativeUI.UIMenu.#ctor(System.String,System.String)">
  530. <summary>
  531. Basic Menu constructor.
  532. </summary>
  533. <param name="title">Title that appears on the big banner.</param>
  534. <param name="subtitle">Subtitle that appears in capital letters in a small black bar.</param>
  535. </member>
  536. <member name="M:RAGENativeUI.UIMenu.#ctor(System.String,System.String,System.Drawing.Point)">
  537. <summary>
  538. Basic Menu constructor with an offset.
  539. </summary>
  540. <param name="title">Title that appears on the big banner.</param>
  541. <param name="subtitle">Subtitle that appears in capital letters in a small black bar. Set to "" if you dont want a subtitle.</param>
  542. <param name="offset">Point object with X and Y data for offsets. Applied to all menu elements.</param>
  543. </member>
  544. <member name="M:RAGENativeUI.UIMenu.#ctor(System.String,System.String,System.Drawing.Point,Rage.Texture)">
  545. <summary>
  546. Initialise a menu with a custom texture banner.
  547. </summary>
  548. <param name="title">Title that appears on the big banner. Set to "" if you don't want a title.</param>
  549. <param name="subtitle">Subtitle that appears in capital letters in a small black bar. Set to "" if you dont want a subtitle.</param>
  550. <param name="offset">Point object with X and Y data for offsets. Applied to all menu elements.</param>
  551. <param name="customBanner">Your custom Rage.Texture.</param>
  552. </member>
  553. <member name="M:RAGENativeUI.UIMenu.#ctor(System.String,System.String,System.Drawing.Point,System.String,System.String)">
  554. <summary>
  555. Advanced Menu constructor that allows custom title banner.
  556. </summary>
  557. <param name="title">Title that appears on the big banner. Set to "" if you are using a custom banner.</param>
  558. <param name="subtitle">Subtitle that appears in capital letters in a small black bar.</param>
  559. <param name="offset">Point object with X and Y data for offsets. Applied to all menu elements.</param>
  560. <param name="spriteLibrary">Sprite library name for the banner.</param>
  561. <param name="spriteName">Sprite name for the banner.</param>
  562. </member>
  563. <member name="P:RAGENativeUI.UIMenu.WidthOffset">
  564. <summary>
  565. Returns the current width offset.
  566. </summary>
  567. </member>
  568. <member name="M:RAGENativeUI.UIMenu.SetMenuWidthOffset(System.Int32)">
  569. <summary>
  570. Change the menu's width. The width is calculated as DefaultWidth + WidthOffset, so a width offset of 10 would enlarge the menu by 10 pixels.
  571. </summary>
  572. <param name="widthOffset">New width offset.</param>
  573. </member>
  574. <member name="M:RAGENativeUI.UIMenu.DisEnableControls(System.Boolean)">
  575. <summary>
  576. Enable or disable all controls but the necessary to operate a menu.
  577. </summary>
  578. <param name="enable"></param>
  579. </member>
  580. <member name="M:RAGENativeUI.UIMenu.DisableInstructionalButtons(System.Boolean)">
  581. <summary>
  582. Enable or disable the instructional buttons.
  583. </summary>
  584. <param name="disable"></param>
  585. </member>
  586. <member name="M:RAGENativeUI.UIMenu.SetBannerType(RAGENativeUI.Elements.Sprite)">
  587. <summary>
  588. Set the banner to your own Sprite object.
  589. </summary>
  590. <param name="spriteBanner">Sprite object. The position and size does not matter.</param>
  591. </member>
  592. <member name="M:RAGENativeUI.UIMenu.SetBannerType(RAGENativeUI.Elements.ResRectangle)">
  593. <summary>
  594. Set the banner to your own Rectangle.
  595. </summary>
  596. <param name="rectangle">UIResRectangle object. Position and size does not matter.</param>
  597. </member>
  598. <member name="M:RAGENativeUI.UIMenu.SetBannerType(Rage.Texture)">
  599. <summary>
  600. Set the banner to your own custom texture. Set it to null if you want to restore the banner.
  601. </summary>
  602. <param name="texture">Rage.Texture object</param>
  603. </member>
  604. <member name="M:RAGENativeUI.UIMenu.AddItem(RAGENativeUI.Elements.UIMenuItem)">
  605. <summary>
  606. Add an item to the menu.
  607. </summary>
  608. <param name="item">Item object to be added. Can be normal item, checkbox or list item.</param>
  609. </member>
  610. <member name="M:RAGENativeUI.UIMenu.RemoveItemAt(System.Int32)">
  611. <summary>
  612. Remove an item at index n.
  613. </summary>
  614. <param name="index">Index to remove the item at.</param>
  615. </member>
  616. <member name="M:RAGENativeUI.UIMenu.RefreshIndex">
  617. <summary>
  618. Reset the current selected item to 0. Use this after you add or remove items dynamically.
  619. </summary>
  620. </member>
  621. <member name="M:RAGENativeUI.UIMenu.Clear">
  622. <summary>
  623. Remove all items from the menu.
  624. </summary>
  625. </member>
  626. <member name="M:RAGENativeUI.UIMenu.DrawBanner(Rage.GraphicsEventArgs)">
  627. <summary>
  628. Draw your custom banner.
  629. </summary>
  630. <param name="e">Rage.GraphicsEventArgs to draw on.</param>
  631. </member>
  632. <member name="M:RAGENativeUI.UIMenu.Draw">
  633. <summary>
  634. Draw the menu and all of it's components.
  635. </summary>
  636. </member>
  637. <member name="M:RAGENativeUI.UIMenu.GetScreenResolutionMantainRatio">
  638. <summary>
  639. Returns the 1080pixels-based screen resolution while mantaining current aspect ratio.
  640. </summary>
  641. <returns></returns>
  642. </member>
  643. <member name="M:RAGENativeUI.UIMenu.IsMouseInBounds(System.Drawing.Point,System.Drawing.Size)">
  644. <summary>
  645. Chech whether the mouse is inside the specified rectangle.
  646. </summary>
  647. <param name="topLeft">top left point of your rectangle.</param>
  648. <param name="boxSize">size of your rectangle.</param>
  649. <returns></returns>
  650. </member>
  651. <member name="M:RAGENativeUI.UIMenu.IsMouseInListItemArrows(RAGENativeUI.Elements.UIMenuListItem,System.Drawing.Point,System.Drawing.Point)">
  652. <summary>
  653. Function to get whether the cursor is in an arrow space, or in label of an MenuListItem.
  654. </summary>
  655. <param name="item">What item to check</param>
  656. <param name="topLeft">top left point of the item.</param>
  657. <param name="safezone">safezone size.</param>
  658. <returns>0 - Not in item at all, 1 - In label, 2 - In arrow space.</returns>
  659. </member>
  660. <member name="M:RAGENativeUI.UIMenu.GetSafezoneBounds">
  661. <summary>
  662. Returns the safezone bounds in pixel, relative to the 1080pixel based system.
  663. </summary>
  664. <returns></returns>
  665. </member>
  666. <member name="M:RAGENativeUI.UIMenu.GoUpOverflow">
  667. <summary>
  668. Go up the menu if the number of items is more than maximum items on screen.
  669. </summary>
  670. </member>
  671. <member name="M:RAGENativeUI.UIMenu.GoUp">
  672. <summary>
  673. Go up the menu if the number of items is less than or equal to the maximum items on screen.
  674. </summary>
  675. </member>
  676. <member name="M:RAGENativeUI.UIMenu.GoDownOverflow">
  677. <summary>
  678. Go down the menu if the number of items is more than maximum items on screen.
  679. </summary>
  680. </member>
  681. <member name="M:RAGENativeUI.UIMenu.GoDown">
  682. <summary>
  683. Go up the menu if the number of items is less than or equal to the maximum items on screen.
  684. </summary>
  685. </member>
  686. <member name="M:RAGENativeUI.UIMenu.GoLeft">
  687. <summary>
  688. Go left on a MenuListItem.
  689. </summary>
  690. </member>
  691. <member name="M:RAGENativeUI.UIMenu.GoRight">
  692. <summary>
  693. Go right on a MenuListItem.
  694. </summary>
  695. </member>
  696. <member name="M:RAGENativeUI.UIMenu.SelectItem">
  697. <summary>
  698. Activate the current selected item.
  699. </summary>
  700. </member>
  701. <member name="M:RAGENativeUI.UIMenu.GoBack">
  702. <summary>
  703. Close or go back in a menu chain.
  704. </summary>
  705. </member>
  706. <member name="M:RAGENativeUI.UIMenu.BindMenuToItem(RAGENativeUI.UIMenu,RAGENativeUI.Elements.UIMenuItem)">
  707. <summary>
  708. Bind a menu to a button. When the button is clicked that menu will open.
  709. </summary>
  710. </member>
  711. <member name="M:RAGENativeUI.UIMenu.ReleaseMenuFromItem(RAGENativeUI.Elements.UIMenuItem)">
  712. <summary>
  713. Remove menu binding from button.
  714. </summary>
  715. <param name="releaseFrom">Button to release from.</param>
  716. <returns>Returns true if the operation was successful.</returns>
  717. </member>
  718. <member name="M:RAGENativeUI.UIMenu.ProcessMouse">
  719. <summary>
  720. Process the mouse's position and check if it's hovering over any Element. Call this in Game.FrameRender or in a loop.
  721. </summary>
  722. </member>
  723. <member name="M:RAGENativeUI.UIMenu.SetKey(RAGENativeUI.Common.MenuControls,System.Windows.Forms.Keys)">
  724. <summary>
  725. Set a key to control a menu. Can be multiple keys for each control.
  726. </summary>
  727. <param name="control"></param>
  728. <param name="keyToSet"></param>
  729. </member>
  730. <member name="M:RAGENativeUI.UIMenu.SetKey(RAGENativeUI.Common.MenuControls,Rage.GameControl)">
  731. <summary>
  732. Set a Rage.GameControl to control a menu. Can be multiple controls. This applies it to all indexes.
  733. </summary>
  734. <param name="control"></param>
  735. <param name="gtaControl"></param>
  736. </member>
  737. <member name="M:RAGENativeUI.UIMenu.SetKey(RAGENativeUI.Common.MenuControls,Rage.GameControl,System.Int32)">
  738. <summary>
  739. Set a Rage.GameControl to control a menu only on a specific index.
  740. </summary>
  741. <param name="control"></param>
  742. <param name="gtaControl"></param>
  743. <param name="controlIndex"></param>
  744. </member>
  745. <member name="M:RAGENativeUI.UIMenu.ResetKey(RAGENativeUI.Common.MenuControls)">
  746. <summary>
  747. Remove all controls on a control.
  748. </summary>
  749. <param name="control"></param>
  750. </member>
  751. <member name="M:RAGENativeUI.UIMenu.HasControlJustBeenPressed(RAGENativeUI.Common.MenuControls,System.Windows.Forms.Keys)">
  752. <summary>
  753. Check whether a menucontrol has been pressed.
  754. </summary>
  755. <param name="control">Control to check for.</param>
  756. <param name="key">Key if you're using keys.</param>
  757. <returns></returns>
  758. </member>
  759. <member name="M:RAGENativeUI.UIMenu.HasControlJustBeenReleaseed(RAGENativeUI.Common.MenuControls,System.Windows.Forms.Keys)">
  760. <summary>
  761. Check whether a menucontrol has been released.
  762. </summary>
  763. <param name="control">Control to check for.</param>
  764. <param name="key">Key if you're using keys.</param>
  765. <returns></returns>
  766. </member>
  767. <member name="M:RAGENativeUI.UIMenu.IsControlBeingPressed(RAGENativeUI.Common.MenuControls,System.Windows.Forms.Keys)">
  768. <summary>
  769. Check whether a menucontrol is being pressed.
  770. </summary>
  771. <param name="control"></param>
  772. <param name="key"></param>
  773. <returns></returns>
  774. </member>
  775. <member name="M:RAGENativeUI.UIMenu.ProcessControl(System.Windows.Forms.Keys)">
  776. <summary>
  777. Process control-stroke. Call this in the Game.FrameRender event or in a loop.
  778. </summary>
  779. </member>
  780. <member name="M:RAGENativeUI.UIMenu.ProcessKey(System.Windows.Forms.Keys)">
  781. <summary>
  782. Process keystroke. Call this in the Game.FrameRender event or in a loop.
  783. </summary>
  784. </member>
  785. <member name="M:RAGENativeUI.UIMenu.FormatDescription(System.String)">
  786. <summary>
  787. Formats the input string so it doesn't go out of bounds of the description box.
  788. </summary>
  789. <param name="input">String to format.</param>
  790. <returns></returns>
  791. </member>
  792. <member name="M:RAGENativeUI.UIMenu.UpdateScaleform">
  793. <summary>
  794. Manually update the instructional buttons scaleform.
  795. </summary>
  796. </member>
  797. <member name="M:RAGENativeUI.UIMenu.Reset(System.Boolean,System.Boolean)">
  798. <summary>
  799. Sets the index of all lists to 0 and unchecks all the checkboxes.
  800. </summary>
  801. <param name="resetLists">If true the index of all lists will be set to 0.</param>
  802. <param name="resetCheckboxes">If true all the checkboxes will be unchecked.</param>
  803. </member>
  804. <member name="P:RAGENativeUI.UIMenu.Visible">
  805. <summary>
  806. Change whether this menu is visible to the user.
  807. </summary>
  808. </member>
  809. <member name="P:RAGENativeUI.UIMenu.CurrentSelection">
  810. <summary>
  811. Returns the current selected item's index.
  812. Change the current selected item to index. Use this after you add or remove items dynamically.
  813. </summary>
  814. </member>
  815. <member name="P:RAGENativeUI.UIMenu.IsUsingController">
  816. <summary>
  817. Returns false if last input was made with mouse and keyboard, true if it was made with a controller.
  818. </summary>
  819. </member>
  820. <member name="P:RAGENativeUI.UIMenu.Title">
  821. <summary>
  822. Returns the title object.
  823. </summary>
  824. </member>
  825. <member name="P:RAGENativeUI.UIMenu.Subtitle">
  826. <summary>
  827. Returns the subtitle object.
  828. </summary>
  829. </member>
  830. <member name="P:RAGENativeUI.UIMenu.CounterPretext">
  831. <summary>
  832. String to pre-attach to the counter string. Useful for color codes.
  833. </summary>
  834. </member>
  835. <member name="P:RAGENativeUI.UIMenu.ParentMenu">
  836. <summary>
  837. If this is a nested menu, returns the parent menu. You can also set it to a menu so when pressing Back it goes to that menu.
  838. </summary>
  839. </member>
  840. <member name="P:RAGENativeUI.UIMenu.ParentItem">
  841. <summary>
  842. If this is a nested menu, returns the item it was binded to.
  843. </summary>
  844. </member>
  845. </members>
  846. </doc>
Advertisement
Add Comment
Please, Sign In to add comment