DOTween46.xml 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DOTween46</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DG.Tweening.DOTweenUtils46">
  8. <summary>
  9. Various utils that require Unity 4.6 or later
  10. </summary>
  11. </member>
  12. <member name="M:DG.Tweening.DOTweenUtils46.SwitchToRectTransform(UnityEngine.RectTransform,UnityEngine.RectTransform)">
  13. <summary>
  14. Converts the anchoredPosition of the first RectTransform to the second RectTransform,
  15. taking into consideration offset, anchors and pivot, and returns the new anchoredPosition
  16. </summary>
  17. </member>
  18. <member name="T:DG.Tweening.ShortcutExtensions46">
  19. <summary>
  20. Methods that extend known Unity objects and allow to directly create and control tweens from their instances.
  21. These, as all DOTween46 methods, require Unity 4.6 or later.
  22. </summary>
  23. </member>
  24. <member name="M:DG.Tweening.ShortcutExtensions46.DOFade(UnityEngine.CanvasGroup,System.Single,System.Single)">
  25. <summary>Tweens a CanvasGroup's alpha color to the given value.
  26. Also stores the canvasGroup as the tween's target so it can be used for filtered operations</summary>
  27. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  28. </member>
  29. <member name="M:DG.Tweening.ShortcutExtensions46.DOColor(UnityEngine.UI.Graphic,UnityEngine.Color,System.Single)">
  30. <summary>Tweens an Graphic's color to the given value.
  31. Also stores the image as the tween's target so it can be used for filtered operations</summary>
  32. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  33. </member>
  34. <member name="M:DG.Tweening.ShortcutExtensions46.DOFade(UnityEngine.UI.Graphic,System.Single,System.Single)">
  35. <summary>Tweens an Graphic's alpha color to the given value.
  36. Also stores the image as the tween's target so it can be used for filtered operations</summary>
  37. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  38. </member>
  39. <member name="M:DG.Tweening.ShortcutExtensions46.DOColor(UnityEngine.UI.Image,UnityEngine.Color,System.Single)">
  40. <summary>Tweens an Image's color to the given value.
  41. Also stores the image as the tween's target so it can be used for filtered operations</summary>
  42. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  43. </member>
  44. <member name="M:DG.Tweening.ShortcutExtensions46.DOFade(UnityEngine.UI.Image,System.Single,System.Single)">
  45. <summary>Tweens an Image's alpha color to the given value.
  46. Also stores the image as the tween's target so it can be used for filtered operations</summary>
  47. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  48. </member>
  49. <member name="M:DG.Tweening.ShortcutExtensions46.DOFillAmount(UnityEngine.UI.Image,System.Single,System.Single)">
  50. <summary>Tweens an Image's fillAmount to the given value.
  51. Also stores the image as the tween's target so it can be used for filtered operations</summary>
  52. <param name="endValue">The end value to reach (0 to 1)</param><param name="duration">The duration of the tween</param>
  53. </member>
  54. <member name="M:DG.Tweening.ShortcutExtensions46.DOGradientColor(UnityEngine.UI.Image,UnityEngine.Gradient,System.Single)">
  55. <summary>Tweens an Image's colors using the given gradient
  56. (NOTE 1: only uses the colors of the gradient, not the alphas - NOTE 2: creates a Sequence, not a Tweener).
  57. Also stores the image as the tween's target so it can be used for filtered operations</summary>
  58. <param name="gradient">The gradient to use</param><param name="duration">The duration of the tween</param>
  59. </member>
  60. <member name="M:DG.Tweening.ShortcutExtensions46.DOFlexibleSize(UnityEngine.UI.LayoutElement,UnityEngine.Vector2,System.Single,System.Boolean)">
  61. <summary>Tweens an LayoutElement's flexibleWidth/Height to the given value.
  62. Also stores the LayoutElement as the tween's target so it can be used for filtered operations</summary>
  63. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  64. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  65. </member>
  66. <member name="M:DG.Tweening.ShortcutExtensions46.DOMinSize(UnityEngine.UI.LayoutElement,UnityEngine.Vector2,System.Single,System.Boolean)">
  67. <summary>Tweens an LayoutElement's minWidth/Height to the given value.
  68. Also stores the LayoutElement as the tween's target so it can be used for filtered operations</summary>
  69. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  70. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  71. </member>
  72. <member name="M:DG.Tweening.ShortcutExtensions46.DOPreferredSize(UnityEngine.UI.LayoutElement,UnityEngine.Vector2,System.Single,System.Boolean)">
  73. <summary>Tweens an LayoutElement's preferredWidth/Height to the given value.
  74. Also stores the LayoutElement as the tween's target so it can be used for filtered operations</summary>
  75. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  76. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  77. </member>
  78. <member name="M:DG.Tweening.ShortcutExtensions46.DOColor(UnityEngine.UI.Outline,UnityEngine.Color,System.Single)">
  79. <summary>Tweens a Outline's effectColor to the given value.
  80. Also stores the Outline as the tween's target so it can be used for filtered operations</summary>
  81. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  82. </member>
  83. <member name="M:DG.Tweening.ShortcutExtensions46.DOFade(UnityEngine.UI.Outline,System.Single,System.Single)">
  84. <summary>Tweens a Outline's effectColor alpha to the given value.
  85. Also stores the Outline as the tween's target so it can be used for filtered operations</summary>
  86. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  87. </member>
  88. <member name="M:DG.Tweening.ShortcutExtensions46.DOScale(UnityEngine.UI.Outline,UnityEngine.Vector2,System.Single)">
  89. <summary>Tweens a Outline's effectDistance to the given value.
  90. Also stores the Outline as the tween's target so it can be used for filtered operations</summary>
  91. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  92. </member>
  93. <member name="M:DG.Tweening.ShortcutExtensions46.DOAnchorPos(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single,System.Boolean)">
  94. <summary>Tweens a RectTransform's anchoredPosition to the given value.
  95. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  96. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  97. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  98. </member>
  99. <member name="M:DG.Tweening.ShortcutExtensions46.DOAnchorPosX(UnityEngine.RectTransform,System.Single,System.Single,System.Boolean)">
  100. <summary>Tweens a RectTransform's anchoredPosition X to the given value.
  101. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  102. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  103. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  104. </member>
  105. <member name="M:DG.Tweening.ShortcutExtensions46.DOAnchorPosY(UnityEngine.RectTransform,System.Single,System.Single,System.Boolean)">
  106. <summary>Tweens a RectTransform's anchoredPosition Y to the given value.
  107. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  108. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  109. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  110. </member>
  111. <member name="M:DG.Tweening.ShortcutExtensions46.DOAnchorPos3D(UnityEngine.RectTransform,UnityEngine.Vector3,System.Single,System.Boolean)">
  112. <summary>Tweens a RectTransform's anchoredPosition3D to the given value.
  113. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  114. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  115. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  116. </member>
  117. <member name="M:DG.Tweening.ShortcutExtensions46.DOAnchorMax(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single,System.Boolean)">
  118. <summary>Tweens a RectTransform's anchorMax to the given value.
  119. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  120. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  121. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  122. </member>
  123. <member name="M:DG.Tweening.ShortcutExtensions46.DOAnchorMin(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single,System.Boolean)">
  124. <summary>Tweens a RectTransform's anchorMin to the given value.
  125. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  126. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  127. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  128. </member>
  129. <member name="M:DG.Tweening.ShortcutExtensions46.DOPivot(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single)">
  130. <summary>Tweens a RectTransform's pivot to the given value.
  131. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  132. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  133. </member>
  134. <member name="M:DG.Tweening.ShortcutExtensions46.DOPivotX(UnityEngine.RectTransform,System.Single,System.Single)">
  135. <summary>Tweens a RectTransform's pivot X to the given value.
  136. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  137. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  138. </member>
  139. <member name="M:DG.Tweening.ShortcutExtensions46.DOPivotY(UnityEngine.RectTransform,System.Single,System.Single)">
  140. <summary>Tweens a RectTransform's pivot Y to the given value.
  141. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  142. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  143. </member>
  144. <member name="M:DG.Tweening.ShortcutExtensions46.DOSizeDelta(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single,System.Boolean)">
  145. <summary>Tweens a RectTransform's sizeDelta to the given value.
  146. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  147. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  148. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  149. </member>
  150. <member name="M:DG.Tweening.ShortcutExtensions46.DOPunchAnchorPos(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Boolean)">
  151. <summary>Punches a RectTransform's anchoredPosition towards the given direction and then back to the starting one
  152. as if it was connected to the starting position via an elastic.
  153. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  154. <param name="punch">The direction and strength of the punch (added to the RectTransform's current position)</param>
  155. <param name="duration">The duration of the tween</param>
  156. <param name="vibrato">Indicates how much will the punch vibrate</param>
  157. <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards.
  158. 1 creates a full oscillation between the punch direction and the opposite direction,
  159. while 0 oscillates only between the punch and the start position</param>
  160. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  161. </member>
  162. <member name="M:DG.Tweening.ShortcutExtensions46.DOShakeAnchorPos(UnityEngine.RectTransform,System.Single,System.Single,System.Int32,System.Single,System.Boolean,System.Boolean)">
  163. <summary>Shakes a RectTransform's anchoredPosition with the given values.
  164. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  165. <param name="duration">The duration of the tween</param>
  166. <param name="strength">The shake strength</param>
  167. <param name="vibrato">Indicates how much will the shake vibrate</param>
  168. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  169. Setting it to 0 will shake along a single direction.</param>
  170. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  171. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  172. </member>
  173. <member name="M:DG.Tweening.ShortcutExtensions46.DOShakeAnchorPos(UnityEngine.RectTransform,System.Single,UnityEngine.Vector2,System.Int32,System.Single,System.Boolean,System.Boolean)">
  174. <summary>Shakes a RectTransform's anchoredPosition with the given values.
  175. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  176. <param name="duration">The duration of the tween</param>
  177. <param name="strength">The shake strength on each axis</param>
  178. <param name="vibrato">Indicates how much will the shake vibrate</param>
  179. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  180. Setting it to 0 will shake along a single direction.</param>
  181. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  182. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  183. </member>
  184. <member name="M:DG.Tweening.ShortcutExtensions46.DOJumpAnchorPos(UnityEngine.RectTransform,UnityEngine.Vector2,System.Single,System.Int32,System.Single,System.Boolean)">
  185. <summary>Tweens a RectTransform's anchoredPosition to the given value, while also applying a jump effect along the Y axis.
  186. Returns a Sequence instead of a Tweener.
  187. Also stores the RectTransform as the tween's target so it can be used for filtered operations</summary>
  188. <param name="endValue">The end value to reach</param>
  189. <param name="jumpPower">Power of the jump (the max height of the jump is represented by this plus the final Y offset)</param>
  190. <param name="numJumps">Total number of jumps</param>
  191. <param name="duration">The duration of the tween</param>
  192. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  193. </member>
  194. <member name="M:DG.Tweening.ShortcutExtensions46.DONormalizedPos(UnityEngine.UI.ScrollRect,UnityEngine.Vector2,System.Single,System.Boolean)">
  195. <summary>Tweens a ScrollRect's horizontal/verticalNormalizedPosition to the given value.
  196. Also stores the ScrollRect as the tween's target so it can be used for filtered operations</summary>
  197. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  198. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  199. </member>
  200. <member name="M:DG.Tweening.ShortcutExtensions46.DOHorizontalNormalizedPos(UnityEngine.UI.ScrollRect,System.Single,System.Single,System.Boolean)">
  201. <summary>Tweens a ScrollRect's horizontalNormalizedPosition to the given value.
  202. Also stores the ScrollRect as the tween's target so it can be used for filtered operations</summary>
  203. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  204. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  205. </member>
  206. <member name="M:DG.Tweening.ShortcutExtensions46.DOVerticalNormalizedPos(UnityEngine.UI.ScrollRect,System.Single,System.Single,System.Boolean)">
  207. <summary>Tweens a ScrollRect's verticalNormalizedPosition to the given value.
  208. Also stores the ScrollRect as the tween's target so it can be used for filtered operations</summary>
  209. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  210. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  211. </member>
  212. <member name="M:DG.Tweening.ShortcutExtensions46.DOValue(UnityEngine.UI.Slider,System.Single,System.Single,System.Boolean)">
  213. <summary>Tweens a Slider's value to the given value.
  214. Also stores the Slider as the tween's target so it can be used for filtered operations</summary>
  215. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  216. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  217. </member>
  218. <member name="M:DG.Tweening.ShortcutExtensions46.DOColor(UnityEngine.UI.Text,UnityEngine.Color,System.Single)">
  219. <summary>Tweens a Text's color to the given value.
  220. Also stores the Text as the tween's target so it can be used for filtered operations</summary>
  221. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  222. </member>
  223. <member name="M:DG.Tweening.ShortcutExtensions46.DOFade(UnityEngine.UI.Text,System.Single,System.Single)">
  224. <summary>Tweens a Text's alpha color to the given value.
  225. Also stores the Text as the tween's target so it can be used for filtered operations</summary>
  226. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  227. </member>
  228. <member name="M:DG.Tweening.ShortcutExtensions46.DOText(UnityEngine.UI.Text,System.String,System.Single,System.Boolean,DG.Tweening.ScrambleMode,System.String)">
  229. <summary>Tweens a Text's text to the given value.
  230. Also stores the Text as the tween's target so it can be used for filtered operations</summary>
  231. <param name="endValue">The end string to tween to</param><param name="duration">The duration of the tween</param>
  232. <param name="richTextEnabled">If TRUE (default), rich text will be interpreted correctly while animated,
  233. otherwise all tags will be considered as normal text</param>
  234. <param name="scrambleMode">The type of scramble mode to use, if any</param>
  235. <param name="scrambleChars">A string containing the characters to use for scrambling.
  236. Use as many characters as possible (minimum 10) because DOTween uses a fast scramble mode which gives better results with more characters.
  237. Leave it to NULL (default) to use default ones</param>
  238. </member>
  239. <member name="M:DG.Tweening.ShortcutExtensions46.DOBlendableColor(UnityEngine.UI.Graphic,UnityEngine.Color,System.Single)">
  240. <summary>Tweens a Graphic's color to the given value,
  241. in a way that allows other DOBlendableColor tweens to work together on the same target,
  242. instead than fight each other as multiple DOColor would do.
  243. Also stores the Graphic as the tween's target so it can be used for filtered operations</summary>
  244. <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
  245. </member>
  246. <member name="M:DG.Tweening.ShortcutExtensions46.DOBlendableColor(UnityEngine.UI.Image,UnityEngine.Color,System.Single)">
  247. <summary>Tweens a Image's color to the given value,
  248. in a way that allows other DOBlendableColor tweens to work together on the same target,
  249. instead than fight each other as multiple DOColor would do.
  250. Also stores the Image as the tween's target so it can be used for filtered operations</summary>
  251. <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
  252. </member>
  253. <member name="M:DG.Tweening.ShortcutExtensions46.DOBlendableColor(UnityEngine.UI.Text,UnityEngine.Color,System.Single)">
  254. <summary>Tweens a Text's color BY the given value,
  255. in a way that allows other DOBlendableColor tweens to work together on the same target,
  256. instead than fight each other as multiple DOColor would do.
  257. Also stores the Text as the tween's target so it can be used for filtered operations</summary>
  258. <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
  259. </member>
  260. </members>
  261. </doc>