DemiLib.xml 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DemiLib</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DG.DemiLib.Attributes.DeScriptExecutionOrderAttribute">
  8. <summary>
  9. <code>Class attribute</code><para/>
  10. Sets the script execution order index
  11. </summary>
  12. </member>
  13. <member name="M:DG.DemiLib.Attributes.DeScriptExecutionOrderAttribute.#ctor(System.Int32)">
  14. <summary>
  15. Sets the script execution order for this class
  16. </summary>
  17. <param name="order">Script execution order index</param>
  18. </member>
  19. <member name="F:DG.DemiLib.Core.GUIUtils.isProSkin">
  20. <summary>
  21. Set when calling <code>DeGUI.BeginGUI</code>
  22. </summary>
  23. </member>
  24. <member name="T:DG.DemiLib.DeColorPalette">
  25. <summary>
  26. Stores a color palette, which can be passed to default DeGUI layouts when calling <code>DeGUI.BeginGUI</code>,
  27. and changed at any time by calling <code>DeGUI.ChangePalette</code>.
  28. You can inherit from this class to create custom color palettes with more hColor options.
  29. </summary>
  30. </member>
  31. <member name="M:DG.DemiLib.DeColorPalette.HexToColor(System.String)">
  32. <summary>
  33. Converts a HEX color to a Unity Color and returns it
  34. </summary>
  35. <param name="hex">The HEX color, either with or without the initial # (accepts both regular and short format)</param>
  36. </member>
  37. <member name="T:DG.DemiLib.DeColorGlobal">
  38. <summary>
  39. Global colors
  40. </summary>
  41. </member>
  42. <member name="T:DG.DemiLib.DeColorBG">
  43. <summary>
  44. Background colors
  45. </summary>
  46. </member>
  47. <member name="F:DG.DemiLib.DeColorBG.editor">
  48. <summary>Editor background color</summary>
  49. </member>
  50. <member name="T:DG.DemiLib.DeColorContent">
  51. <summary>
  52. Content colors
  53. </summary>
  54. </member>
  55. <member name="T:DG.DemiLib.DeToggleColors">
  56. <summary>
  57. Toggle button specific colors
  58. </summary>
  59. </member>
  60. <member name="T:DG.DemiLib.DeInputUtils">
  61. <summary>
  62. Various Input utils
  63. </summary>
  64. </member>
  65. <member name="M:DG.DemiLib.DeInputUtils.IsNumKeyDown">
  66. <summary>
  67. Returns a number key int if a number key was pressed in this frame, or -1 otherwise
  68. </summary>
  69. <returns></returns>
  70. </member>
  71. <member name="T:DG.DemiLib.DeScope">
  72. <summary>
  73. Extend this to replicate Unity's Scope system with any Unity version.
  74. Thanks to Dmitriy Yukhanov for pointing this out and creating an initial version.
  75. Expand this class to create scopes.<para/>
  76. Example:
  77. <code>public class VBoxScope : DeScope
  78. {
  79. public VBoxScope(GUIStyle style)
  80. {
  81. BeginVBox(style);
  82. }
  83. protected override void CloseScope()
  84. {
  85. EndVBox();
  86. }
  87. }</code>
  88. Usage:
  89. <code>using (new VBoxScope(myStyle) {
  90. // Do something
  91. }</code>
  92. </summary>
  93. </member>
  94. <member name="T:DG.DemiLib.DeSkinColor">
  95. <summary>
  96. Contains both free and pro skins color variations,
  97. and automatically returns the correct one when converted to Color
  98. </summary>
  99. </member>
  100. <member name="T:DG.DemiLib.External.DeHierarchyComponent">
  101. <summary>
  102. Used by DeHierarchy
  103. </summary>
  104. </member>
  105. <member name="M:DG.DemiLib.External.DeHierarchyComponent.MissingItemsIndexes">
  106. <summary>
  107. Returns a list of all items whose gameObject is NULL, or NULL if there's no missing gameObjects.
  108. </summary>
  109. </member>
  110. <member name="M:DG.DemiLib.External.DeHierarchyComponent.StoreItemColor(UnityEngine.GameObject,DG.DemiLib.External.DeHierarchyComponent.HColor)">
  111. <summary>
  112. If the item exists sets it, otherwise first creates it and then sets it
  113. </summary>
  114. </member>
  115. <member name="M:DG.DemiLib.External.DeHierarchyComponent.StoreItemIcon(UnityEngine.GameObject,DG.DemiLib.External.DeHierarchyComponent.IcoType)">
  116. <summary>
  117. If the item exists sets it, otherwise first creates it and then sets it
  118. </summary>
  119. </member>
  120. <member name="M:DG.DemiLib.External.DeHierarchyComponent.StoreItemSeparator(UnityEngine.GameObject,System.Nullable{DG.DemiLib.External.DeHierarchyComponent.SeparatorType},System.Nullable{DG.DemiLib.External.DeHierarchyComponent.HColor})">
  121. <summary>
  122. If the item exists sets it, otherwise first creates it and then sets it
  123. </summary>
  124. </member>
  125. <member name="M:DG.DemiLib.External.DeHierarchyComponent.RemoveItemData(UnityEngine.GameObject)">
  126. <summary>
  127. Returns TRUE if the item existed and was removed.
  128. </summary>
  129. </member>
  130. <member name="M:DG.DemiLib.External.DeHierarchyComponent.ResetSeparator(UnityEngine.GameObject)">
  131. <summary>
  132. Returns TRUE if the item existed and was changed.
  133. </summary>
  134. </member>
  135. <member name="M:DG.DemiLib.External.DeHierarchyComponent.GetItem(UnityEngine.GameObject)">
  136. <summary>
  137. Returns the customizedItem for the given gameObject, or NULL if none was found
  138. </summary>
  139. </member>
  140. <member name="M:DG.DemiLib.External.DeHierarchyComponent.GetColor(DG.DemiLib.External.DeHierarchyComponent.HColor)">
  141. <summary>
  142. Returns the color corresponding to the given <see cref="T:DG.DemiLib.External.DeHierarchyComponent.HColor"/>
  143. </summary>
  144. </member>
  145. <member name="P:DG.DemiLib.IEditorGUINode.id">
  146. <summary>Must be univocal</summary>
  147. </member>
  148. <member name="P:DG.DemiLib.IEditorGUINode.guiPosition">
  149. <summary>Node position in editor GUI</summary>
  150. </member>
  151. <member name="P:DG.DemiLib.IEditorGUINode.connectedNodesIds">
  152. <summary>Ids of all forward connected nodes. Length indicates how many forward connections are allowed.
  153. Min length represents available connections from node.</summary>
  154. </member>
  155. <member name="T:DG.DemiLib.IntRange">
  156. <summary>
  157. A serializable struct including a min and a max int value
  158. </summary>
  159. </member>
  160. <member name="F:DG.DemiLib.IntRange.min">
  161. <summary>Min value</summary>
  162. </member>
  163. <member name="F:DG.DemiLib.IntRange.max">
  164. <summary>Max value</summary>
  165. </member>
  166. <member name="M:DG.DemiLib.IntRange.#ctor(System.Int32,System.Int32)">
  167. <summary>
  168. Creates a new Range
  169. </summary>
  170. </member>
  171. <member name="M:DG.DemiLib.IntRange.RandomWithin">
  172. <summary>
  173. Returns a random value within this range (min/max included)
  174. </summary>
  175. </member>
  176. <member name="M:DG.DemiLib.IntRange.ToString">
  177. <inheritdoc />
  178. </member>
  179. <member name="T:DG.DemiLib.Range">
  180. <summary>
  181. A serializable struct including a min and a max float value
  182. </summary>
  183. </member>
  184. <member name="F:DG.DemiLib.Range.min">
  185. <summary>Min value</summary>
  186. </member>
  187. <member name="F:DG.DemiLib.Range.max">
  188. <summary>Max value</summary>
  189. </member>
  190. <member name="M:DG.DemiLib.Range.#ctor(System.Single,System.Single)">
  191. <summary>
  192. Creates a new Range
  193. </summary>
  194. </member>
  195. <member name="M:DG.DemiLib.Range.RandomWithin">
  196. <summary>
  197. Returns a random value within this range (min/max included)
  198. </summary>
  199. </member>
  200. <member name="M:DG.DemiLib.Range.ToString">
  201. <inheritdoc />
  202. </member>
  203. <member name="M:DG.DemiLib.Utils.DeRuntimeUtils.GetOnlyComponentsInChildren``1(UnityEngine.GameObject,System.Boolean)">
  204. <summary>
  205. Returns ONLY the Components in the children, and ignores the parent.
  206. </summary>
  207. <param name="includeInactive">If TRUE also includes inactive children</param>
  208. </member>
  209. <member name="M:DG.DemiLib.Utils.DeRuntimeUtils.GetOnlyComponentInChildren``1(UnityEngine.GameObject,System.Boolean)">
  210. <summary>
  211. Returns the Component only if it's in a child, and ignores the parent.
  212. </summary>
  213. <param name="includeInactive">If TRUE also searches inactive children</param>
  214. </member>
  215. <member name="M:DG.DemiLib.Utils.DeRuntimeUtils.ToHex(UnityEngine.Color32,System.Boolean)">
  216. <summary>
  217. Returns a HEX version of the given Unity Color, without the initial #
  218. </summary>
  219. <param name="includeAlpha">If TRUE, also converts the alpha value and returns a hex of 8 characters,
  220. otherwise doesn't and returns a hex of 6 characters</param>
  221. </member>
  222. <member name="M:DG.DemiLib.Utils.DeRuntimeUtils.ToHex(UnityEngine.Color,System.Boolean)">
  223. <summary>
  224. Returns a HEX version of the given Unity Color, without the initial #
  225. </summary>
  226. <param name="includeAlpha">If TRUE, also converts the alpha value and returns a hex of 8 characters,
  227. otherwise doesn't and returns a hex of 6 characters</param>
  228. </member>
  229. </members>
  230. </doc>