DOTween.XML 184 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DOTween</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DG.Tweening.AutoPlay">
  8. <summary>
  9. Types of autoPlay behaviours
  10. </summary>
  11. </member>
  12. <member name="F:DG.Tweening.AutoPlay.None">
  13. <summary>No tween is automatically played</summary>
  14. </member>
  15. <member name="F:DG.Tweening.AutoPlay.AutoPlaySequences">
  16. <summary>Only Sequences are automatically played</summary>
  17. </member>
  18. <member name="F:DG.Tweening.AutoPlay.AutoPlayTweeners">
  19. <summary>Only Tweeners are automatically played</summary>
  20. </member>
  21. <member name="F:DG.Tweening.AutoPlay.All">
  22. <summary>All tweens are automatically played</summary>
  23. </member>
  24. <member name="T:DG.Tweening.AxisConstraint">
  25. <summary>
  26. What axis to constrain in case of Vector tweens
  27. </summary>
  28. </member>
  29. <member name="F:DG.Tweening.Core.ABSSequentiable.onStart">
  30. <summary>Called the first time the tween is set in a playing state, after any eventual delay</summary>
  31. </member>
  32. <member name="T:DG.Tweening.Core.DOGetter`1">
  33. <summary>
  34. Used in place of <c>System.Func</c>, which is not available in mscorlib.
  35. </summary>
  36. </member>
  37. <member name="T:DG.Tweening.Core.DOSetter`1">
  38. <summary>
  39. Used in place of <c>System.Action</c>.
  40. </summary>
  41. </member>
  42. <member name="T:DG.Tweening.Core.Debugger">
  43. <summary>
  44. Public so it can be used by lose scripts related to DOTween (like DOTweenAnimation)
  45. </summary>
  46. </member>
  47. <member name="T:DG.Tweening.Core.DOTweenComponent">
  48. <summary>
  49. Used to separate DOTween class from the MonoBehaviour instance (in order to use static constructors on DOTween).
  50. Contains all instance-based methods
  51. </summary>
  52. </member>
  53. <member name="F:DG.Tweening.Core.DOTweenComponent.inspectorUpdater">
  54. <summary>Used internally inside Unity Editor, as a trick to update DOTween's inspector at every frame</summary>
  55. </member>
  56. <member name="M:DG.Tweening.Core.DOTweenComponent.SetCapacity(System.Int32,System.Int32)">
  57. <summary>
  58. Directly sets the current max capacity of Tweeners and Sequences
  59. (meaning how many Tweeners and Sequences can be running at the same time),
  60. so that DOTween doesn't need to automatically increase them in case the max is reached
  61. (which might lead to hiccups when that happens).
  62. Sequences capacity must be less or equal to Tweeners capacity
  63. (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's).
  64. Beware: use this method only when there are no tweens running.
  65. </summary>
  66. <param name="tweenersCapacity">Max Tweeners capacity.
  67. Default: 200</param>
  68. <param name="sequencesCapacity">Max Sequences capacity.
  69. Default: 50</param>
  70. </member>
  71. <member name="T:DG.Tweening.Core.Easing.Bounce">
  72. <summary>
  73. This class contains a C# port of the easing equations created by Robert Penner (http://robertpenner.com/easing).
  74. </summary>
  75. </member>
  76. <member name="M:DG.Tweening.Core.Easing.Bounce.EaseIn(System.Single,System.Single,System.Single,System.Single)">
  77. <summary>
  78. Easing equation function for a bounce (exponentially decaying parabolic bounce) easing in: accelerating from zero velocity.
  79. </summary>
  80. <param name="time">
  81. Current time (in frames or seconds).
  82. </param>
  83. <param name="duration">
  84. Expected easing duration (in frames or seconds).
  85. </param>
  86. <param name="unusedOvershootOrAmplitude">Unused: here to keep same delegate for all ease types.</param>
  87. <param name="unusedPeriod">Unused: here to keep same delegate for all ease types.</param>
  88. <returns>
  89. The eased value.
  90. </returns>
  91. </member>
  92. <member name="M:DG.Tweening.Core.Easing.Bounce.EaseOut(System.Single,System.Single,System.Single,System.Single)">
  93. <summary>
  94. Easing equation function for a bounce (exponentially decaying parabolic bounce) easing out: decelerating from zero velocity.
  95. </summary>
  96. <param name="time">
  97. Current time (in frames or seconds).
  98. </param>
  99. <param name="duration">
  100. Expected easing duration (in frames or seconds).
  101. </param>
  102. <param name="unusedOvershootOrAmplitude">Unused: here to keep same delegate for all ease types.</param>
  103. <param name="unusedPeriod">Unused: here to keep same delegate for all ease types.</param>
  104. <returns>
  105. The eased value.
  106. </returns>
  107. </member>
  108. <member name="M:DG.Tweening.Core.Easing.Bounce.EaseInOut(System.Single,System.Single,System.Single,System.Single)">
  109. <summary>
  110. Easing equation function for a bounce (exponentially decaying parabolic bounce) easing in/out: acceleration until halfway, then deceleration.
  111. </summary>
  112. <param name="time">
  113. Current time (in frames or seconds).
  114. </param>
  115. <param name="duration">
  116. Expected easing duration (in frames or seconds).
  117. </param>
  118. <param name="unusedOvershootOrAmplitude">Unused: here to keep same delegate for all ease types.</param>
  119. <param name="unusedPeriod">Unused: here to keep same delegate for all ease types.</param>
  120. <returns>
  121. The eased value.
  122. </returns>
  123. </member>
  124. <member name="M:DG.Tweening.Core.Easing.EaseManager.Evaluate(DG.Tweening.Tween,System.Single,System.Single,System.Single,System.Single)">
  125. <summary>
  126. Returns a value between 0 and 1 (inclusive) based on the elapsed time and ease selected
  127. </summary>
  128. </member>
  129. <member name="M:DG.Tweening.Core.Easing.EaseManager.Evaluate(DG.Tweening.Ease,DG.Tweening.EaseFunction,System.Single,System.Single,System.Single,System.Single)">
  130. <summary>
  131. Returns a value between 0 and 1 (inclusive) based on the elapsed time and ease selected
  132. </summary>
  133. </member>
  134. <member name="T:DG.Tweening.Core.Easing.EaseCurve">
  135. <summary>
  136. Used to interpret AnimationCurves as eases.
  137. Public so it can be used by external ease factories
  138. </summary>
  139. </member>
  140. <member name="T:DG.Tweening.Core.Enums.UpdateNotice">
  141. <summary>
  142. Additional notices passed to plugins when updating.
  143. Public so it can be used by custom plugins. Internally, only PathPlugin uses it
  144. </summary>
  145. </member>
  146. <member name="F:DG.Tweening.Core.Enums.UpdateNotice.None">
  147. <summary>
  148. None
  149. </summary>
  150. </member>
  151. <member name="F:DG.Tweening.Core.Enums.UpdateNotice.RewindStep">
  152. <summary>
  153. Lets the plugin know that we restarted or rewinded
  154. </summary>
  155. </member>
  156. <member name="T:DG.Tweening.Core.Extensions">
  157. <summary>
  158. Public only so custom shortcuts can access some of these methods
  159. </summary>
  160. </member>
  161. <member name="M:DG.Tweening.Core.Utils.Vector3FromAngle(System.Single,System.Single)">
  162. <summary>
  163. Returns a Vector3 with z = 0
  164. </summary>
  165. </member>
  166. <member name="M:DG.Tweening.Core.Utils.Angle2D(UnityEngine.Vector3,UnityEngine.Vector3)">
  167. <summary>
  168. Returns the 2D angle between two vectors
  169. </summary>
  170. </member>
  171. <member name="M:DG.Tweening.Core.Utils.Vector3AreApproximatelyEqual(UnityEngine.Vector3,UnityEngine.Vector3)">
  172. <summary>
  173. Uses approximate equality on each axis instead of Unity's Vector3 equality,
  174. because the latter fails (in some cases) when assigning a Vector3 to a transform.position and then checking it.
  175. </summary>
  176. </member>
  177. <member name="T:DG.Tweening.Color2">
  178. <summary>
  179. Struct that stores two colors (used for LineRenderer tweens)
  180. </summary>
  181. </member>
  182. <member name="T:DG.Tweening.TweenCallback">
  183. <summary>
  184. Used for tween callbacks
  185. </summary>
  186. </member>
  187. <member name="T:DG.Tweening.TweenCallback`1">
  188. <summary>
  189. Used for tween callbacks
  190. </summary>
  191. </member>
  192. <member name="T:DG.Tweening.EaseFunction">
  193. <summary>
  194. Used for custom and animationCurve-based ease functions. Must return a value between 0 and 1.
  195. </summary>
  196. </member>
  197. <member name="T:DG.Tweening.CustomPlugins.PureQuaternionPlugin">
  198. <summary>
  199. Straight Quaternion plugin. Instead of using Vector3 values accepts Quaternion values directly.
  200. <para>Beware: doesn't work with LoopType.Incremental (neither directly nor if inside a LoopType.Incremental Sequence).</para>
  201. <para>To use it, call DOTween.To with the plugin parameter overload, passing it <c>PureQuaternionPlugin.Plug()</c> as first parameter
  202. (do not use any of the other public PureQuaternionPlugin methods):</para>
  203. <code>DOTween.To(PureQuaternionPlugin.Plug(), ()=> myQuaternionProperty, x=> myQuaternionProperty = x, myQuaternionEndValue, duration);</code>
  204. </summary>
  205. </member>
  206. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.Plug">
  207. <summary>
  208. Plug this plugin inside a DOTween.To call.
  209. <para>Example:</para>
  210. <code>DOTween.To(PureQuaternionPlugin.Plug(), ()=> myQuaternionProperty, x=> myQuaternionProperty = x, myQuaternionEndValue, duration);</code>
  211. </summary>
  212. </member>
  213. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.Reset(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions})">
  214. <summary>INTERNAL: do not use</summary>
  215. </member>
  216. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetFrom(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions},System.Boolean)">
  217. <summary>INTERNAL: do not use</summary>
  218. </member>
  219. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.ConvertToStartValue(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions},UnityEngine.Quaternion)">
  220. <summary>INTERNAL: do not use</summary>
  221. </member>
  222. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetRelativeEndValue(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions})">
  223. <summary>INTERNAL: do not use</summary>
  224. </member>
  225. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.SetChangeValue(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Quaternion,DG.Tweening.Plugins.Options.NoOptions})">
  226. <summary>INTERNAL: do not use</summary>
  227. </member>
  228. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.GetSpeedBasedDuration(DG.Tweening.Plugins.Options.NoOptions,System.Single,UnityEngine.Quaternion)">
  229. <summary>INTERNAL: do not use</summary>
  230. </member>
  231. <member name="M:DG.Tweening.CustomPlugins.PureQuaternionPlugin.EvaluateAndApply(DG.Tweening.Plugins.Options.NoOptions,DG.Tweening.Tween,System.Boolean,DG.Tweening.Core.DOGetter{UnityEngine.Quaternion},DG.Tweening.Core.DOSetter{UnityEngine.Quaternion},System.Single,UnityEngine.Quaternion,UnityEngine.Quaternion,System.Single,System.Boolean,DG.Tweening.Core.Enums.UpdateNotice)">
  232. <summary>INTERNAL: do not use</summary>
  233. </member>
  234. <member name="T:DG.Tweening.DOTween">
  235. <summary>
  236. Main DOTween class. Contains static methods to create and control tweens in a generic way
  237. </summary>
  238. </member>
  239. <member name="F:DG.Tweening.DOTween.Version">
  240. <summary>DOTween's version</summary>
  241. </member>
  242. <member name="F:DG.Tweening.DOTween.useSafeMode">
  243. <summary>If TRUE (default) makes tweens slightly slower but safer, automatically taking care of a series of things
  244. (like targets becoming null while a tween is playing).
  245. <para>Default: TRUE</para></summary>
  246. </member>
  247. <member name="F:DG.Tweening.DOTween.showUnityEditorReport">
  248. <summary>If TRUE you will get a DOTween report when exiting play mode (only in the Editor).
  249. Useful to know how many max Tweeners and Sequences you reached and optimize your final project accordingly.
  250. Beware, this will slightly slow down your tweens while inside Unity Editor.
  251. <para>Default: FALSE</para></summary>
  252. </member>
  253. <member name="F:DG.Tweening.DOTween.timeScale">
  254. <summary>Global DOTween timeScale.
  255. <para>Default: 1</para></summary>
  256. </member>
  257. <member name="F:DG.Tweening.DOTween.useSmoothDeltaTime">
  258. <summary>If TRUE, DOTween will use Time.smoothDeltaTime instead of Time.deltaTime for UpdateType.Normal and UpdateType.Late tweens
  259. (unless they're set as timeScaleIndependent, in which case a value between the last timestep
  260. and <see cref="F:DG.Tweening.DOTween.maxSmoothUnscaledTime"/> will be used instead).
  261. Setting this to TRUE will lead to smoother animations.
  262. <para>Default: FALSE</para></summary>
  263. </member>
  264. <member name="F:DG.Tweening.DOTween.maxSmoothUnscaledTime">
  265. <summary>If <see cref="F:DG.Tweening.DOTween.useSmoothDeltaTime"/> is TRUE, this indicates the max timeStep that an independent update call can last.
  266. Setting this to TRUE will lead to smoother animations.
  267. <para>Default: FALSE</para></summary>
  268. </member>
  269. <member name="P:DG.Tweening.DOTween.logBehaviour">
  270. <summary>DOTween's log behaviour.
  271. <para>Default: LogBehaviour.ErrorsOnly</para></summary>
  272. </member>
  273. <member name="F:DG.Tweening.DOTween.drawGizmos">
  274. <summary>If TRUE draws path gizmos in Unity Editor (if the gizmos button is active).
  275. Deactivate this if you want to avoid gizmos overhead while in Unity Editor</summary>
  276. </member>
  277. <member name="F:DG.Tweening.DOTween.defaultUpdateType">
  278. <summary>Default updateType for new tweens.
  279. <para>Default: UpdateType.Normal</para></summary>
  280. </member>
  281. <member name="F:DG.Tweening.DOTween.defaultTimeScaleIndependent">
  282. <summary>Sets whether Unity's timeScale should be taken into account by default or not.
  283. <para>Default: false</para></summary>
  284. </member>
  285. <member name="F:DG.Tweening.DOTween.defaultAutoPlay">
  286. <summary>Default autoPlay behaviour for new tweens.
  287. <para>Default: AutoPlay.All</para></summary>
  288. </member>
  289. <member name="F:DG.Tweening.DOTween.defaultAutoKill">
  290. <summary>Default autoKillOnComplete behaviour for new tweens.
  291. <para>Default: TRUE</para></summary>
  292. </member>
  293. <member name="F:DG.Tweening.DOTween.defaultLoopType">
  294. <summary>Default loopType applied to all new tweens.
  295. <para>Default: LoopType.Restart</para></summary>
  296. </member>
  297. <member name="F:DG.Tweening.DOTween.defaultRecyclable">
  298. <summary>If TRUE all newly created tweens are set as recyclable, otherwise not.
  299. <para>Default: FALSE</para></summary>
  300. </member>
  301. <member name="F:DG.Tweening.DOTween.defaultEaseType">
  302. <summary>Default ease applied to all new Tweeners (not to Sequences which always have Ease.Linear as default).
  303. <para>Default: Ease.InOutQuad</para></summary>
  304. </member>
  305. <member name="F:DG.Tweening.DOTween.defaultEaseOvershootOrAmplitude">
  306. <summary>Default overshoot/amplitude used for eases
  307. <para>Default: 1.70158f</para></summary>
  308. </member>
  309. <member name="F:DG.Tweening.DOTween.defaultEasePeriod">
  310. <summary>Default period used for eases
  311. <para>Default: 0</para></summary>
  312. </member>
  313. <member name="M:DG.Tweening.DOTween.Init(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{DG.Tweening.LogBehaviour})">
  314. <summary>
  315. Must be called once, before the first ever DOTween call/reference,
  316. otherwise it will be called automatically and will use default options.
  317. Calling it a second time won't have any effect.
  318. <para>You can chain <code>SetCapacity</code> to this method, to directly set the max starting size of Tweeners and Sequences:</para>
  319. <code>DOTween.Init(false, false, LogBehaviour.Default).SetCapacity(100, 20);</code>
  320. </summary>
  321. <param name="recycleAllByDefault">If TRUE all new tweens will be set for recycling, meaning that when killed,
  322. instead of being destroyed, they will be put in a pool and reused instead of creating new tweens. This option allows you to avoid
  323. GC allocations by reusing tweens, but you will have to take care of tween references, since they might result active
  324. even if they were killed (since they might have been respawned and are now being used for other tweens).
  325. <para>If you want to automatically set your tween references to NULL when a tween is killed
  326. you can use the OnKill callback like this:</para>
  327. <code>.OnKill(()=> myTweenReference = null)</code>
  328. <para>You can change this setting at any time by changing the static <see cref="F:DG.Tweening.DOTween.defaultRecyclable"/> property,
  329. or you can set the recycling behaviour for each tween separately, using:</para>
  330. <para><code>SetRecyclable(bool recyclable)</code></para>
  331. <para>Default: FALSE</para></param>
  332. <param name="useSafeMode">If TRUE makes tweens slightly slower but safer, automatically taking care of a series of things
  333. (like targets becoming null while a tween is playing).
  334. You can change this setting at any time by changing the static <see cref="F:DG.Tweening.DOTween.useSafeMode"/> property.
  335. <para>Default: FALSE</para></param>
  336. <param name="logBehaviour">Type of logging to use.
  337. You can change this setting at any time by changing the static <see cref="P:DG.Tweening.DOTween.logBehaviour"/> property.
  338. <para>Default: ErrorsOnly</para></param>
  339. </member>
  340. <member name="M:DG.Tweening.DOTween.SetTweensCapacity(System.Int32,System.Int32)">
  341. <summary>
  342. Directly sets the current max capacity of Tweeners and Sequences
  343. (meaning how many Tweeners and Sequences can be running at the same time),
  344. so that DOTween doesn't need to automatically increase them in case the max is reached
  345. (which might lead to hiccups when that happens).
  346. Sequences capacity must be less or equal to Tweeners capacity
  347. (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's).
  348. Beware: use this method only when there are no tweens running.
  349. </summary>
  350. <param name="tweenersCapacity">Max Tweeners capacity.
  351. Default: 200</param>
  352. <param name="sequencesCapacity">Max Sequences capacity.
  353. Default: 50</param>
  354. </member>
  355. <member name="M:DG.Tweening.DOTween.Clear(System.Boolean)">
  356. <summary>
  357. Kills all tweens, clears all cached tween pools and plugins and resets the max Tweeners/Sequences capacities to the default values.
  358. </summary>
  359. <param name="destroy">If TRUE also destroys DOTween's gameObject and resets its initializiation, default settings and everything else
  360. (so that next time you use it it will need to be re-initialized)</param>
  361. </member>
  362. <member name="M:DG.Tweening.DOTween.ClearCachedTweens">
  363. <summary>
  364. Clears all cached tween pools.
  365. </summary>
  366. </member>
  367. <member name="M:DG.Tweening.DOTween.Validate">
  368. <summary>
  369. Checks all active tweens to find and remove eventually invalid ones (usually because their targets became NULL)
  370. and returns the total number of invalid tweens found and removed.
  371. IMPORTANT: this will cause an error on UWP platform, so don't use it there
  372. BEWARE: this is a slightly expensive operation so use it with care
  373. </summary>
  374. </member>
  375. <member name="M:DG.Tweening.DOTween.ManualUpdate(System.Single,System.Single)">
  376. <summary>
  377. Updates all tweens that are set to <see cref="F:DG.Tweening.UpdateType.Manual"/>.
  378. </summary>
  379. <param name="deltaTime">Manual deltaTime</param>
  380. <param name="unscaledDeltaTime">Unscaled delta time (used with tweens set as timeScaleIndependent)</param>
  381. </member>
  382. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Single},DG.Tweening.Core.DOSetter{System.Single},System.Single,System.Single)">
  383. <summary>Tweens a property or field to the given value using default plugins</summary>
  384. <param name="getter">A getter for the field or property to tween.
  385. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  386. <param name="setter">A setter for the field or property to tween
  387. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  388. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  389. </member>
  390. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Double},DG.Tweening.Core.DOSetter{System.Double},System.Double,System.Single)">
  391. <summary>Tweens a property or field to the given value using default plugins</summary>
  392. <param name="getter">A getter for the field or property to tween.
  393. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  394. <param name="setter">A setter for the field or property to tween
  395. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  396. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  397. </member>
  398. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Int32},DG.Tweening.Core.DOSetter{System.Int32},System.Int32,System.Single)">
  399. <summary>Tweens a property or field to the given value using default plugins</summary>
  400. <param name="getter">A getter for the field or property to tween.
  401. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  402. <param name="setter">A setter for the field or property to tween
  403. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  404. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  405. </member>
  406. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.UInt32},DG.Tweening.Core.DOSetter{System.UInt32},System.UInt32,System.Single)">
  407. <summary>Tweens a property or field to the given value using default plugins</summary>
  408. <param name="getter">A getter for the field or property to tween.
  409. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  410. <param name="setter">A setter for the field or property to tween
  411. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  412. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  413. </member>
  414. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.Int64},DG.Tweening.Core.DOSetter{System.Int64},System.Int64,System.Single)">
  415. <summary>Tweens a property or field to the given value using default plugins</summary>
  416. <param name="getter">A getter for the field or property to tween.
  417. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  418. <param name="setter">A setter for the field or property to tween
  419. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  420. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  421. </member>
  422. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.UInt64},DG.Tweening.Core.DOSetter{System.UInt64},System.UInt64,System.Single)">
  423. <summary>Tweens a property or field to the given value using default plugins</summary>
  424. <param name="getter">A getter for the field or property to tween.
  425. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  426. <param name="setter">A setter for the field or property to tween
  427. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  428. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  429. </member>
  430. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{System.String},DG.Tweening.Core.DOSetter{System.String},System.String,System.Single)">
  431. <summary>Tweens a property or field to the given value using default plugins</summary>
  432. <param name="getter">A getter for the field or property to tween.
  433. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  434. <param name="setter">A setter for the field or property to tween
  435. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  436. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  437. </member>
  438. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Vector2},DG.Tweening.Core.DOSetter{UnityEngine.Vector2},UnityEngine.Vector2,System.Single)">
  439. <summary>Tweens a property or field to the given value using default plugins</summary>
  440. <param name="getter">A getter for the field or property to tween.
  441. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  442. <param name="setter">A setter for the field or property to tween
  443. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  444. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  445. </member>
  446. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},UnityEngine.Vector3,System.Single)">
  447. <summary>Tweens a property or field to the given value using default plugins</summary>
  448. <param name="getter">A getter for the field or property to tween.
  449. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  450. <param name="setter">A setter for the field or property to tween
  451. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  452. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  453. </member>
  454. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Vector4},DG.Tweening.Core.DOSetter{UnityEngine.Vector4},UnityEngine.Vector4,System.Single)">
  455. <summary>Tweens a property or field to the given value using default plugins</summary>
  456. <param name="getter">A getter for the field or property to tween.
  457. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  458. <param name="setter">A setter for the field or property to tween
  459. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  460. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  461. </member>
  462. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Quaternion},DG.Tweening.Core.DOSetter{UnityEngine.Quaternion},UnityEngine.Vector3,System.Single)">
  463. <summary>Tweens a property or field to the given value using default plugins</summary>
  464. <param name="getter">A getter for the field or property to tween.
  465. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  466. <param name="setter">A setter for the field or property to tween
  467. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  468. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  469. </member>
  470. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Color},DG.Tweening.Core.DOSetter{UnityEngine.Color},UnityEngine.Color,System.Single)">
  471. <summary>Tweens a property or field to the given value using default plugins</summary>
  472. <param name="getter">A getter for the field or property to tween.
  473. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  474. <param name="setter">A setter for the field or property to tween
  475. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  476. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  477. </member>
  478. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.Rect},DG.Tweening.Core.DOSetter{UnityEngine.Rect},UnityEngine.Rect,System.Single)">
  479. <summary>Tweens a property or field to the given value using default plugins</summary>
  480. <param name="getter">A getter for the field or property to tween.
  481. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  482. <param name="setter">A setter for the field or property to tween
  483. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  484. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  485. </member>
  486. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOGetter{UnityEngine.RectOffset},DG.Tweening.Core.DOSetter{UnityEngine.RectOffset},UnityEngine.RectOffset,System.Single)">
  487. <summary>Tweens a property or field to the given value using default plugins</summary>
  488. <param name="getter">A getter for the field or property to tween.
  489. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  490. <param name="setter">A setter for the field or property to tween
  491. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  492. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  493. </member>
  494. <member name="M:DG.Tweening.DOTween.To``3(DG.Tweening.Plugins.Core.ABSTweenPlugin{``0,``1,``2},DG.Tweening.Core.DOGetter{``0},DG.Tweening.Core.DOSetter{``0},``1,System.Single)">
  495. <summary>Tweens a property or field to the given value using a custom plugin</summary>
  496. <param name="plugin">The plugin to use. Each custom plugin implements a static <code>Get()</code> method
  497. you'll need to call to assign the correct plugin in the correct way, like this:
  498. <para><code>CustomPlugin.Get()</code></para></param>
  499. <param name="getter">A getter for the field or property to tween.
  500. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  501. <param name="setter">A setter for the field or property to tween
  502. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  503. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  504. </member>
  505. <member name="M:DG.Tweening.DOTween.ToAxis(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},System.Single,System.Single,DG.Tweening.AxisConstraint)">
  506. <summary>Tweens only one axis of a Vector3 to the given value using default plugins.</summary>
  507. <param name="getter">A getter for the field or property to tween.
  508. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  509. <param name="setter">A setter for the field or property to tween
  510. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  511. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  512. <param name="axisConstraint">The axis to tween</param>
  513. </member>
  514. <member name="M:DG.Tweening.DOTween.ToAlpha(DG.Tweening.Core.DOGetter{UnityEngine.Color},DG.Tweening.Core.DOSetter{UnityEngine.Color},System.Single,System.Single)">
  515. <summary>Tweens only the alpha of a Color to the given value using default plugins</summary>
  516. <param name="getter">A getter for the field or property to tween.
  517. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  518. <param name="setter">A setter for the field or property to tween
  519. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  520. <param name="endValue">The end value to reach</param><param name="duration">The tween's duration</param>
  521. </member>
  522. <member name="M:DG.Tweening.DOTween.To(DG.Tweening.Core.DOSetter{System.Single},System.Single,System.Single,System.Single)">
  523. <summary>Tweens a virtual property from the given start to the given end value
  524. and implements a setter that allows to use that value with an external method or a lambda
  525. <para>Example:</para>
  526. <code>To(MyMethod, 0, 12, 0.5f);</code>
  527. <para>Where MyMethod is a function that accepts a float parameter (which will be the result of the virtual tween)</para></summary>
  528. <param name="setter">The action to perform with the tweened value</param>
  529. <param name="startValue">The value to start from</param>
  530. <param name="endValue">The end value to reach</param>
  531. <param name="duration">The duration of the virtual tween
  532. </param>
  533. </member>
  534. <member name="M:DG.Tweening.DOTween.Punch(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
  535. <summary>Punches a Vector3 towards the given direction and then back to the starting one
  536. as if it was connected to the starting position via an elastic.
  537. <para>This tween type generates some GC allocations at startup</para></summary>
  538. <param name="getter">A getter for the field or property to tween.
  539. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  540. <param name="setter">A setter for the field or property to tween
  541. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  542. <param name="direction">The direction and strength of the punch</param>
  543. <param name="duration">The duration of the tween</param>
  544. <param name="vibrato">Indicates how much will the punch vibrate</param>
  545. <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards.
  546. 1 creates a full oscillation between the direction and the opposite decaying direction,
  547. while 0 oscillates only between the starting position and the decaying direction</param>
  548. </member>
  549. <member name="M:DG.Tweening.DOTween.Shake(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},System.Single,System.Single,System.Int32,System.Single,System.Boolean,System.Boolean)">
  550. <summary>Shakes a Vector3 with the given values.</summary>
  551. <param name="getter">A getter for the field or property to tween.
  552. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  553. <param name="setter">A setter for the field or property to tween
  554. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  555. <param name="duration">The duration of the tween</param>
  556. <param name="strength">The shake strength</param>
  557. <param name="vibrato">Indicates how much will the shake vibrate</param>
  558. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  559. Setting it to 0 will shake along a single direction and behave like a random punch.</param>
  560. <param name="ignoreZAxis">If TRUE only shakes on the X Y axis (looks better with things like cameras).</param>
  561. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  562. </member>
  563. <member name="M:DG.Tweening.DOTween.Shake(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean)">
  564. <summary>Shakes a Vector3 with the given values.</summary>
  565. <param name="getter">A getter for the field or property to tween.
  566. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  567. <param name="setter">A setter for the field or property to tween
  568. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  569. <param name="duration">The duration of the tween</param>
  570. <param name="strength">The shake strength on each axis</param>
  571. <param name="vibrato">Indicates how much will the shake vibrate</param>
  572. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  573. Setting it to 0 will shake along a single direction and behave like a random punch.</param>
  574. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  575. </member>
  576. <member name="M:DG.Tweening.DOTween.ToArray(DG.Tweening.Core.DOGetter{UnityEngine.Vector3},DG.Tweening.Core.DOSetter{UnityEngine.Vector3},UnityEngine.Vector3[],System.Single[])">
  577. <summary>Tweens a property or field to the given values using default plugins.
  578. Ease is applied between each segment and not as a whole.
  579. <para>This tween type generates some GC allocations at startup</para></summary>
  580. <param name="getter">A getter for the field or property to tween.
  581. <para>Example usage with lambda:</para><code>()=> myProperty</code></param>
  582. <param name="setter">A setter for the field or property to tween
  583. <para>Example usage with lambda:</para><code>x=> myProperty = x</code></param>
  584. <param name="endValues">The end values to reach for each segment. This array must have the same length as <code>durations</code></param>
  585. <param name="durations">The duration of each segment. This array must have the same length as <code>endValues</code></param>
  586. </member>
  587. <member name="M:DG.Tweening.DOTween.Sequence">
  588. <summary>
  589. Returns a new <see cref="M:DG.Tweening.DOTween.Sequence"/> to be used for tween groups
  590. </summary>
  591. </member>
  592. <member name="M:DG.Tweening.DOTween.CompleteAll(System.Boolean)">
  593. <summary>Completes all tweens and returns the number of actual tweens completed
  594. (meaning tweens that don't have infinite loops and were not already complete)</summary>
  595. <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
  596. otherwise they will be ignored</param>
  597. </member>
  598. <member name="M:DG.Tweening.DOTween.Complete(System.Object,System.Boolean)">
  599. <summary>Completes all tweens with the given ID or target and returns the number of actual tweens completed
  600. (meaning the tweens that don't have infinite loops and were not already complete)</summary>
  601. <param name="withCallbacks">For Sequences only: if TRUE internal Sequence callbacks will be fired,
  602. otherwise they will be ignored</param>
  603. </member>
  604. <member name="M:DG.Tweening.DOTween.FlipAll">
  605. <summary>Flips all tweens (changing their direction to forward if it was backwards and viceversa),
  606. then returns the number of actual tweens flipped</summary>
  607. </member>
  608. <member name="M:DG.Tweening.DOTween.Flip(System.Object)">
  609. <summary>Flips the tweens with the given ID or target (changing their direction to forward if it was backwards and viceversa),
  610. then returns the number of actual tweens flipped</summary>
  611. </member>
  612. <member name="M:DG.Tweening.DOTween.GotoAll(System.Single,System.Boolean)">
  613. <summary>Sends all tweens to the given position (calculating also eventual loop cycles) and returns the actual tweens involved</summary>
  614. </member>
  615. <member name="M:DG.Tweening.DOTween.Goto(System.Object,System.Single,System.Boolean)">
  616. <summary>Sends all tweens with the given ID or target to the given position (calculating also eventual loop cycles)
  617. and returns the actual tweens involved</summary>
  618. </member>
  619. <member name="M:DG.Tweening.DOTween.KillAll(System.Boolean)">
  620. <summary>Kills all tweens and returns the number of actual tweens killed</summary>
  621. <param name="complete">If TRUE completes the tweens before killing them</param>
  622. </member>
  623. <member name="M:DG.Tweening.DOTween.KillAll(System.Boolean,System.Object[])">
  624. <summary>Kills all tweens and returns the number of actual tweens killed</summary>
  625. <param name="complete">If TRUE completes the tweens before killing them</param>
  626. <param name="idsOrTargetsToExclude">Eventual IDs or targets to exclude from the killing</param>
  627. </member>
  628. <member name="M:DG.Tweening.DOTween.Kill(System.Object,System.Boolean)">
  629. <summary>Kills all tweens with the given ID or target and returns the number of actual tweens killed</summary>
  630. <param name="complete">If TRUE completes the tweens before killing them</param>
  631. </member>
  632. <member name="M:DG.Tweening.DOTween.PauseAll">
  633. <summary>Pauses all tweens and returns the number of actual tweens paused</summary>
  634. </member>
  635. <member name="M:DG.Tweening.DOTween.Pause(System.Object)">
  636. <summary>Pauses all tweens with the given ID or target and returns the number of actual tweens paused
  637. (meaning the tweens that were actually playing and have been paused)</summary>
  638. </member>
  639. <member name="M:DG.Tweening.DOTween.PlayAll">
  640. <summary>Plays all tweens and returns the number of actual tweens played
  641. (meaning tweens that were not already playing or complete)</summary>
  642. </member>
  643. <member name="M:DG.Tweening.DOTween.Play(System.Object)">
  644. <summary>Plays all tweens with the given ID or target and returns the number of actual tweens played
  645. (meaning the tweens that were not already playing or complete)</summary>
  646. </member>
  647. <member name="M:DG.Tweening.DOTween.Play(System.Object,System.Object)">
  648. <summary>Plays all tweens with the given target and the given ID, and returns the number of actual tweens played
  649. (meaning the tweens that were not already playing or complete)</summary>
  650. </member>
  651. <member name="M:DG.Tweening.DOTween.PlayBackwardsAll">
  652. <summary>Plays backwards all tweens and returns the number of actual tweens played
  653. (meaning tweens that were not already started, playing backwards or rewinded)</summary>
  654. </member>
  655. <member name="M:DG.Tweening.DOTween.PlayBackwards(System.Object)">
  656. <summary>Plays backwards all tweens with the given ID or target and returns the number of actual tweens played
  657. (meaning the tweens that were not already started, playing backwards or rewinded)</summary>
  658. </member>
  659. <member name="M:DG.Tweening.DOTween.PlayBackwards(System.Object,System.Object)">
  660. <summary>Plays backwards all tweens with the given target and ID and returns the number of actual tweens played
  661. (meaning the tweens that were not already started, playing backwards or rewinded)</summary>
  662. </member>
  663. <member name="M:DG.Tweening.DOTween.PlayForwardAll">
  664. <summary>Plays forward all tweens and returns the number of actual tweens played
  665. (meaning tweens that were not already playing forward or complete)</summary>
  666. </member>
  667. <member name="M:DG.Tweening.DOTween.PlayForward(System.Object)">
  668. <summary>Plays forward all tweens with the given ID or target and returns the number of actual tweens played
  669. (meaning the tweens that were not already playing forward or complete)</summary>
  670. </member>
  671. <member name="M:DG.Tweening.DOTween.PlayForward(System.Object,System.Object)">
  672. <summary>Plays forward all tweens with the given target and ID and returns the number of actual tweens played
  673. (meaning the tweens that were not already started, playing backwards or rewinded)</summary>
  674. </member>
  675. <member name="M:DG.Tweening.DOTween.RestartAll(System.Boolean)">
  676. <summary>Restarts all tweens, then returns the number of actual tweens restarted</summary>
  677. </member>
  678. <member name="M:DG.Tweening.DOTween.Restart(System.Object,System.Boolean,System.Single)">
  679. <summary>Restarts all tweens with the given ID or target, then returns the number of actual tweens restarted</summary>
  680. <param name="includeDelay">If TRUE includes the eventual tweens delays, otherwise skips them</param>
  681. <param name="changeDelayTo">If >= 0 changes the startup delay of all involved tweens to this value, otherwise doesn't touch it</param>
  682. </member>
  683. <member name="M:DG.Tweening.DOTween.Restart(System.Object,System.Object,System.Boolean,System.Single)">
  684. <summary>Restarts all tweens with the given target and the given ID, and returns the number of actual tweens played
  685. (meaning the tweens that were not already playing or complete)</summary>
  686. <param name="includeDelay">If TRUE includes the eventual tweens delays, otherwise skips them</param>
  687. <param name="changeDelayTo">If >= 0 changes the startup delay of all involved tweens to this value, otherwise doesn't touch it</param>
  688. </member>
  689. <member name="M:DG.Tweening.DOTween.RewindAll(System.Boolean)">
  690. <summary>Rewinds and pauses all tweens, then returns the number of actual tweens rewinded
  691. (meaning tweens that were not already rewinded)</summary>
  692. </member>
  693. <member name="M:DG.Tweening.DOTween.Rewind(System.Object,System.Boolean)">
  694. <summary>Rewinds and pauses all tweens with the given ID or target, then returns the number of actual tweens rewinded
  695. (meaning the tweens that were not already rewinded)</summary>
  696. </member>
  697. <member name="M:DG.Tweening.DOTween.SmoothRewindAll">
  698. <summary>Smoothly rewinds all tweens (delays excluded), then returns the number of actual tweens rewinding/rewinded
  699. (meaning tweens that were not already rewinded).
  700. A "smooth rewind" animates the tween to its start position,
  701. skipping all elapsed loops (except in case of LoopType.Incremental) while keeping the animation fluent.
  702. <para>Note that a tween that was smoothly rewinded will have its play direction flipped</para></summary>
  703. </member>
  704. <member name="M:DG.Tweening.DOTween.SmoothRewind(System.Object)">
  705. <summary>Smoothly rewinds all tweens (delays excluded) with the given ID or target, then returns the number of actual tweens rewinding/rewinded
  706. (meaning the tweens that were not already rewinded).
  707. A "smooth rewind" animates the tween to its start position,
  708. skipping all elapsed loops (except in case of LoopType.Incremental) while keeping the animation fluent.
  709. <para>Note that a tween that was smoothly rewinded will have its play direction flipped</para></summary>
  710. </member>
  711. <member name="M:DG.Tweening.DOTween.TogglePauseAll">
  712. <summary>Toggles the play state of all tweens and returns the number of actual tweens toggled
  713. (meaning tweens that could be played or paused, depending on the toggle state)</summary>
  714. </member>
  715. <member name="M:DG.Tweening.DOTween.TogglePause(System.Object)">
  716. <summary>Toggles the play state of all tweens with the given ID or target and returns the number of actual tweens toggled
  717. (meaning the tweens that could be played or paused, depending on the toggle state)</summary>
  718. </member>
  719. <member name="M:DG.Tweening.DOTween.IsTweening(System.Object,System.Boolean)">
  720. <summary>
  721. Returns TRUE if a tween with the given ID or target is active.
  722. <para>You can also use this to know if a shortcut tween is active for a given target.</para>
  723. <para>Example:</para>
  724. <para><code>transform.DOMoveX(45, 1); // transform is automatically added as the tween target</code></para>
  725. <para><code>DOTween.IsTweening(transform); // Returns true</code></para>
  726. </summary>
  727. <param name="targetOrId">The target or ID to look for</param>
  728. <param name="alsoCheckIfIsPlaying">If FALSE (default) returns TRUE as long as a tween for the given target/ID is active,
  729. otherwise also requires it to be playing</param>
  730. </member>
  731. <member name="M:DG.Tweening.DOTween.TotalPlayingTweens">
  732. <summary>
  733. Returns the total number of active and playing tweens.
  734. A tween is considered as playing even if its delay is actually playing
  735. </summary>
  736. </member>
  737. <member name="M:DG.Tweening.DOTween.PlayingTweens">
  738. <summary>
  739. Returns a list of all active tweens in a playing state.
  740. Returns NULL if there are no active playing tweens.
  741. <para>Beware: each time you call this method a new list is generated, so use it for debug only</para>
  742. </summary>
  743. </member>
  744. <member name="M:DG.Tweening.DOTween.PausedTweens">
  745. <summary>
  746. Returns a list of all active tweens in a paused state.
  747. Returns NULL if there are no active paused tweens.
  748. <para>Beware: each time you call this method a new list is generated, so use it for debug only</para>
  749. </summary>
  750. </member>
  751. <member name="M:DG.Tweening.DOTween.TweensById(System.Object,System.Boolean)">
  752. <summary>
  753. Returns a list of all active tweens with the given id.
  754. Returns NULL if there are no active tweens with the given id.
  755. <para>Beware: each time you call this method a new list is generated</para>
  756. <param name="playingOnly">If TRUE returns only the tweens with the given ID that are currently playing</param>
  757. </summary>
  758. </member>
  759. <member name="M:DG.Tweening.DOTween.TweensByTarget(System.Object,System.Boolean)">
  760. <summary>
  761. Returns a list of all active tweens with the given target.
  762. Returns NULL if there are no active tweens with the given target.
  763. <para>Beware: each time you call this method a new list is generated</para>
  764. <param name="playingOnly">If TRUE returns only the tweens with the given target that are currently playing</param>
  765. </summary>
  766. </member>
  767. <member name="T:DG.Tweening.DOVirtual">
  768. <summary>
  769. Creates virtual tweens that can be used to change other elements via their OnUpdate calls
  770. </summary>
  771. </member>
  772. <member name="M:DG.Tweening.DOVirtual.Float(System.Single,System.Single,System.Single,DG.Tweening.TweenCallback{System.Single})">
  773. <summary>
  774. Tweens a virtual float.
  775. You can add regular settings to the generated tween,
  776. but do not use <code>SetUpdate</code> or you will overwrite the onVirtualUpdate parameter
  777. </summary>
  778. <param name="from">The value to start from</param>
  779. <param name="to">The value to tween to</param>
  780. <param name="duration">The duration of the tween</param>
  781. <param name="onVirtualUpdate">A callback which must accept a parameter of type float, called at each update</param>
  782. <returns></returns>
  783. </member>
  784. <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,DG.Tweening.Ease)">
  785. <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
  786. <param name="from">The value to start from when lifetimePercentage is 0</param>
  787. <param name="to">The value to reach when lifetimePercentage is 1</param>
  788. <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
  789. <param name="easeType">The type of ease</param>
  790. </member>
  791. <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,DG.Tweening.Ease,System.Single)">
  792. <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
  793. <param name="from">The value to start from when lifetimePercentage is 0</param>
  794. <param name="to">The value to reach when lifetimePercentage is 1</param>
  795. <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
  796. <param name="easeType">The type of ease</param>
  797. <param name="overshoot">Eventual overshoot to use with Back ease</param>
  798. </member>
  799. <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,DG.Tweening.Ease,System.Single,System.Single)">
  800. <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
  801. <param name="from">The value to start from when lifetimePercentage is 0</param>
  802. <param name="to">The value to reach when lifetimePercentage is 1</param>
  803. <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
  804. <param name="easeType">The type of ease</param>
  805. <param name="amplitude">Eventual amplitude to use with Elastic easeType</param>
  806. <param name="period">Eventual period to use with Elastic easeType</param>
  807. </member>
  808. <member name="M:DG.Tweening.DOVirtual.EasedValue(System.Single,System.Single,System.Single,UnityEngine.AnimationCurve)">
  809. <summary>Returns a value based on the given ease and lifetime percentage (0 to 1)</summary>
  810. <param name="from">The value to start from when lifetimePercentage is 0</param>
  811. <param name="to">The value to reach when lifetimePercentage is 1</param>
  812. <param name="lifetimePercentage">The time percentage (0 to 1) at which the value should be taken</param>
  813. <param name="easeCurve">The AnimationCurve to use for ease</param>
  814. </member>
  815. <member name="M:DG.Tweening.DOVirtual.DelayedCall(System.Single,DG.Tweening.TweenCallback,System.Boolean)">
  816. <summary>Fires the given callback after the given time.</summary>
  817. <param name="delay">Callback delay</param>
  818. <param name="callback">Callback to fire when the delay has expired</param>
  819. <param name="ignoreTimeScale">If TRUE (default) ignores Unity's timeScale</param>
  820. </member>
  821. <member name="F:DG.Tweening.Ease.INTERNAL_Zero">
  822. <summary>
  823. Don't assign this! It's assigned automatically when creating 0 duration tweens
  824. </summary>
  825. </member>
  826. <member name="F:DG.Tweening.Ease.INTERNAL_Custom">
  827. <summary>
  828. Don't assign this! It's assigned automatically when setting the ease to an AnimationCurve or to a custom ease function
  829. </summary>
  830. </member>
  831. <member name="T:DG.Tweening.EaseFactory">
  832. <summary>
  833. Allows to wrap ease method in special ways, adding extra features
  834. </summary>
  835. </member>
  836. <member name="M:DG.Tweening.EaseFactory.StopMotion(System.Int32,System.Nullable{DG.Tweening.Ease})">
  837. <summary>
  838. Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS
  839. </summary>
  840. <param name="motionFps">FPS at which the tween should be played</param>
  841. <param name="ease">Ease type</param>
  842. </member>
  843. <member name="M:DG.Tweening.EaseFactory.StopMotion(System.Int32,UnityEngine.AnimationCurve)">
  844. <summary>
  845. Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS
  846. </summary>
  847. <param name="motionFps">FPS at which the tween should be played</param>
  848. <param name="animCurve">AnimationCurve to use for the ease</param>
  849. </member>
  850. <member name="M:DG.Tweening.EaseFactory.StopMotion(System.Int32,DG.Tweening.EaseFunction)">
  851. <summary>
  852. Converts the given ease so that it also creates a stop-motion effect, by playing the tween at the given FPS
  853. </summary>
  854. <param name="motionFps">FPS at which the tween should be played</param>
  855. <param name="customEase">Custom ease function to use</param>
  856. </member>
  857. <member name="T:DG.Tweening.IDOTweenInit">
  858. <summary>
  859. Used to allow method chaining with DOTween.Init
  860. </summary>
  861. </member>
  862. <member name="M:DG.Tweening.IDOTweenInit.SetCapacity(System.Int32,System.Int32)">
  863. <summary>
  864. Directly sets the current max capacity of Tweeners and Sequences
  865. (meaning how many Tweeners and Sequences can be running at the same time),
  866. so that DOTween doesn't need to automatically increase them in case the max is reached
  867. (which might lead to hiccups when that happens).
  868. Sequences capacity must be less or equal to Tweeners capacity
  869. (if you pass a low Tweener capacity it will be automatically increased to match the Sequence's).
  870. Beware: use this method only when there are no tweens running.
  871. </summary>
  872. <param name="tweenersCapacity">Max Tweeners capacity.
  873. Default: 200</param>
  874. <param name="sequencesCapacity">Max Sequences capacity.
  875. Default: 50</param>
  876. </member>
  877. <member name="T:DG.Tweening.PathMode">
  878. <summary>
  879. Path mode (used to determine correct LookAt orientation)
  880. </summary>
  881. </member>
  882. <member name="F:DG.Tweening.PathMode.Ignore">
  883. <summary>Ignores the path mode (and thus LookAt behaviour)</summary>
  884. </member>
  885. <member name="F:DG.Tweening.PathMode.Full3D">
  886. <summary>Regular 3D path</summary>
  887. </member>
  888. <member name="F:DG.Tweening.PathMode.TopDown2D">
  889. <summary>2D top-down path</summary>
  890. </member>
  891. <member name="F:DG.Tweening.PathMode.Sidescroller2D">
  892. <summary>2D side-scroller path</summary>
  893. </member>
  894. <member name="T:DG.Tweening.PathType">
  895. <summary>
  896. Type of path to use with DOPath tweens
  897. </summary>
  898. </member>
  899. <member name="F:DG.Tweening.PathType.Linear">
  900. <summary>Linear, composed of straight segments between each waypoint</summary>
  901. </member>
  902. <member name="F:DG.Tweening.PathType.CatmullRom">
  903. <summary>Curved path (which uses Catmull-Rom curves)</summary>
  904. </member>
  905. <member name="T:DG.Tweening.Plugins.Core.PathCore.ControlPoint">
  906. <summary>
  907. Path control point
  908. </summary>
  909. </member>
  910. <member name="M:DG.Tweening.Plugins.Core.PathCore.Path.GetPoint(System.Single,System.Boolean)">
  911. <summary>
  912. Gets the point on the path at the given percentage (0 to 1)
  913. </summary>
  914. <param name="perc">The percentage (0 to 1) at which to get the point</param>
  915. <param name="convertToConstantPerc">If TRUE constant speed is taken into account, otherwise not</param>
  916. </member>
  917. <member name="T:DG.Tweening.Plugins.Options.IPlugOptions">
  918. <summary>
  919. Base interface for all tween plugins options
  920. </summary>
  921. </member>
  922. <member name="M:DG.Tweening.Plugins.Options.IPlugOptions.Reset">
  923. <summary>Resets the plugin</summary>
  924. </member>
  925. <member name="T:DG.Tweening.Plugins.Vector3ArrayPlugin">
  926. <summary>
  927. This plugin generates some GC allocations at startup
  928. </summary>
  929. </member>
  930. <member name="T:DG.Tweening.Plugins.PathPlugin">
  931. <summary>
  932. Path plugin works exclusively with Transforms
  933. </summary>
  934. </member>
  935. <member name="T:DG.Tweening.RotateMode">
  936. <summary>
  937. Rotation mode used with DORotate methods
  938. </summary>
  939. </member>
  940. <member name="F:DG.Tweening.RotateMode.Fast">
  941. <summary>
  942. Fastest way that never rotates beyond 360°
  943. </summary>
  944. </member>
  945. <member name="F:DG.Tweening.RotateMode.FastBeyond360">
  946. <summary>
  947. Fastest way that rotates beyond 360°
  948. </summary>
  949. </member>
  950. <member name="F:DG.Tweening.RotateMode.WorldAxisAdd">
  951. <summary>
  952. Adds the given rotation to the transform using world axis and an advanced precision mode
  953. (like when using transform.Rotate(Space.World)).
  954. <para>In this mode the end value is is always considered relative</para>
  955. </summary>
  956. </member>
  957. <member name="F:DG.Tweening.RotateMode.LocalAxisAdd">
  958. <summary>
  959. Adds the given rotation to the transform's local axis
  960. (like when rotating an object with the "local" switch enabled in Unity's editor or using transform.Rotate(Space.Self)).
  961. <para>In this mode the end value is is always considered relative</para>
  962. </summary>
  963. </member>
  964. <member name="T:DG.Tweening.ScrambleMode">
  965. <summary>
  966. Type of scramble to apply to string tweens
  967. </summary>
  968. </member>
  969. <member name="F:DG.Tweening.ScrambleMode.None">
  970. <summary>
  971. No scrambling of characters
  972. </summary>
  973. </member>
  974. <member name="F:DG.Tweening.ScrambleMode.All">
  975. <summary>
  976. A-Z + a-z + 0-9 characters
  977. </summary>
  978. </member>
  979. <member name="F:DG.Tweening.ScrambleMode.Uppercase">
  980. <summary>
  981. A-Z characters
  982. </summary>
  983. </member>
  984. <member name="F:DG.Tweening.ScrambleMode.Lowercase">
  985. <summary>
  986. a-z characters
  987. </summary>
  988. </member>
  989. <member name="F:DG.Tweening.ScrambleMode.Numerals">
  990. <summary>
  991. 0-9 characters
  992. </summary>
  993. </member>
  994. <member name="F:DG.Tweening.ScrambleMode.Custom">
  995. <summary>
  996. Custom characters
  997. </summary>
  998. </member>
  999. <member name="T:DG.Tweening.TweenExtensions">
  1000. <summary>
  1001. Methods that extend Tween objects and allow to control or get data from them
  1002. </summary>
  1003. </member>
  1004. <member name="M:DG.Tweening.TweenExtensions.Complete(DG.Tweening.Tween)">
  1005. <summary>Completes the tween</summary>
  1006. </member>
  1007. <member name="M:DG.Tweening.TweenExtensions.Complete(DG.Tweening.Tween,System.Boolean)">
  1008. <summary>Completes the tween</summary>
  1009. <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
  1010. otherwise they will be ignored</param>
  1011. </member>
  1012. <member name="M:DG.Tweening.TweenExtensions.Flip(DG.Tweening.Tween)">
  1013. <summary>Flips the direction of this tween (backwards if it was going forward or viceversa)</summary>
  1014. </member>
  1015. <member name="M:DG.Tweening.TweenExtensions.ForceInit(DG.Tweening.Tween)">
  1016. <summary>Forces the tween to initialize its settings immediately</summary>
  1017. </member>
  1018. <member name="M:DG.Tweening.TweenExtensions.Goto(DG.Tweening.Tween,System.Single,System.Boolean)">
  1019. <summary>Send the tween to the given position in time</summary>
  1020. <param name="to">Time position to reach
  1021. (if higher than the whole tween duration the tween will simply reach its end)</param>
  1022. <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
  1023. </member>
  1024. <member name="M:DG.Tweening.TweenExtensions.Kill(DG.Tweening.Tween,System.Boolean)">
  1025. <summary>Kills the tween</summary>
  1026. <param name="complete">If TRUE completes the tween before killing it</param>
  1027. </member>
  1028. <member name="M:DG.Tweening.TweenExtensions.Pause``1(``0)">
  1029. <summary>Pauses the tween</summary>
  1030. </member>
  1031. <member name="M:DG.Tweening.TweenExtensions.Play``1(``0)">
  1032. <summary>Plays the tween</summary>
  1033. </member>
  1034. <member name="M:DG.Tweening.TweenExtensions.PlayBackwards(DG.Tweening.Tween)">
  1035. <summary>Sets the tween in a backwards direction and plays it</summary>
  1036. </member>
  1037. <member name="M:DG.Tweening.TweenExtensions.PlayForward(DG.Tweening.Tween)">
  1038. <summary>Sets the tween in a forward direction and plays it</summary>
  1039. </member>
  1040. <member name="M:DG.Tweening.TweenExtensions.Restart(DG.Tweening.Tween,System.Boolean,System.Single)">
  1041. <summary>Restarts the tween from the beginning</summary>
  1042. <param name="includeDelay">If TRUE includes the eventual tween delay, otherwise skips it</param>
  1043. <param name="changeDelayTo">If >= 0 changes the startup delay to this value, otherwise doesn't touch it</param>
  1044. </member>
  1045. <member name="M:DG.Tweening.TweenExtensions.Rewind(DG.Tweening.Tween,System.Boolean)">
  1046. <summary>Rewinds and pauses the tween</summary>
  1047. <param name="includeDelay">If TRUE includes the eventual tween delay, otherwise skips it</param>
  1048. </member>
  1049. <member name="M:DG.Tweening.TweenExtensions.SmoothRewind(DG.Tweening.Tween)">
  1050. <summary>Smoothly rewinds the tween (delays excluded).
  1051. A "smooth rewind" animates the tween to its start position,
  1052. skipping all elapsed loops (except in case of LoopType.Incremental) while keeping the animation fluent.
  1053. If called on a tween who is still waiting for its delay to happen, it will simply set the delay to 0 and pause the tween.
  1054. <para>Note that a tween that was smoothly rewinded will have its play direction flipped</para></summary>
  1055. </member>
  1056. <member name="M:DG.Tweening.TweenExtensions.TogglePause(DG.Tweening.Tween)">
  1057. <summary>Plays the tween if it was paused, pauses it if it was playing</summary>
  1058. </member>
  1059. <member name="M:DG.Tweening.TweenExtensions.GotoWaypoint(DG.Tweening.Tween,System.Int32,System.Boolean)">
  1060. <summary>Send a path tween to the given waypoint.
  1061. Has no effect if this is not a path tween.
  1062. <para>BEWARE, this is a special utility method:
  1063. it works only with Linear eases. Also, the lookAt direction might be wrong after calling this and might need to be set manually
  1064. (because it relies on a smooth path movement and doesn't work well with jumps that encompass dramatic direction changes)</para></summary>
  1065. <param name="waypointIndex">Waypoint index to reach
  1066. (if higher than the max waypoint index the tween will simply go to the last one)</param>
  1067. <param name="andPlay">If TRUE will play the tween after reaching the given waypoint, otherwise it will pause it</param>
  1068. </member>
  1069. <member name="M:DG.Tweening.TweenExtensions.WaitForCompletion(DG.Tweening.Tween)">
  1070. <summary>
  1071. Creates a yield instruction that waits until the tween is killed or complete.
  1072. It can be used inside a coroutine as a yield.
  1073. <para>Example usage:</para><code>yield return myTween.WaitForCompletion();</code>
  1074. </summary>
  1075. </member>
  1076. <member name="M:DG.Tweening.TweenExtensions.WaitForRewind(DG.Tweening.Tween)">
  1077. <summary>
  1078. Creates a yield instruction that waits until the tween is killed or rewinded.
  1079. It can be used inside a coroutine as a yield.
  1080. <para>Example usage:</para><code>yield return myTween.WaitForRewind();</code>
  1081. </summary>
  1082. </member>
  1083. <member name="M:DG.Tweening.TweenExtensions.WaitForKill(DG.Tweening.Tween)">
  1084. <summary>
  1085. Creates a yield instruction that waits until the tween is killed.
  1086. It can be used inside a coroutine as a yield.
  1087. <para>Example usage:</para><code>yield return myTween.WaitForKill();</code>
  1088. </summary>
  1089. </member>
  1090. <member name="M:DG.Tweening.TweenExtensions.WaitForElapsedLoops(DG.Tweening.Tween,System.Int32)">
  1091. <summary>
  1092. Creates a yield instruction that waits until the tween is killed or has gone through the given amount of loops.
  1093. It can be used inside a coroutine as a yield.
  1094. <para>Example usage:</para><code>yield return myTween.WaitForElapsedLoops(2);</code>
  1095. </summary>
  1096. <param name="elapsedLoops">Elapsed loops to wait for</param>
  1097. </member>
  1098. <member name="M:DG.Tweening.TweenExtensions.WaitForPosition(DG.Tweening.Tween,System.Single)">
  1099. <summary>
  1100. Creates a yield instruction that waits until the tween is killed or has reached the given position (loops included, delays excluded).
  1101. It can be used inside a coroutine as a yield.
  1102. <para>Example usage:</para><code>yield return myTween.WaitForPosition(2.5f);</code>
  1103. </summary>
  1104. <param name="position">Position (loops included, delays excluded) to wait for</param>
  1105. </member>
  1106. <member name="M:DG.Tweening.TweenExtensions.WaitForStart(DG.Tweening.Tween)">
  1107. <summary>
  1108. Creates a yield instruction that waits until the tween is killed or started
  1109. (meaning when the tween is set in a playing state the first time, after any eventual delay).
  1110. It can be used inside a coroutine as a yield.
  1111. <para>Example usage:</para><code>yield return myTween.WaitForStart();</code>
  1112. </summary>
  1113. </member>
  1114. <member name="M:DG.Tweening.TweenExtensions.CompletedLoops(DG.Tweening.Tween)">
  1115. <summary>Returns the total number of loops completed by this tween</summary>
  1116. </member>
  1117. <member name="M:DG.Tweening.TweenExtensions.Delay(DG.Tweening.Tween)">
  1118. <summary>Returns the eventual delay set for this tween</summary>
  1119. </member>
  1120. <member name="M:DG.Tweening.TweenExtensions.Duration(DG.Tweening.Tween,System.Boolean)">
  1121. <summary>Returns the duration of this tween (delays excluded).
  1122. <para>NOTE: when using settings like SpeedBased, the duration will be recalculated when the tween starts</para></summary>
  1123. <param name="includeLoops">If TRUE returns the full duration loops included,
  1124. otherwise the duration of a single loop cycle</param>
  1125. </member>
  1126. <member name="M:DG.Tweening.TweenExtensions.Elapsed(DG.Tweening.Tween,System.Boolean)">
  1127. <summary>Returns the elapsed time for this tween (delays exluded)</summary>
  1128. <param name="includeLoops">If TRUE returns the elapsed time since startup loops included,
  1129. otherwise the elapsed time within the current loop cycle</param>
  1130. </member>
  1131. <member name="M:DG.Tweening.TweenExtensions.ElapsedPercentage(DG.Tweening.Tween,System.Boolean)">
  1132. <summary>Returns the elapsed percentage (0 to 1) of this tween (delays exluded)</summary>
  1133. <param name="includeLoops">If TRUE returns the elapsed percentage since startup loops included,
  1134. otherwise the elapsed percentage within the current loop cycle</param>
  1135. </member>
  1136. <member name="M:DG.Tweening.TweenExtensions.ElapsedDirectionalPercentage(DG.Tweening.Tween)">
  1137. <summary>Returns the elapsed percentage (0 to 1) of this tween (delays exluded),
  1138. based on a single loop, and calculating eventual backwards Yoyo loops as 1 to 0 instead of 0 to 1</summary>
  1139. </member>
  1140. <member name="M:DG.Tweening.TweenExtensions.IsActive(DG.Tweening.Tween)">
  1141. <summary>Returns FALSE if this tween has been killed.
  1142. <para>BEWARE: if this tween is recyclable it might have been spawned again for another use and thus return TRUE anyway.</para>
  1143. When working with recyclable tweens you should take care to know when a tween has been killed and manually set your references to NULL.
  1144. If you want to be sure your references are set to NULL when a tween is killed you can use the <code>OnKill</code> callback like this:
  1145. <para><code>.OnKill(()=> myTweenReference = null)</code></para></summary>
  1146. </member>
  1147. <member name="M:DG.Tweening.TweenExtensions.IsBackwards(DG.Tweening.Tween)">
  1148. <summary>Returns TRUE if this tween was reversed and is set to go backwards</summary>
  1149. </member>
  1150. <member name="M:DG.Tweening.TweenExtensions.IsComplete(DG.Tweening.Tween)">
  1151. <summary>Returns TRUE if the tween is complete
  1152. (silently fails and returns FALSE if the tween has been killed)</summary>
  1153. </member>
  1154. <member name="M:DG.Tweening.TweenExtensions.IsInitialized(DG.Tweening.Tween)">
  1155. <summary>Returns TRUE if this tween has been initialized</summary>
  1156. </member>
  1157. <member name="M:DG.Tweening.TweenExtensions.IsPlaying(DG.Tweening.Tween)">
  1158. <summary>Returns TRUE if this tween is playing</summary>
  1159. </member>
  1160. <member name="M:DG.Tweening.TweenExtensions.Loops(DG.Tweening.Tween)">
  1161. <summary>Returns the total number of loops set for this tween
  1162. (returns -1 if the loops are infinite)</summary>
  1163. </member>
  1164. <member name="M:DG.Tweening.TweenExtensions.PathGetPoint(DG.Tweening.Tween,System.Single)">
  1165. <summary>
  1166. Returns a point on a path based on the given path percentage.
  1167. Returns <code>Vector3.zero</code> if this is not a path tween, if the tween is invalid, or if the path is not yet initialized.
  1168. A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature).
  1169. You can force a path to be initialized by calling <code>myTween.ForceInit()</code>.
  1170. </summary>
  1171. <param name="pathPercentage">Percentage of the path (0 to 1) on which to get the point</param>
  1172. </member>
  1173. <member name="M:DG.Tweening.TweenExtensions.PathGetDrawPoints(DG.Tweening.Tween,System.Int32)">
  1174. <summary>
  1175. Returns an array of points that can be used to draw the path.
  1176. Note that this method generates allocations, because it creates a new array.
  1177. Returns <code>NULL</code> if this is not a path tween, if the tween is invalid, or if the path is not yet initialized.
  1178. A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature).
  1179. You can force a path to be initialized by calling <code>myTween.ForceInit()</code>.
  1180. </summary>
  1181. <param name="subdivisionsXSegment">How many points to create for each path segment (waypoint to waypoint).
  1182. Only used in case of non-Linear paths</param>
  1183. </member>
  1184. <member name="M:DG.Tweening.TweenExtensions.PathLength(DG.Tweening.Tween)">
  1185. <summary>
  1186. Returns the length of a path.
  1187. Returns -1 if this is not a path tween, if the tween is invalid, or if the path is not yet initialized.
  1188. A path is initialized after its tween starts, or immediately if the tween was created with the Path Editor (DOTween Pro feature).
  1189. You can force a path to be initialized by calling <code>myTween.ForceInit()</code>.
  1190. </summary>
  1191. </member>
  1192. <member name="T:DG.Tweening.LoopType">
  1193. <summary>
  1194. Types of loop
  1195. </summary>
  1196. </member>
  1197. <member name="F:DG.Tweening.LoopType.Restart">
  1198. <summary>Each loop cycle restarts from the beginning</summary>
  1199. </member>
  1200. <member name="F:DG.Tweening.LoopType.Yoyo">
  1201. <summary>The tween moves forward and backwards at alternate cycles</summary>
  1202. </member>
  1203. <member name="F:DG.Tweening.LoopType.Incremental">
  1204. <summary>Continuously increments the tween at the end of each loop cycle (A to B, B to B+(A-B), and so on), thus always moving "onward".
  1205. <para>In case of String tweens works only if the tween is set as relative</para></summary>
  1206. </member>
  1207. <member name="T:DG.Tweening.Sequence">
  1208. <summary>
  1209. Controls other tweens as a group
  1210. </summary>
  1211. </member>
  1212. <member name="T:DG.Tweening.ShortcutExtensions">
  1213. <summary>
  1214. Methods that extend known Unity objects and allow to directly create and control tweens from their instances
  1215. </summary>
  1216. </member>
  1217. <member name="M:DG.Tweening.ShortcutExtensions.DOFade(UnityEngine.AudioSource,System.Single,System.Single)">
  1218. <summary>Tweens an AudioSource's volume to the given value.
  1219. Also stores the AudioSource as the tween's target so it can be used for filtered operations</summary>
  1220. <param name="endValue">The end value to reach (0 to 1)</param><param name="duration">The duration of the tween</param>
  1221. </member>
  1222. <member name="M:DG.Tweening.ShortcutExtensions.DOPitch(UnityEngine.AudioSource,System.Single,System.Single)">
  1223. <summary>Tweens an AudioSource's pitch to the given value.
  1224. Also stores the AudioSource as the tween's target so it can be used for filtered operations</summary>
  1225. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1226. </member>
  1227. <member name="M:DG.Tweening.ShortcutExtensions.DOAspect(UnityEngine.Camera,System.Single,System.Single)">
  1228. <summary>Tweens a Camera's <code>aspect</code> to the given value.
  1229. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1230. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1231. </member>
  1232. <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Camera,UnityEngine.Color,System.Single)">
  1233. <summary>Tweens a Camera's backgroundColor to the given value.
  1234. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1235. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1236. </member>
  1237. <member name="M:DG.Tweening.ShortcutExtensions.DOFarClipPlane(UnityEngine.Camera,System.Single,System.Single)">
  1238. <summary>Tweens a Camera's <code>farClipPlane</code> to the given value.
  1239. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1240. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1241. </member>
  1242. <member name="M:DG.Tweening.ShortcutExtensions.DOFieldOfView(UnityEngine.Camera,System.Single,System.Single)">
  1243. <summary>Tweens a Camera's <code>fieldOfView</code> to the given value.
  1244. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1245. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1246. </member>
  1247. <member name="M:DG.Tweening.ShortcutExtensions.DONearClipPlane(UnityEngine.Camera,System.Single,System.Single)">
  1248. <summary>Tweens a Camera's <code>nearClipPlane</code> to the given value.
  1249. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1250. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1251. </member>
  1252. <member name="M:DG.Tweening.ShortcutExtensions.DOOrthoSize(UnityEngine.Camera,System.Single,System.Single)">
  1253. <summary>Tweens a Camera's <code>orthographicSize</code> to the given value.
  1254. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1255. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1256. </member>
  1257. <member name="M:DG.Tweening.ShortcutExtensions.DOPixelRect(UnityEngine.Camera,UnityEngine.Rect,System.Single)">
  1258. <summary>Tweens a Camera's <code>pixelRect</code> to the given value.
  1259. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1260. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1261. </member>
  1262. <member name="M:DG.Tweening.ShortcutExtensions.DORect(UnityEngine.Camera,UnityEngine.Rect,System.Single)">
  1263. <summary>Tweens a Camera's <code>rect</code> to the given value.
  1264. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1265. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1266. </member>
  1267. <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Camera,System.Single,System.Single,System.Int32,System.Single,System.Boolean)">
  1268. <summary>Shakes a Camera's localPosition along its relative X Y axes with the given values.
  1269. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1270. <param name="duration">The duration of the tween</param>
  1271. <param name="strength">The shake strength</param>
  1272. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1273. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1274. Setting it to 0 will shake along a single direction.</param>
  1275. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1276. </member>
  1277. <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Camera,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean)">
  1278. <summary>Shakes a Camera's localPosition along its relative X Y axes with the given values.
  1279. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1280. <param name="duration">The duration of the tween</param>
  1281. <param name="strength">The shake strength on each axis</param>
  1282. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1283. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1284. Setting it to 0 will shake along a single direction.</param>
  1285. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1286. </member>
  1287. <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Camera,System.Single,System.Single,System.Int32,System.Single,System.Boolean)">
  1288. <summary>Shakes a Camera's localRotation.
  1289. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1290. <param name="duration">The duration of the tween</param>
  1291. <param name="strength">The shake strength</param>
  1292. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1293. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1294. Setting it to 0 will shake along a single direction.</param>
  1295. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1296. </member>
  1297. <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Camera,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean)">
  1298. <summary>Shakes a Camera's localRotation.
  1299. Also stores the camera as the tween's target so it can be used for filtered operations</summary>
  1300. <param name="duration">The duration of the tween</param>
  1301. <param name="strength">The shake strength on each axis</param>
  1302. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1303. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1304. Setting it to 0 will shake along a single direction.</param>
  1305. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1306. </member>
  1307. <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Light,UnityEngine.Color,System.Single)">
  1308. <summary>Tweens a Light's color to the given value.
  1309. Also stores the light as the tween's target so it can be used for filtered operations</summary>
  1310. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1311. </member>
  1312. <member name="M:DG.Tweening.ShortcutExtensions.DOIntensity(UnityEngine.Light,System.Single,System.Single)">
  1313. <summary>Tweens a Light's intensity to the given value.
  1314. Also stores the light as the tween's target so it can be used for filtered operations</summary>
  1315. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1316. </member>
  1317. <member name="M:DG.Tweening.ShortcutExtensions.DOShadowStrength(UnityEngine.Light,System.Single,System.Single)">
  1318. <summary>Tweens a Light's shadowStrength to the given value.
  1319. Also stores the light as the tween's target so it can be used for filtered operations</summary>
  1320. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1321. </member>
  1322. <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.LineRenderer,DG.Tweening.Color2,DG.Tweening.Color2,System.Single)">
  1323. <summary>Tweens a LineRenderer's color to the given value.
  1324. Also stores the LineRenderer as the tween's target so it can be used for filtered operations.
  1325. <para>Note that this method requires to also insert the start colors for the tween,
  1326. since LineRenderers have no way to get them.</para></summary>
  1327. <param name="startValue">The start value to tween from</param>
  1328. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1329. </member>
  1330. <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Material,UnityEngine.Color,System.Single)">
  1331. <summary>Tweens a Material's color to the given value.
  1332. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1333. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1334. </member>
  1335. <member name="M:DG.Tweening.ShortcutExtensions.DOColor(UnityEngine.Material,UnityEngine.Color,System.String,System.Single)">
  1336. <summary>Tweens a Material's named color property to the given value.
  1337. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1338. <param name="endValue">The end value to reach</param>
  1339. <param name="property">The name of the material property to tween (like _Tint or _SpecColor)</param>
  1340. <param name="duration">The duration of the tween</param>
  1341. </member>
  1342. <member name="M:DG.Tweening.ShortcutExtensions.DOFade(UnityEngine.Material,System.Single,System.Single)">
  1343. <summary>Tweens a Material's alpha color to the given value
  1344. (will have no effect unless your material supports transparency).
  1345. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1346. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1347. </member>
  1348. <member name="M:DG.Tweening.ShortcutExtensions.DOFade(UnityEngine.Material,System.Single,System.String,System.Single)">
  1349. <summary>Tweens a Material's alpha color to the given value
  1350. (will have no effect unless your material supports transparency).
  1351. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1352. <param name="endValue">The end value to reach</param>
  1353. <param name="property">The name of the material property to tween (like _Tint or _SpecColor)</param>
  1354. <param name="duration">The duration of the tween</param>
  1355. </member>
  1356. <member name="M:DG.Tweening.ShortcutExtensions.DOFloat(UnityEngine.Material,System.Single,System.String,System.Single)">
  1357. <summary>Tweens a Material's named float property to the given value.
  1358. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1359. <param name="endValue">The end value to reach</param>
  1360. <param name="property">The name of the material property to tween</param>
  1361. <param name="duration">The duration of the tween</param>
  1362. </member>
  1363. <member name="M:DG.Tweening.ShortcutExtensions.DOOffset(UnityEngine.Material,UnityEngine.Vector2,System.Single)">
  1364. <summary>Tweens a Material's texture offset to the given value.
  1365. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1366. <param name="endValue">The end value to reach</param>
  1367. <param name="duration">The duration of the tween</param>
  1368. </member>
  1369. <member name="M:DG.Tweening.ShortcutExtensions.DOOffset(UnityEngine.Material,UnityEngine.Vector2,System.String,System.Single)">
  1370. <summary>Tweens a Material's named texture offset property to the given value.
  1371. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1372. <param name="endValue">The end value to reach</param>
  1373. <param name="property">The name of the material property to tween</param>
  1374. <param name="duration">The duration of the tween</param>
  1375. </member>
  1376. <member name="M:DG.Tweening.ShortcutExtensions.DOTiling(UnityEngine.Material,UnityEngine.Vector2,System.Single)">
  1377. <summary>Tweens a Material's texture scale to the given value.
  1378. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1379. <param name="endValue">The end value to reach</param>
  1380. <param name="duration">The duration of the tween</param>
  1381. </member>
  1382. <member name="M:DG.Tweening.ShortcutExtensions.DOTiling(UnityEngine.Material,UnityEngine.Vector2,System.String,System.Single)">
  1383. <summary>Tweens a Material's named texture scale property to the given value.
  1384. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1385. <param name="endValue">The end value to reach</param>
  1386. <param name="property">The name of the material property to tween</param>
  1387. <param name="duration">The duration of the tween</param>
  1388. </member>
  1389. <member name="M:DG.Tweening.ShortcutExtensions.DOVector(UnityEngine.Material,UnityEngine.Vector4,System.String,System.Single)">
  1390. <summary>Tweens a Material's named Vector property to the given value.
  1391. Also stores the material as the tween's target so it can be used for filtered operations</summary>
  1392. <param name="endValue">The end value to reach</param>
  1393. <param name="property">The name of the material property to tween</param>
  1394. <param name="duration">The duration of the tween</param>
  1395. </member>
  1396. <member name="M:DG.Tweening.ShortcutExtensions.DOMove(UnityEngine.Rigidbody,UnityEngine.Vector3,System.Single,System.Boolean)">
  1397. <summary>Tweens a Rigidbody's position to the given value.
  1398. Also stores the rigidbody as the tween's target so it can be used for filtered operations</summary>
  1399. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1400. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1401. </member>
  1402. <member name="M:DG.Tweening.ShortcutExtensions.DOMoveX(UnityEngine.Rigidbody,System.Single,System.Single,System.Boolean)">
  1403. <summary>Tweens a Rigidbody's X position to the given value.
  1404. Also stores the rigidbody as the tween's target so it can be used for filtered operations</summary>
  1405. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1406. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1407. </member>
  1408. <member name="M:DG.Tweening.ShortcutExtensions.DOMoveY(UnityEngine.Rigidbody,System.Single,System.Single,System.Boolean)">
  1409. <summary>Tweens a Rigidbody's Y position to the given value.
  1410. Also stores the rigidbody as the tween's target so it can be used for filtered operations</summary>
  1411. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1412. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1413. </member>
  1414. <member name="M:DG.Tweening.ShortcutExtensions.DOMoveZ(UnityEngine.Rigidbody,System.Single,System.Single,System.Boolean)">
  1415. <summary>Tweens a Rigidbody's Z position to the given value.
  1416. Also stores the rigidbody as the tween's target so it can be used for filtered operations</summary>
  1417. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1418. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1419. </member>
  1420. <member name="M:DG.Tweening.ShortcutExtensions.DORotate(UnityEngine.Rigidbody,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
  1421. <summary>Tweens a Rigidbody's rotation to the given value.
  1422. Also stores the rigidbody as the tween's target so it can be used for filtered operations</summary>
  1423. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1424. <param name="mode">Rotation mode</param>
  1425. </member>
  1426. <member name="M:DG.Tweening.ShortcutExtensions.DOLookAt(UnityEngine.Rigidbody,UnityEngine.Vector3,System.Single,DG.Tweening.AxisConstraint,System.Nullable{UnityEngine.Vector3})">
  1427. <summary>Tweens a Rigidbody's rotation so that it will look towards the given position.
  1428. Also stores the rigidbody as the tween's target so it can be used for filtered operations</summary>
  1429. <param name="towards">The position to look at</param><param name="duration">The duration of the tween</param>
  1430. <param name="axisConstraint">Eventual axis constraint for the rotation</param>
  1431. <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
  1432. </member>
  1433. <member name="M:DG.Tweening.ShortcutExtensions.DOJump(UnityEngine.Rigidbody,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
  1434. <summary>Tweens a Rigidbody's position to the given value, while also applying a jump effect along the Y axis.
  1435. Returns a Sequence instead of a Tweener.
  1436. Also stores the Rigidbody as the tween's target so it can be used for filtered operations</summary>
  1437. <param name="endValue">The end value to reach</param>
  1438. <param name="jumpPower">Power of the jump (the max height of the jump is represented by this plus the final Y offset)</param>
  1439. <param name="numJumps">Total number of jumps</param>
  1440. <param name="duration">The duration of the tween</param>
  1441. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1442. </member>
  1443. <member name="M:DG.Tweening.ShortcutExtensions.DOPath(UnityEngine.Rigidbody,UnityEngine.Vector3[],System.Single,DG.Tweening.PathType,DG.Tweening.PathMode,System.Int32,System.Nullable{UnityEngine.Color})">
  1444. <summary>Tweens a Rigidbody's position through the given path waypoints, using the chosen path algorithm.
  1445. Also stores the Rigidbody as the tween's target so it can be used for filtered operations.
  1446. <para>NOTE: to tween a rigidbody correctly it should be set to kinematic at least while being tweened.</para>
  1447. <para>BEWARE: doesn't work on Windows Phone store (waiting for Unity to fix their own bug).
  1448. If you plan to publish there you should use a regular transform.DOPath.</para></summary>
  1449. <param name="path">The waypoints to go through</param>
  1450. <param name="duration">The duration of the tween</param>
  1451. <param name="pathType">The type of path: Linear (straight path) or CatmullRom (curved CatmullRom path)</param>
  1452. <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
  1453. <param name="resolution">The resolution of the path (useless in case of Linear paths): higher resolutions make for more detailed curved paths but are more expensive.
  1454. Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints</param>
  1455. <param name="gizmoColor">The color of the path (shown when gizmos are active in the Play panel and the tween is running)</param>
  1456. </member>
  1457. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalPath(UnityEngine.Rigidbody,UnityEngine.Vector3[],System.Single,DG.Tweening.PathType,DG.Tweening.PathMode,System.Int32,System.Nullable{UnityEngine.Color})">
  1458. <summary>Tweens a Rigidbody's localPosition through the given path waypoints, using the chosen path algorithm.
  1459. Also stores the Rigidbody as the tween's target so it can be used for filtered operations
  1460. <para>NOTE: to tween a rigidbody correctly it should be set to kinematic at least while being tweened.</para>
  1461. <para>BEWARE: doesn't work on Windows Phone store (waiting for Unity to fix their own bug).
  1462. If you plan to publish there you should use a regular transform.DOLocalPath.</para></summary>
  1463. <param name="path">The waypoint to go through</param>
  1464. <param name="duration">The duration of the tween</param>
  1465. <param name="pathType">The type of path: Linear (straight path) or CatmullRom (curved CatmullRom path)</param>
  1466. <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
  1467. <param name="resolution">The resolution of the path: higher resolutions make for more detailed curved paths but are more expensive.
  1468. Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints</param>
  1469. <param name="gizmoColor">The color of the path (shown when gizmos are active in the Play panel and the tween is running)</param>
  1470. </member>
  1471. <member name="M:DG.Tweening.ShortcutExtensions.DOResize(UnityEngine.TrailRenderer,System.Single,System.Single,System.Single)">
  1472. <summary>Tweens a TrailRenderer's startWidth/endWidth to the given value.
  1473. Also stores the TrailRenderer as the tween's target so it can be used for filtered operations</summary>
  1474. <param name="toStartWidth">The end startWidth to reach</param><param name="toEndWidth">The end endWidth to reach</param>
  1475. <param name="duration">The duration of the tween</param>
  1476. </member>
  1477. <member name="M:DG.Tweening.ShortcutExtensions.DOTime(UnityEngine.TrailRenderer,System.Single,System.Single)">
  1478. <summary>Tweens a TrailRenderer's time to the given value.
  1479. Also stores the TrailRenderer as the tween's target so it can be used for filtered operations</summary>
  1480. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1481. </member>
  1482. <member name="M:DG.Tweening.ShortcutExtensions.DOMove(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
  1483. <summary>Tweens a Transform's position to the given value.
  1484. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1485. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1486. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1487. </member>
  1488. <member name="M:DG.Tweening.ShortcutExtensions.DOMoveX(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
  1489. <summary>Tweens a Transform's X position to the given value.
  1490. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1491. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1492. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1493. </member>
  1494. <member name="M:DG.Tweening.ShortcutExtensions.DOMoveY(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
  1495. <summary>Tweens a Transform's Y position to the given value.
  1496. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1497. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1498. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1499. </member>
  1500. <member name="M:DG.Tweening.ShortcutExtensions.DOMoveZ(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
  1501. <summary>Tweens a Transform's Z position to the given value.
  1502. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1503. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1504. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1505. </member>
  1506. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMove(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
  1507. <summary>Tweens a Transform's localPosition to the given value.
  1508. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1509. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1510. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1511. </member>
  1512. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMoveX(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
  1513. <summary>Tweens a Transform's X localPosition to the given value.
  1514. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1515. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1516. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1517. </member>
  1518. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMoveY(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
  1519. <summary>Tweens a Transform's Y localPosition to the given value.
  1520. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1521. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1522. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1523. </member>
  1524. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalMoveZ(UnityEngine.Transform,System.Single,System.Single,System.Boolean)">
  1525. <summary>Tweens a Transform's Z localPosition to the given value.
  1526. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1527. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1528. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1529. </member>
  1530. <member name="M:DG.Tweening.ShortcutExtensions.DORotate(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
  1531. <summary>Tweens a Transform's rotation to the given value.
  1532. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1533. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1534. <param name="mode">Rotation mode</param>
  1535. </member>
  1536. <member name="M:DG.Tweening.ShortcutExtensions.DORotateQuaternion(UnityEngine.Transform,UnityEngine.Quaternion,System.Single)">
  1537. <summary>Tweens a Transform's rotation to the given value using pure quaternion values.
  1538. Also stores the transform as the tween's target so it can be used for filtered operations.
  1539. <para>PLEASE NOTE: DORotate, which takes Vector3 values, is the preferred rotation method.
  1540. This method was implemented for very special cases, and doesn't support LoopType.Incremental loops
  1541. (neither for itself nor if placed inside a LoopType.Incremental Sequence)</para>
  1542. </summary>
  1543. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1544. </member>
  1545. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalRotate(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
  1546. <summary>Tweens a Transform's localRotation to the given value.
  1547. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1548. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1549. <param name="mode">Rotation mode</param>
  1550. </member>
  1551. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalRotateQuaternion(UnityEngine.Transform,UnityEngine.Quaternion,System.Single)">
  1552. <summary>Tweens a Transform's rotation to the given value using pure quaternion values.
  1553. Also stores the transform as the tween's target so it can be used for filtered operations.
  1554. <para>PLEASE NOTE: DOLocalRotate, which takes Vector3 values, is the preferred rotation method.
  1555. This method was implemented for very special cases, and doesn't support LoopType.Incremental loops
  1556. (neither for itself nor if placed inside a LoopType.Incremental Sequence)</para>
  1557. </summary>
  1558. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1559. </member>
  1560. <member name="M:DG.Tweening.ShortcutExtensions.DOScale(UnityEngine.Transform,UnityEngine.Vector3,System.Single)">
  1561. <summary>Tweens a Transform's localScale to the given value.
  1562. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1563. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1564. </member>
  1565. <member name="M:DG.Tweening.ShortcutExtensions.DOScale(UnityEngine.Transform,System.Single,System.Single)">
  1566. <summary>Tweens a Transform's localScale uniformly to the given value.
  1567. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1568. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1569. </member>
  1570. <member name="M:DG.Tweening.ShortcutExtensions.DOScaleX(UnityEngine.Transform,System.Single,System.Single)">
  1571. <summary>Tweens a Transform's X localScale to the given value.
  1572. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1573. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1574. </member>
  1575. <member name="M:DG.Tweening.ShortcutExtensions.DOScaleY(UnityEngine.Transform,System.Single,System.Single)">
  1576. <summary>Tweens a Transform's Y localScale to the given value.
  1577. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1578. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1579. </member>
  1580. <member name="M:DG.Tweening.ShortcutExtensions.DOScaleZ(UnityEngine.Transform,System.Single,System.Single)">
  1581. <summary>Tweens a Transform's Z localScale to the given value.
  1582. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1583. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1584. </member>
  1585. <member name="M:DG.Tweening.ShortcutExtensions.DOLookAt(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.AxisConstraint,System.Nullable{UnityEngine.Vector3})">
  1586. <summary>Tweens a Transform's rotation so that it will look towards the given position.
  1587. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1588. <param name="towards">The position to look at</param><param name="duration">The duration of the tween</param>
  1589. <param name="axisConstraint">Eventual axis constraint for the rotation</param>
  1590. <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
  1591. </member>
  1592. <member name="M:DG.Tweening.ShortcutExtensions.DOPunchPosition(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
  1593. <summary>Punches a Transform's localPosition towards the given direction and then back to the starting one
  1594. as if it was connected to the starting position via an elastic.</summary>
  1595. <param name="punch">The direction and strength of the punch (added to the Transform's current position)</param>
  1596. <param name="duration">The duration of the tween</param>
  1597. <param name="vibrato">Indicates how much will the punch vibrate</param>
  1598. <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting position when bouncing backwards.
  1599. 1 creates a full oscillation between the punch direction and the opposite direction,
  1600. while 0 oscillates only between the punch and the start position</param>
  1601. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1602. </member>
  1603. <member name="M:DG.Tweening.ShortcutExtensions.DOPunchScale(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
  1604. <summary>Punches a Transform's localScale towards the given size and then back to the starting one
  1605. as if it was connected to the starting scale via an elastic.</summary>
  1606. <param name="punch">The punch strength (added to the Transform's current scale)</param>
  1607. <param name="duration">The duration of the tween</param>
  1608. <param name="vibrato">Indicates how much will the punch vibrate</param>
  1609. <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting size when bouncing backwards.
  1610. 1 creates a full oscillation between the punch scale and the opposite scale,
  1611. while 0 oscillates only between the punch scale and the start scale</param>
  1612. </member>
  1613. <member name="M:DG.Tweening.ShortcutExtensions.DOPunchRotation(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single)">
  1614. <summary>Punches a Transform's localRotation towards the given size and then back to the starting one
  1615. as if it was connected to the starting rotation via an elastic.</summary>
  1616. <param name="punch">The punch strength (added to the Transform's current rotation)</param>
  1617. <param name="duration">The duration of the tween</param>
  1618. <param name="vibrato">Indicates how much will the punch vibrate</param>
  1619. <param name="elasticity">Represents how much (0 to 1) the vector will go beyond the starting rotation when bouncing backwards.
  1620. 1 creates a full oscillation between the punch rotation and the opposite rotation,
  1621. while 0 oscillates only between the punch and the start rotation</param>
  1622. </member>
  1623. <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Transform,System.Single,System.Single,System.Int32,System.Single,System.Boolean,System.Boolean)">
  1624. <summary>Shakes a Transform's localPosition with the given values.</summary>
  1625. <param name="duration">The duration of the tween</param>
  1626. <param name="strength">The shake strength</param>
  1627. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1628. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1629. Setting it to 0 will shake along a single direction.</param>
  1630. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1631. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1632. </member>
  1633. <member name="M:DG.Tweening.ShortcutExtensions.DOShakePosition(UnityEngine.Transform,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean,System.Boolean)">
  1634. <summary>Shakes a Transform's localPosition with the given values.</summary>
  1635. <param name="duration">The duration of the tween</param>
  1636. <param name="strength">The shake strength on each axis</param>
  1637. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1638. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1639. Setting it to 0 will shake along a single direction.</param>
  1640. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1641. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1642. </member>
  1643. <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Transform,System.Single,System.Single,System.Int32,System.Single,System.Boolean)">
  1644. <summary>Shakes a Transform's localRotation.</summary>
  1645. <param name="duration">The duration of the tween</param>
  1646. <param name="strength">The shake strength</param>
  1647. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1648. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1649. Setting it to 0 will shake along a single direction.</param>
  1650. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1651. </member>
  1652. <member name="M:DG.Tweening.ShortcutExtensions.DOShakeRotation(UnityEngine.Transform,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean)">
  1653. <summary>Shakes a Transform's localRotation.</summary>
  1654. <param name="duration">The duration of the tween</param>
  1655. <param name="strength">The shake strength on each axis</param>
  1656. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1657. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1658. Setting it to 0 will shake along a single direction.</param>
  1659. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1660. </member>
  1661. <member name="M:DG.Tweening.ShortcutExtensions.DOShakeScale(UnityEngine.Transform,System.Single,System.Single,System.Int32,System.Single,System.Boolean)">
  1662. <summary>Shakes a Transform's localScale.</summary>
  1663. <param name="duration">The duration of the tween</param>
  1664. <param name="strength">The shake strength</param>
  1665. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1666. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1667. Setting it to 0 will shake along a single direction.</param>
  1668. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1669. </member>
  1670. <member name="M:DG.Tweening.ShortcutExtensions.DOShakeScale(UnityEngine.Transform,System.Single,UnityEngine.Vector3,System.Int32,System.Single,System.Boolean)">
  1671. <summary>Shakes a Transform's localScale.</summary>
  1672. <param name="duration">The duration of the tween</param>
  1673. <param name="strength">The shake strength on each axis</param>
  1674. <param name="vibrato">Indicates how much will the shake vibrate</param>
  1675. <param name="randomness">Indicates how much the shake will be random (0 to 180 - values higher than 90 kind of suck, so beware).
  1676. Setting it to 0 will shake along a single direction.</param>
  1677. <param name="fadeOut">If TRUE the shake will automatically fadeOut smoothly within the tween's duration, otherwise it will not</param>
  1678. </member>
  1679. <member name="M:DG.Tweening.ShortcutExtensions.DOJump(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
  1680. <summary>Tweens a Transform's position to the given value, while also applying a jump effect along the Y axis.
  1681. Returns a Sequence instead of a Tweener.
  1682. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1683. <param name="endValue">The end value to reach</param>
  1684. <param name="jumpPower">Power of the jump (the max height of the jump is represented by this plus the final Y offset)</param>
  1685. <param name="numJumps">Total number of jumps</param>
  1686. <param name="duration">The duration of the tween</param>
  1687. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1688. </member>
  1689. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalJump(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Int32,System.Single,System.Boolean)">
  1690. <summary>Tweens a Transform's localPosition to the given value, while also applying a jump effect along the Y axis.
  1691. Returns a Sequence instead of a Tweener.
  1692. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1693. <param name="endValue">The end value to reach</param>
  1694. <param name="jumpPower">Power of the jump (the max height of the jump is represented by this plus the final Y offset)</param>
  1695. <param name="numJumps">Total number of jumps</param>
  1696. <param name="duration">The duration of the tween</param>
  1697. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1698. </member>
  1699. <member name="M:DG.Tweening.ShortcutExtensions.DOPath(UnityEngine.Transform,UnityEngine.Vector3[],System.Single,DG.Tweening.PathType,DG.Tweening.PathMode,System.Int32,System.Nullable{UnityEngine.Color})">
  1700. <summary>Tweens a Transform's position through the given path waypoints, using the chosen path algorithm.
  1701. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1702. <param name="path">The waypoints to go through</param>
  1703. <param name="duration">The duration of the tween</param>
  1704. <param name="pathType">The type of path: Linear (straight path) or CatmullRom (curved CatmullRom path)</param>
  1705. <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
  1706. <param name="resolution">The resolution of the path (useless in case of Linear paths): higher resolutions make for more detailed curved paths but are more expensive.
  1707. Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints</param>
  1708. <param name="gizmoColor">The color of the path (shown when gizmos are active in the Play panel and the tween is running)</param>
  1709. </member>
  1710. <member name="M:DG.Tweening.ShortcutExtensions.DOLocalPath(UnityEngine.Transform,UnityEngine.Vector3[],System.Single,DG.Tweening.PathType,DG.Tweening.PathMode,System.Int32,System.Nullable{UnityEngine.Color})">
  1711. <summary>Tweens a Transform's localPosition through the given path waypoints, using the chosen path algorithm.
  1712. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1713. <param name="path">The waypoint to go through</param>
  1714. <param name="duration">The duration of the tween</param>
  1715. <param name="pathType">The type of path: Linear (straight path) or CatmullRom (curved CatmullRom path)</param>
  1716. <param name="pathMode">The path mode: 3D, side-scroller 2D, top-down 2D</param>
  1717. <param name="resolution">The resolution of the path: higher resolutions make for more detailed curved paths but are more expensive.
  1718. Defaults to 10, but a value of 5 is usually enough if you don't have dramatic long curves between waypoints</param>
  1719. <param name="gizmoColor">The color of the path (shown when gizmos are active in the Play panel and the tween is running)</param>
  1720. </member>
  1721. <member name="M:DG.Tweening.ShortcutExtensions.DOTimeScale(DG.Tweening.Tween,System.Single,System.Single)">
  1722. <summary>Tweens a Tween's timeScale to the given value.
  1723. Also stores the Tween as the tween's target so it can be used for filtered operations</summary>
  1724. <param name="endValue">The end value to reach</param><param name="duration">The duration of the tween</param>
  1725. </member>
  1726. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Light,UnityEngine.Color,System.Single)">
  1727. <summary>Tweens a Light's color to the given value,
  1728. in a way that allows other DOBlendableColor tweens to work together on the same target,
  1729. instead than fight each other as multiple DOColor would do.
  1730. Also stores the Light as the tween's target so it can be used for filtered operations</summary>
  1731. <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
  1732. </member>
  1733. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Material,UnityEngine.Color,System.Single)">
  1734. <summary>Tweens a Material's color to the given value,
  1735. in a way that allows other DOBlendableColor tweens to work together on the same target,
  1736. instead than fight each other as multiple DOColor would do.
  1737. Also stores the Material as the tween's target so it can be used for filtered operations</summary>
  1738. <param name="endValue">The value to tween to</param><param name="duration">The duration of the tween</param>
  1739. </member>
  1740. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableColor(UnityEngine.Material,UnityEngine.Color,System.String,System.Single)">
  1741. <summary>Tweens a Material's named color property to the given value,
  1742. in a way that allows other DOBlendableColor tweens to work together on the same target,
  1743. instead than fight each other as multiple DOColor would do.
  1744. Also stores the Material as the tween's target so it can be used for filtered operations</summary>
  1745. <param name="endValue">The value to tween to</param>
  1746. <param name="property">The name of the material property to tween (like _Tint or _SpecColor)</param>
  1747. <param name="duration">The duration of the tween</param>
  1748. </member>
  1749. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableMoveBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
  1750. <summary>Tweens a Transform's position BY the given value (as if you chained a <code>SetRelative</code>),
  1751. in a way that allows other DOBlendableMove tweens to work together on the same target,
  1752. instead than fight each other as multiple DOMove would do.
  1753. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1754. <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
  1755. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1756. </member>
  1757. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableLocalMoveBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,System.Boolean)">
  1758. <summary>Tweens a Transform's localPosition BY the given value (as if you chained a <code>SetRelative</code>),
  1759. in a way that allows other DOBlendableMove tweens to work together on the same target,
  1760. instead than fight each other as multiple DOMove would do.
  1761. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1762. <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
  1763. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  1764. </member>
  1765. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableRotateBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
  1766. <summary>EXPERIMENTAL METHOD - Tweens a Transform's rotation BY the given value (as if you chained a <code>SetRelative</code>),
  1767. in a way that allows other DOBlendableRotate tweens to work together on the same target,
  1768. instead than fight each other as multiple DORotate would do.
  1769. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1770. <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
  1771. <param name="mode">Rotation mode</param>
  1772. </member>
  1773. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableLocalRotateBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single,DG.Tweening.RotateMode)">
  1774. <summary>EXPERIMENTAL METHOD - Tweens a Transform's lcoalRotation BY the given value (as if you chained a <code>SetRelative</code>),
  1775. in a way that allows other DOBlendableRotate tweens to work together on the same target,
  1776. instead than fight each other as multiple DORotate would do.
  1777. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1778. <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
  1779. <param name="mode">Rotation mode</param>
  1780. </member>
  1781. <member name="M:DG.Tweening.ShortcutExtensions.DOBlendableScaleBy(UnityEngine.Transform,UnityEngine.Vector3,System.Single)">
  1782. <summary>Tweens a Transform's localScale BY the given value (as if you chained a <code>SetRelative</code>),
  1783. in a way that allows other DOBlendableScale tweens to work together on the same target,
  1784. instead than fight each other as multiple DOScale would do.
  1785. Also stores the transform as the tween's target so it can be used for filtered operations</summary>
  1786. <param name="byValue">The value to tween by</param><param name="duration">The duration of the tween</param>
  1787. </member>
  1788. <member name="M:DG.Tweening.ShortcutExtensions.DOComplete(UnityEngine.Component,System.Boolean)">
  1789. <summary>
  1790. Completes all tweens that have this target as a reference
  1791. (meaning tweens that were started from this target, or that had this target added as an Id)
  1792. and returns the total number of tweens completed
  1793. (meaning the tweens that don't have infinite loops and were not already complete)
  1794. </summary>
  1795. <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
  1796. otherwise they will be ignored</param>
  1797. </member>
  1798. <member name="M:DG.Tweening.ShortcutExtensions.DOComplete(UnityEngine.Material,System.Boolean)">
  1799. <summary>
  1800. Completes all tweens that have this target as a reference
  1801. (meaning tweens that were started from this target, or that had this target added as an Id)
  1802. and returns the total number of tweens completed
  1803. (meaning the tweens that don't have infinite loops and were not already complete)
  1804. </summary>
  1805. <param name="withCallbacks">For Sequences only: if TRUE also internal Sequence callbacks will be fired,
  1806. otherwise they will be ignored</param>
  1807. </member>
  1808. <member name="M:DG.Tweening.ShortcutExtensions.DOKill(UnityEngine.Component,System.Boolean)">
  1809. <summary>
  1810. Kills all tweens that have this target as a reference
  1811. (meaning tweens that were started from this target, or that had this target added as an Id)
  1812. and returns the total number of tweens killed.
  1813. </summary>
  1814. <param name="complete">If TRUE completes the tween before killing it</param>
  1815. </member>
  1816. <member name="M:DG.Tweening.ShortcutExtensions.DOKill(UnityEngine.Material,System.Boolean)">
  1817. <summary>
  1818. Kills all tweens that have this target as a reference
  1819. (meaning tweens that were started from this target, or that had this target added as an Id)
  1820. and returns the total number of tweens killed.
  1821. </summary>
  1822. <param name="complete">If TRUE completes the tween before killing it</param>
  1823. </member>
  1824. <member name="M:DG.Tweening.ShortcutExtensions.DOFlip(UnityEngine.Component)">
  1825. <summary>
  1826. Flips the direction (backwards if it was going forward or viceversa) of all tweens that have this target as a reference
  1827. (meaning tweens that were started from this target, or that had this target added as an Id)
  1828. and returns the total number of tweens flipped.
  1829. </summary>
  1830. </member>
  1831. <member name="M:DG.Tweening.ShortcutExtensions.DOFlip(UnityEngine.Material)">
  1832. <summary>
  1833. Flips the direction (backwards if it was going forward or viceversa) of all tweens that have this target as a reference
  1834. (meaning tweens that were started from this target, or that had this target added as an Id)
  1835. and returns the total number of tweens flipped.
  1836. </summary>
  1837. </member>
  1838. <member name="M:DG.Tweening.ShortcutExtensions.DOGoto(UnityEngine.Component,System.Single,System.Boolean)">
  1839. <summary>
  1840. Sends to the given position all tweens that have this target as a reference
  1841. (meaning tweens that were started from this target, or that had this target added as an Id)
  1842. and returns the total number of tweens involved.
  1843. </summary>
  1844. <param name="to">Time position to reach
  1845. (if higher than the whole tween duration the tween will simply reach its end)</param>
  1846. <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
  1847. </member>
  1848. <member name="M:DG.Tweening.ShortcutExtensions.DOGoto(UnityEngine.Material,System.Single,System.Boolean)">
  1849. <summary>
  1850. Sends to the given position all tweens that have this target as a reference
  1851. (meaning tweens that were started from this target, or that had this target added as an Id)
  1852. and returns the total number of tweens involved.
  1853. </summary>
  1854. <param name="to">Time position to reach
  1855. (if higher than the whole tween duration the tween will simply reach its end)</param>
  1856. <param name="andPlay">If TRUE will play the tween after reaching the given position, otherwise it will pause it</param>
  1857. </member>
  1858. <member name="M:DG.Tweening.ShortcutExtensions.DOPause(UnityEngine.Component)">
  1859. <summary>
  1860. Pauses all tweens that have this target as a reference
  1861. (meaning tweens that were started from this target, or that had this target added as an Id)
  1862. and returns the total number of tweens paused.
  1863. </summary>
  1864. </member>
  1865. <member name="M:DG.Tweening.ShortcutExtensions.DOPause(UnityEngine.Material)">
  1866. <summary>
  1867. Pauses all tweens that have this target as a reference
  1868. (meaning tweens that were started from this target, or that had this target added as an Id)
  1869. and returns the total number of tweens paused.
  1870. </summary>
  1871. </member>
  1872. <member name="M:DG.Tweening.ShortcutExtensions.DOPlay(UnityEngine.Component)">
  1873. <summary>
  1874. Plays all tweens that have this target as a reference
  1875. (meaning tweens that were started from this target, or that had this target added as an Id)
  1876. and returns the total number of tweens played.
  1877. </summary>
  1878. </member>
  1879. <member name="M:DG.Tweening.ShortcutExtensions.DOPlay(UnityEngine.Material)">
  1880. <summary>
  1881. Plays all tweens that have this target as a reference
  1882. (meaning tweens that were started from this target, or that had this target added as an Id)
  1883. and returns the total number of tweens played.
  1884. </summary>
  1885. </member>
  1886. <member name="M:DG.Tweening.ShortcutExtensions.DOPlayBackwards(UnityEngine.Component)">
  1887. <summary>
  1888. Plays backwards all tweens that have this target as a reference
  1889. (meaning tweens that were started from this target, or that had this target added as an Id)
  1890. and returns the total number of tweens played.
  1891. </summary>
  1892. </member>
  1893. <member name="M:DG.Tweening.ShortcutExtensions.DOPlayBackwards(UnityEngine.Material)">
  1894. <summary>
  1895. Plays backwards all tweens that have this target as a reference
  1896. (meaning tweens that were started from this target, or that had this target added as an Id)
  1897. and returns the total number of tweens played.
  1898. </summary>
  1899. </member>
  1900. <member name="M:DG.Tweening.ShortcutExtensions.DOPlayForward(UnityEngine.Component)">
  1901. <summary>
  1902. Plays forward all tweens that have this target as a reference
  1903. (meaning tweens that were started from this target, or that had this target added as an Id)
  1904. and returns the total number of tweens played.
  1905. </summary>
  1906. </member>
  1907. <member name="M:DG.Tweening.ShortcutExtensions.DOPlayForward(UnityEngine.Material)">
  1908. <summary>
  1909. Plays forward all tweens that have this target as a reference
  1910. (meaning tweens that were started from this target, or that had this target added as an Id)
  1911. and returns the total number of tweens played.
  1912. </summary>
  1913. </member>
  1914. <member name="M:DG.Tweening.ShortcutExtensions.DORestart(UnityEngine.Component,System.Boolean)">
  1915. <summary>
  1916. Restarts all tweens that have this target as a reference
  1917. (meaning tweens that were started from this target, or that had this target added as an Id)
  1918. and returns the total number of tweens restarted.
  1919. </summary>
  1920. </member>
  1921. <member name="M:DG.Tweening.ShortcutExtensions.DORestart(UnityEngine.Material,System.Boolean)">
  1922. <summary>
  1923. Restarts all tweens that have this target as a reference
  1924. (meaning tweens that were started from this target, or that had this target added as an Id)
  1925. and returns the total number of tweens restarted.
  1926. </summary>
  1927. </member>
  1928. <member name="M:DG.Tweening.ShortcutExtensions.DORewind(UnityEngine.Component,System.Boolean)">
  1929. <summary>
  1930. Rewinds all tweens that have this target as a reference
  1931. (meaning tweens that were started from this target, or that had this target added as an Id)
  1932. and returns the total number of tweens rewinded.
  1933. </summary>
  1934. </member>
  1935. <member name="M:DG.Tweening.ShortcutExtensions.DORewind(UnityEngine.Material,System.Boolean)">
  1936. <summary>
  1937. Rewinds all tweens that have this target as a reference
  1938. (meaning tweens that were started from this target, or that had this target added as an Id)
  1939. and returns the total number of tweens rewinded.
  1940. </summary>
  1941. </member>
  1942. <member name="M:DG.Tweening.ShortcutExtensions.DOSmoothRewind(UnityEngine.Component)">
  1943. <summary>
  1944. Smoothly rewinds all tweens that have this target as a reference
  1945. (meaning tweens that were started from this target, or that had this target added as an Id)
  1946. and returns the total number of tweens rewinded.
  1947. </summary>
  1948. </member>
  1949. <member name="M:DG.Tweening.ShortcutExtensions.DOSmoothRewind(UnityEngine.Material)">
  1950. <summary>
  1951. Smoothly rewinds all tweens that have this target as a reference
  1952. (meaning tweens that were started from this target, or that had this target added as an Id)
  1953. and returns the total number of tweens rewinded.
  1954. </summary>
  1955. </member>
  1956. <member name="M:DG.Tweening.ShortcutExtensions.DOTogglePause(UnityEngine.Component)">
  1957. <summary>
  1958. Toggles the paused state (plays if it was paused, pauses if it was playing) of all tweens that have this target as a reference
  1959. (meaning tweens that were started from this target, or that had this target added as an Id)
  1960. and returns the total number of tweens involved.
  1961. </summary>
  1962. </member>
  1963. <member name="M:DG.Tweening.ShortcutExtensions.DOTogglePause(UnityEngine.Material)">
  1964. <summary>
  1965. Toggles the paused state (plays if it was paused, pauses if it was playing) of all tweens that have this target as a reference
  1966. (meaning tweens that were started from this target, or that had this target added as an Id)
  1967. and returns the total number of tweens involved.
  1968. </summary>
  1969. </member>
  1970. <member name="T:DG.Tweening.TweenParams">
  1971. <summary>
  1972. This class serves only as a utility class to store tween settings to apply on multiple tweens.
  1973. It is in no way needed otherwise, since you can directly apply tween settings to a tween via chaining
  1974. </summary>
  1975. </member>
  1976. <member name="F:DG.Tweening.TweenParams.Params">
  1977. <summary>A variable you can eventually Clear and reuse when needed,
  1978. to avoid instantiating TweenParams objects</summary>
  1979. </member>
  1980. <member name="M:DG.Tweening.TweenParams.#ctor">
  1981. <summary>Creates a new TweenParams object, which you can use to store tween settings
  1982. to pass to multiple tweens via <code>myTween.SetAs(myTweenParms)</code></summary>
  1983. </member>
  1984. <member name="M:DG.Tweening.TweenParams.Clear">
  1985. <summary>Clears and resets this TweenParams instance using default values,
  1986. so it can be reused without instantiating another one</summary>
  1987. </member>
  1988. <member name="M:DG.Tweening.TweenParams.SetAutoKill(System.Boolean)">
  1989. <summary>Sets the autoKill behaviour of the tween.
  1990. Has no effect if the tween has already started</summary>
  1991. <param name="autoKillOnCompletion">If TRUE the tween will be automatically killed when complete</param>
  1992. </member>
  1993. <member name="M:DG.Tweening.TweenParams.SetId(System.Object)">
  1994. <summary>Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.</summary>
  1995. <param name="id">The ID to assign to this tween. Can be an int, a string, an object or anything else.</param>
  1996. </member>
  1997. <member name="M:DG.Tweening.TweenParams.SetTarget(System.Object)">
  1998. <summary>Sets the target for the tween, which can then be used as a filter with DOTween's static methods.
  1999. <para>IMPORTANT: use it with caution. If you just want to set an ID for the tween use <code>SetId</code> instead.</para>
  2000. When using shorcuts the shortcut target is already assigned as the tween's target,
  2001. so using this method will overwrite it and prevent shortcut-operations like myTarget.DOPause from working correctly.</summary>
  2002. <param name="target">The target to assign to this tween. Can be an int, a string, an object or anything else.</param>
  2003. </member>
  2004. <member name="M:DG.Tweening.TweenParams.SetLoops(System.Int32,System.Nullable{DG.Tweening.LoopType})">
  2005. <summary>Sets the looping options for the tween.
  2006. Has no effect if the tween has already started</summary>
  2007. <param name="loops">Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)</param>
  2008. <param name="loopType">Loop behaviour type (default: LoopType.Restart)</param>
  2009. </member>
  2010. <member name="M:DG.Tweening.TweenParams.SetEase(DG.Tweening.Ease,System.Nullable{System.Single},System.Nullable{System.Single})">
  2011. <summary>Sets the ease of the tween.
  2012. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2013. <param name="overshootOrAmplitude">Eventual overshoot or amplitude to use with Back or Elastic easeType (default is 1.70158)</param>
  2014. <param name="period">Eventual period to use with Elastic easeType (default is 0)</param>
  2015. </member>
  2016. <member name="M:DG.Tweening.TweenParams.SetEase(UnityEngine.AnimationCurve)">
  2017. <summary>Sets the ease of the tween using an AnimationCurve.
  2018. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2019. </member>
  2020. <member name="M:DG.Tweening.TweenParams.SetEase(DG.Tweening.EaseFunction)">
  2021. <summary>Sets the ease of the tween using a custom ease function.
  2022. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2023. </member>
  2024. <member name="M:DG.Tweening.TweenParams.SetRecyclable(System.Boolean)">
  2025. <summary>Sets the recycling behaviour for the tween.</summary>
  2026. <param name="recyclable">If TRUE the tween will be recycled after being killed, otherwise it will be destroyed.</param>
  2027. </member>
  2028. <member name="M:DG.Tweening.TweenParams.SetUpdate(System.Boolean)">
  2029. <summary>Sets the update type to the one defined in DOTween.defaultUpdateType (UpdateType.Normal unless changed)
  2030. and lets you choose if it should be independent from Unity's Time.timeScale</summary>
  2031. <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
  2032. </member>
  2033. <member name="M:DG.Tweening.TweenParams.SetUpdate(DG.Tweening.UpdateType,System.Boolean)">
  2034. <summary>Sets the type of update (default or independent) for the tween</summary>
  2035. <param name="updateType">The type of update (default: UpdateType.Normal)</param>
  2036. <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
  2037. </member>
  2038. <member name="M:DG.Tweening.TweenParams.OnStart(DG.Tweening.TweenCallback)">
  2039. <summary>Sets the onStart callback for the tween.
  2040. Called the first time the tween is set in a playing state, after any eventual delay</summary>
  2041. </member>
  2042. <member name="M:DG.Tweening.TweenParams.OnPlay(DG.Tweening.TweenCallback)">
  2043. <summary>Sets the onPlay callback for the tween.
  2044. Called when the tween is set in a playing state, after any eventual delay.
  2045. Also called each time the tween resumes playing from a paused state</summary>
  2046. </member>
  2047. <member name="M:DG.Tweening.TweenParams.OnRewind(DG.Tweening.TweenCallback)">
  2048. <summary>Sets the onRewind callback for the tween.
  2049. Called when the tween is rewinded,
  2050. either by calling <code>Rewind</code> or by reaching the start position while playing backwards.
  2051. Rewinding a tween that is already rewinded will not fire this callback</summary>
  2052. </member>
  2053. <member name="M:DG.Tweening.TweenParams.OnUpdate(DG.Tweening.TweenCallback)">
  2054. <summary>Sets the onUpdate callback for the tween.
  2055. Called each time the tween updates</summary>
  2056. </member>
  2057. <member name="M:DG.Tweening.TweenParams.OnStepComplete(DG.Tweening.TweenCallback)">
  2058. <summary>Sets the onStepComplete callback for the tween.
  2059. Called the moment the tween completes one loop cycle, even when going backwards</summary>
  2060. </member>
  2061. <member name="M:DG.Tweening.TweenParams.OnComplete(DG.Tweening.TweenCallback)">
  2062. <summary>Sets the onComplete callback for the tween.
  2063. Called the moment the tween reaches its final forward position, loops included</summary>
  2064. </member>
  2065. <member name="M:DG.Tweening.TweenParams.OnKill(DG.Tweening.TweenCallback)">
  2066. <summary>Sets the onKill callback for the tween.
  2067. Called the moment the tween is killed</summary>
  2068. </member>
  2069. <member name="M:DG.Tweening.TweenParams.OnWaypointChange(DG.Tweening.TweenCallback{System.Int32})">
  2070. <summary>Sets the onWaypointChange callback for the tween.
  2071. Called when a path tween reaches a new waypoint</summary>
  2072. </member>
  2073. <member name="M:DG.Tweening.TweenParams.SetDelay(System.Single)">
  2074. <summary>Sets a delayed startup for the tween.
  2075. <para>Has no effect on Sequences or if the tween has already started</para></summary>
  2076. </member>
  2077. <member name="M:DG.Tweening.TweenParams.SetRelative(System.Boolean)">
  2078. <summary>If isRelative is TRUE sets the tween as relative
  2079. (the endValue will be calculated as <code>startValue + endValue</code> instead than being used directly).
  2080. <para>Has no effect on Sequences or if the tween has already started</para></summary>
  2081. </member>
  2082. <member name="M:DG.Tweening.TweenParams.SetSpeedBased(System.Boolean)">
  2083. <summary>If isSpeedBased is TRUE sets the tween as speed based
  2084. (the duration will represent the number of units the tween moves x second).
  2085. <para>Has no effect on Sequences, nested tweens, or if the tween has already started</para></summary>
  2086. </member>
  2087. <member name="T:DG.Tweening.TweenSettingsExtensions">
  2088. <summary>
  2089. Methods that extend Tween objects and allow to set their parameters
  2090. </summary>
  2091. </member>
  2092. <member name="M:DG.Tweening.TweenSettingsExtensions.SetAutoKill``1(``0)">
  2093. <summary>Sets the autoKill behaviour of the tween.
  2094. Has no effect if the tween has already started</summary>
  2095. </member>
  2096. <member name="M:DG.Tweening.TweenSettingsExtensions.SetAutoKill``1(``0,System.Boolean)">
  2097. <summary>Sets the autoKill behaviour of the tween.
  2098. Has no effect if the tween has already started</summary>
  2099. <param name="autoKillOnCompletion">If TRUE the tween will be automatically killed when complete</param>
  2100. </member>
  2101. <member name="M:DG.Tweening.TweenSettingsExtensions.SetId``1(``0,System.Object)">
  2102. <summary>Sets an ID for the tween, which can then be used as a filter with DOTween's static methods.</summary>
  2103. <param name="id">The ID to assign to this tween. Can be an int, a string, an object or anything else.</param>
  2104. </member>
  2105. <member name="M:DG.Tweening.TweenSettingsExtensions.SetTarget``1(``0,System.Object)">
  2106. <summary>Sets the target for the tween, which can then be used as a filter with DOTween's static methods.
  2107. <para>IMPORTANT: use it with caution. If you just want to set an ID for the tween use <code>SetId</code> instead.</para>
  2108. When using shorcuts the shortcut target is already assigned as the tween's target,
  2109. so using this method will overwrite it and prevent shortcut-operations like myTarget.DOPause from working correctly.</summary>
  2110. <param name="target">The target to assign to this tween. Can be an int, a string, an object or anything else.</param>
  2111. </member>
  2112. <member name="M:DG.Tweening.TweenSettingsExtensions.SetLoops``1(``0,System.Int32)">
  2113. <summary>Sets the looping options for the tween.
  2114. Has no effect if the tween has already started</summary>
  2115. <param name="loops">Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)</param>
  2116. </member>
  2117. <member name="M:DG.Tweening.TweenSettingsExtensions.SetLoops``1(``0,System.Int32,DG.Tweening.LoopType)">
  2118. <summary>Sets the looping options for the tween.
  2119. Has no effect if the tween has already started</summary>
  2120. <param name="loops">Number of cycles to play (-1 for infinite - will be converted to 1 in case the tween is nested in a Sequence)</param>
  2121. <param name="loopType">Loop behaviour type (default: LoopType.Restart)</param>
  2122. </member>
  2123. <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.Ease)">
  2124. <summary>Sets the ease of the tween.
  2125. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2126. </member>
  2127. <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.Ease,System.Single)">
  2128. <summary>Sets the ease of the tween.
  2129. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2130. <param name="overshoot">
  2131. Eventual overshoot to use with Back or Flash ease (default is 1.70158 - 1 for Flash).
  2132. <para>In case of Flash ease it must be an intenger and sets the total number of flashes that will happen.
  2133. Using an even number will complete the tween on the starting value, while an odd one will complete it on the end value.</para>
  2134. </param>
  2135. </member>
  2136. <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.Ease,System.Single,System.Single)">
  2137. <summary>Sets the ease of the tween.
  2138. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2139. <param name="amplitude">Eventual amplitude to use with Elastic easeType or overshoot to use with Flash easeType (default is 1.70158 - 1 for Flash).
  2140. <para>In case of Flash ease it must be an integer and sets the total number of flashes that will happen.
  2141. Using an even number will complete the tween on the starting value, while an odd one will complete it on the end value.</para>
  2142. </param>
  2143. <param name="period">Eventual period to use with Elastic or Flash easeType (default is 0).
  2144. <para>In case of Flash ease it indicates the power in time of the ease, and must be between -1 and 1.
  2145. 0 is balanced, 1 weakens the ease with time, -1 starts the ease weakened and gives it power towards the end.</para>
  2146. </param>
  2147. </member>
  2148. <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,UnityEngine.AnimationCurve)">
  2149. <summary>Sets the ease of the tween using an AnimationCurve.
  2150. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2151. </member>
  2152. <member name="M:DG.Tweening.TweenSettingsExtensions.SetEase``1(``0,DG.Tweening.EaseFunction)">
  2153. <summary>Sets the ease of the tween using a custom ease function (which must return a value between 0 and 1).
  2154. <para>If applied to Sequences eases the whole sequence animation</para></summary>
  2155. </member>
  2156. <member name="M:DG.Tweening.TweenSettingsExtensions.SetRecyclable``1(``0)">
  2157. <summary>Allows the tween to be recycled after being killed.</summary>
  2158. </member>
  2159. <member name="M:DG.Tweening.TweenSettingsExtensions.SetRecyclable``1(``0,System.Boolean)">
  2160. <summary>Sets the recycling behaviour for the tween.</summary>
  2161. <param name="recyclable">If TRUE the tween will be recycled after being killed, otherwise it will be destroyed.</param>
  2162. </member>
  2163. <member name="M:DG.Tweening.TweenSettingsExtensions.SetUpdate``1(``0,System.Boolean)">
  2164. <summary>Sets the update type to UpdateType.Normal and lets you choose if it should be independent from Unity's Time.timeScale</summary>
  2165. <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
  2166. </member>
  2167. <member name="M:DG.Tweening.TweenSettingsExtensions.SetUpdate``1(``0,DG.Tweening.UpdateType)">
  2168. <summary>Sets the type of update for the tween</summary>
  2169. <param name="updateType">The type of update (defalt: UpdateType.Normal)</param>
  2170. </member>
  2171. <member name="M:DG.Tweening.TweenSettingsExtensions.SetUpdate``1(``0,DG.Tweening.UpdateType,System.Boolean)">
  2172. <summary>Sets the type of update for the tween and lets you choose if it should be independent from Unity's Time.timeScale</summary>
  2173. <param name="updateType">The type of update</param>
  2174. <param name="isIndependentUpdate">If TRUE the tween will ignore Unity's Time.timeScale</param>
  2175. </member>
  2176. <member name="M:DG.Tweening.TweenSettingsExtensions.OnStart``1(``0,DG.Tweening.TweenCallback)">
  2177. <summary>Sets the <code>onStart</code> callback for the tween, clearing any previous <code>onStart</code> callback that was set.
  2178. Called the first time the tween is set in a playing state, after any eventual delay</summary>
  2179. </member>
  2180. <member name="M:DG.Tweening.TweenSettingsExtensions.OnPlay``1(``0,DG.Tweening.TweenCallback)">
  2181. <summary>Sets the <code>onPlay</code> callback for the tween, clearing any previous <code>onPlay</code> callback that was set.
  2182. Called when the tween is set in a playing state, after any eventual delay.
  2183. Also called each time the tween resumes playing from a paused state</summary>
  2184. </member>
  2185. <member name="M:DG.Tweening.TweenSettingsExtensions.OnPause``1(``0,DG.Tweening.TweenCallback)">
  2186. <summary>Sets the <code>onPause</code> callback for the tween, clearing any previous <code>onPause</code> callback that was set.
  2187. Called when the tween state changes from playing to paused.
  2188. If the tween has autoKill set to FALSE, this is called also when the tween reaches completion.</summary>
  2189. </member>
  2190. <member name="M:DG.Tweening.TweenSettingsExtensions.OnRewind``1(``0,DG.Tweening.TweenCallback)">
  2191. <summary>Sets the <code>onRewind</code> callback for the tween, clearing any previous <code>onRewind</code> callback that was set.
  2192. Called when the tween is rewinded,
  2193. either by calling <code>Rewind</code> or by reaching the start position while playing backwards.
  2194. Rewinding a tween that is already rewinded will not fire this callback</summary>
  2195. </member>
  2196. <member name="M:DG.Tweening.TweenSettingsExtensions.OnUpdate``1(``0,DG.Tweening.TweenCallback)">
  2197. <summary>Sets the <code>onUpdate</code> callback for the tween, clearing any previous <code>onUpdate</code> callback that was set.
  2198. Called each time the tween updates</summary>
  2199. </member>
  2200. <member name="M:DG.Tweening.TweenSettingsExtensions.OnStepComplete``1(``0,DG.Tweening.TweenCallback)">
  2201. <summary>Sets the <code>onStepComplete</code> callback for the tween, clearing any previous <code>onStepComplete</code> callback that was set.
  2202. Called the moment the tween completes one loop cycle, even when going backwards</summary>
  2203. </member>
  2204. <member name="M:DG.Tweening.TweenSettingsExtensions.OnComplete``1(``0,DG.Tweening.TweenCallback)">
  2205. <summary>Sets the <code>onComplete</code> callback for the tween, clearing any previous <code>onComplete</code> callback that was set.
  2206. Called the moment the tween reaches its final forward position, loops included</summary>
  2207. </member>
  2208. <member name="M:DG.Tweening.TweenSettingsExtensions.OnKill``1(``0,DG.Tweening.TweenCallback)">
  2209. <summary>Sets the <code>onKill</code> callback for the tween, clearing any previous <code>onKill</code> callback that was set.
  2210. Called the moment the tween is killed</summary>
  2211. </member>
  2212. <member name="M:DG.Tweening.TweenSettingsExtensions.OnWaypointChange``1(``0,DG.Tweening.TweenCallback{System.Int32})">
  2213. <summary>Sets the <code>onWaypointChange</code> callback for the tween, clearing any previous <code>onWaypointChange</code> callback that was set.
  2214. Called when a path tween's current waypoint changes</summary>
  2215. </member>
  2216. <member name="M:DG.Tweening.TweenSettingsExtensions.SetAs``1(``0,DG.Tweening.Tween)">
  2217. <summary>Sets the parameters of the tween (id, ease, loops, delay, timeScale, callbacks, etc) as the parameters of the given one.
  2218. Doesn't copy specific SetOptions settings: those will need to be applied manually each time.
  2219. <para>Has no effect if the tween has already started.</para>
  2220. NOTE: the tween's <code>target</code> will not be changed</summary>
  2221. <param name="asTween">Tween from which to copy the parameters</param>
  2222. </member>
  2223. <member name="M:DG.Tweening.TweenSettingsExtensions.SetAs``1(``0,DG.Tweening.TweenParams)">
  2224. <summary>Sets the parameters of the tween (id, ease, loops, delay, timeScale, callbacks, etc) as the parameters of the given TweenParams.
  2225. <para>Has no effect if the tween has already started.</para></summary>
  2226. <param name="tweenParams">TweenParams from which to copy the parameters</param>
  2227. </member>
  2228. <member name="M:DG.Tweening.TweenSettingsExtensions.Append(DG.Tweening.Sequence,DG.Tweening.Tween)">
  2229. <summary>Adds the given tween to the end of the Sequence.
  2230. Has no effect if the Sequence has already started</summary>
  2231. <param name="t">The tween to append</param>
  2232. </member>
  2233. <member name="M:DG.Tweening.TweenSettingsExtensions.Prepend(DG.Tweening.Sequence,DG.Tweening.Tween)">
  2234. <summary>Adds the given tween to the beginning of the Sequence, pushing forward the other nested content.
  2235. Has no effect if the Sequence has already started</summary>
  2236. <param name="t">The tween to prepend</param>
  2237. </member>
  2238. <member name="M:DG.Tweening.TweenSettingsExtensions.Join(DG.Tweening.Sequence,DG.Tweening.Tween)">
  2239. <summary>Inserts the given tween at the same time position of the last tween, callback or intervale added to the Sequence.
  2240. Note that, in case of a Join after an interval, the insertion time will be the time where the interval starts, not where it finishes.
  2241. Has no effect if the Sequence has already started</summary>
  2242. </member>
  2243. <member name="M:DG.Tweening.TweenSettingsExtensions.Insert(DG.Tweening.Sequence,System.Single,DG.Tweening.Tween)">
  2244. <summary>Inserts the given tween at the given time position in the Sequence,
  2245. automatically adding an interval if needed.
  2246. Has no effect if the Sequence has already started</summary>
  2247. <param name="atPosition">The time position where the tween will be placed</param>
  2248. <param name="t">The tween to insert</param>
  2249. </member>
  2250. <member name="M:DG.Tweening.TweenSettingsExtensions.AppendInterval(DG.Tweening.Sequence,System.Single)">
  2251. <summary>Adds the given interval to the end of the Sequence.
  2252. Has no effect if the Sequence has already started</summary>
  2253. <param name="interval">The interval duration</param>
  2254. </member>
  2255. <member name="M:DG.Tweening.TweenSettingsExtensions.PrependInterval(DG.Tweening.Sequence,System.Single)">
  2256. <summary>Adds the given interval to the beginning of the Sequence, pushing forward the other nested content.
  2257. Has no effect if the Sequence has already started</summary>
  2258. <param name="interval">The interval duration</param>
  2259. </member>
  2260. <member name="M:DG.Tweening.TweenSettingsExtensions.AppendCallback(DG.Tweening.Sequence,DG.Tweening.TweenCallback)">
  2261. <summary>Adds the given callback to the end of the Sequence.
  2262. Has no effect if the Sequence has already started</summary>
  2263. <param name="callback">The callback to append</param>
  2264. </member>
  2265. <member name="M:DG.Tweening.TweenSettingsExtensions.PrependCallback(DG.Tweening.Sequence,DG.Tweening.TweenCallback)">
  2266. <summary>Adds the given callback to the beginning of the Sequence, pushing forward the other nested content.
  2267. Has no effect if the Sequence has already started</summary>
  2268. <param name="callback">The callback to prepend</param>
  2269. </member>
  2270. <member name="M:DG.Tweening.TweenSettingsExtensions.InsertCallback(DG.Tweening.Sequence,System.Single,DG.Tweening.TweenCallback)">
  2271. <summary>Inserts the given callback at the given time position in the Sequence,
  2272. automatically adding an interval if needed.
  2273. Has no effect if the Sequence has already started</summary>
  2274. <param name="atPosition">The time position where the callback will be placed</param>
  2275. <param name="callback">The callback to insert</param>
  2276. </member>
  2277. <member name="M:DG.Tweening.TweenSettingsExtensions.From``1(``0)">
  2278. <summary>Changes a TO tween into a FROM tween: sets the current target's position as the tween's endValue
  2279. then immediately sends the target to the previously set endValue.</summary>
  2280. </member>
  2281. <member name="M:DG.Tweening.TweenSettingsExtensions.From``1(``0,System.Boolean)">
  2282. <summary>Changes a TO tween into a FROM tween: sets the current target's position as the tween's endValue
  2283. then immediately sends the target to the previously set endValue.</summary>
  2284. <param name="isRelative">If TRUE the FROM value will be calculated as relative to the current one</param>
  2285. </member>
  2286. <member name="M:DG.Tweening.TweenSettingsExtensions.SetDelay``1(``0,System.Single)">
  2287. <summary>Sets a delayed startup for the tween.
  2288. <para>Has no effect on Sequences or if the tween has already started</para></summary>
  2289. </member>
  2290. <member name="M:DG.Tweening.TweenSettingsExtensions.SetRelative``1(``0)">
  2291. <summary>Sets the tween as relative
  2292. (the endValue will be calculated as <code>startValue + endValue</code> instead than being used directly).
  2293. <para>Has no effect on Sequences or if the tween has already started</para></summary>
  2294. </member>
  2295. <member name="M:DG.Tweening.TweenSettingsExtensions.SetRelative``1(``0,System.Boolean)">
  2296. <summary>If isRelative is TRUE sets the tween as relative
  2297. (the endValue will be calculated as <code>startValue + endValue</code> instead than being used directly).
  2298. <para>Has no effect on Sequences or if the tween has already started</para></summary>
  2299. </member>
  2300. <member name="M:DG.Tweening.TweenSettingsExtensions.SetSpeedBased``1(``0)">
  2301. <summary>If isSpeedBased is TRUE sets the tween as speed based
  2302. (the duration will represent the number of units the tween moves x second).
  2303. <para>Has no effect on Sequences, nested tweens, or if the tween has already started</para></summary>
  2304. </member>
  2305. <member name="M:DG.Tweening.TweenSettingsExtensions.SetSpeedBased``1(``0,System.Boolean)">
  2306. <summary>If isSpeedBased is TRUE sets the tween as speed based
  2307. (the duration will represent the number of units the tween moves x second).
  2308. <para>Has no effect on Sequences, nested tweens, or if the tween has already started</para></summary>
  2309. </member>
  2310. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{System.Single,System.Single,DG.Tweening.Plugins.Options.FloatOptions},System.Boolean)">
  2311. <summary>Options for float tweens</summary>
  2312. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2313. </member>
  2314. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector2,UnityEngine.Vector2,DG.Tweening.Plugins.Options.VectorOptions},System.Boolean)">
  2315. <summary>Options for Vector2 tweens</summary>
  2316. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2317. </member>
  2318. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector2,UnityEngine.Vector2,DG.Tweening.Plugins.Options.VectorOptions},DG.Tweening.AxisConstraint,System.Boolean)">
  2319. <summary>Options for Vector2 tweens</summary>
  2320. <param name="axisConstraint">Selecting an axis will tween the vector only on that axis, leaving the others untouched</param>
  2321. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2322. </member>
  2323. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3,DG.Tweening.Plugins.Options.VectorOptions},System.Boolean)">
  2324. <summary>Options for Vector3 tweens</summary>
  2325. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2326. </member>
  2327. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3,DG.Tweening.Plugins.Options.VectorOptions},DG.Tweening.AxisConstraint,System.Boolean)">
  2328. <summary>Options for Vector3 tweens</summary>
  2329. <param name="axisConstraint">Selecting an axis will tween the vector only on that axis, leaving the others untouched</param>
  2330. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2331. </member>
  2332. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector4,UnityEngine.Vector4,DG.Tweening.Plugins.Options.VectorOptions},System.Boolean)">
  2333. <summary>Options for Vector4 tweens</summary>
  2334. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2335. </member>
  2336. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector4,UnityEngine.Vector4,DG.Tweening.Plugins.Options.VectorOptions},DG.Tweening.AxisConstraint,System.Boolean)">
  2337. <summary>Options for Vector4 tweens</summary>
  2338. <param name="axisConstraint">Selecting an axis will tween the vector only on that axis, leaving the others untouched</param>
  2339. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2340. </member>
  2341. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Quaternion,UnityEngine.Vector3,DG.Tweening.Plugins.Options.QuaternionOptions},System.Boolean)">
  2342. <summary>Options for Quaternion tweens</summary>
  2343. <param name="useShortest360Route">If TRUE (default) the rotation will take the shortest route, and will not rotate more than 360°.
  2344. If FALSE the rotation will be fully accounted. Is always FALSE if the tween is set as relative</param>
  2345. </member>
  2346. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Color,UnityEngine.Color,DG.Tweening.Plugins.Options.ColorOptions},System.Boolean)">
  2347. <summary>Options for Color tweens</summary>
  2348. <param name="alphaOnly">If TRUE only the alpha value of the color will be tweened</param>
  2349. </member>
  2350. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Rect,UnityEngine.Rect,DG.Tweening.Plugins.Options.RectOptions},System.Boolean)">
  2351. <summary>Options for Vector4 tweens</summary>
  2352. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2353. </member>
  2354. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{System.String,System.String,DG.Tweening.Plugins.Options.StringOptions},System.Boolean,DG.Tweening.ScrambleMode,System.String)">
  2355. <summary>Options for Vector4 tweens</summary>
  2356. <param name="richTextEnabled">If TRUE, rich text will be interpreted correctly while animated,
  2357. otherwise all tags will be considered as normal text</param>
  2358. <param name="scrambleMode">The type of scramble to use, if any</param>
  2359. <param name="scrambleChars">A string containing the characters to use for scrambling.
  2360. Use as many characters as possible (minimum 10) because DOTween uses a fast scramble mode which gives better results with more characters.
  2361. Leave it to NULL to use default ones</param>
  2362. </member>
  2363. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3[],DG.Tweening.Plugins.Options.Vector3ArrayOptions},System.Boolean)">
  2364. <summary>Options for Vector3Array tweens</summary>
  2365. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2366. </member>
  2367. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,UnityEngine.Vector3[],DG.Tweening.Plugins.Options.Vector3ArrayOptions},DG.Tweening.AxisConstraint,System.Boolean)">
  2368. <summary>Options for Vector3Array tweens</summary>
  2369. <param name="snapping">If TRUE the tween will smoothly snap all values to integers</param>
  2370. </member>
  2371. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},DG.Tweening.AxisConstraint,DG.Tweening.AxisConstraint)">
  2372. <summary>Options for Path tweens (created via the <code>DOPath</code> shortcut)</summary>
  2373. <param name="lockPosition">The eventual movement axis to lock. You can input multiple axis if you separate them like this:
  2374. <para>AxisConstrain.X | AxisConstraint.Y</para></param>
  2375. <param name="lockRotation">The eventual rotation axis to lock. You can input multiple axis if you separate them like this:
  2376. <para>AxisConstrain.X | AxisConstraint.Y</para></param>
  2377. </member>
  2378. <member name="M:DG.Tweening.TweenSettingsExtensions.SetOptions(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},System.Boolean,DG.Tweening.AxisConstraint,DG.Tweening.AxisConstraint)">
  2379. <summary>Options for Path tweens (created via the <code>DOPath</code> shortcut)</summary>
  2380. <param name="closePath">If TRUE the path will be automatically closed</param>
  2381. <param name="lockPosition">The eventual movement axis to lock. You can input multiple axis if you separate them like this:
  2382. <para>AxisConstrain.X | AxisConstraint.Y</para></param>
  2383. <param name="lockRotation">The eventual rotation axis to lock. You can input multiple axis if you separate them like this:
  2384. <para>AxisConstrain.X | AxisConstraint.Y</para></param>
  2385. </member>
  2386. <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},UnityEngine.Vector3,System.Nullable{UnityEngine.Vector3},System.Nullable{UnityEngine.Vector3})">
  2387. <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
  2388. Orients the target towards the given position.
  2389. Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
  2390. <param name="lookAtPosition">The position to look at</param>
  2391. <param name="forwardDirection">The eventual direction to consider as "forward".
  2392. If left to NULL defaults to the regular forward side of the transform</param>
  2393. <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
  2394. </member>
  2395. <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},UnityEngine.Transform,System.Nullable{UnityEngine.Vector3},System.Nullable{UnityEngine.Vector3})">
  2396. <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
  2397. Orients the target towards another transform.
  2398. Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
  2399. <param name="lookAtTransform">The transform to look at</param>
  2400. <param name="forwardDirection">The eventual direction to consider as "forward".
  2401. If left to NULL defaults to the regular forward side of the transform</param>
  2402. <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
  2403. </member>
  2404. <member name="M:DG.Tweening.TweenSettingsExtensions.SetLookAt(DG.Tweening.Core.TweenerCore{UnityEngine.Vector3,DG.Tweening.Plugins.Core.PathCore.Path,DG.Tweening.Plugins.Options.PathOptions},System.Single,System.Nullable{UnityEngine.Vector3},System.Nullable{UnityEngine.Vector3})">
  2405. <summary>Additional LookAt options for Path tweens (created via the <code>DOPath</code> shortcut).
  2406. Orients the target to the path, with the given lookAhead.
  2407. Must be chained directly to the tween creation method or to a <code>SetOptions</code></summary>
  2408. <param name="lookAhead">The percentage of lookAhead to use (0 to 1)</param>
  2409. <param name="forwardDirection">The eventual direction to consider as "forward".
  2410. If left to NULL defaults to the regular forward side of the transform</param>
  2411. <param name="up">The vector that defines in which direction up is (default: Vector3.up)</param>
  2412. </member>
  2413. <member name="T:DG.Tweening.LogBehaviour">
  2414. <summary>
  2415. Types of log behaviours
  2416. </summary>
  2417. </member>
  2418. <member name="F:DG.Tweening.LogBehaviour.Default">
  2419. <summary>Log only warnings and errors</summary>
  2420. </member>
  2421. <member name="F:DG.Tweening.LogBehaviour.Verbose">
  2422. <summary>Log warnings, errors and additional infos</summary>
  2423. </member>
  2424. <member name="F:DG.Tweening.LogBehaviour.ErrorsOnly">
  2425. <summary>Log only errors</summary>
  2426. </member>
  2427. <member name="T:DG.Tweening.Tween">
  2428. <summary>
  2429. Indicates either a Tweener or a Sequence
  2430. </summary>
  2431. </member>
  2432. <member name="F:DG.Tweening.Tween.timeScale">
  2433. <summary>TimeScale for the tween</summary>
  2434. </member>
  2435. <member name="F:DG.Tweening.Tween.isBackwards">
  2436. <summary>If TRUE the tween wil go backwards</summary>
  2437. </member>
  2438. <member name="F:DG.Tweening.Tween.id">
  2439. <summary>Id (usable for filtering with DOTween static methods). Can be an int, a string, an object, or anything else</summary>
  2440. </member>
  2441. <member name="F:DG.Tweening.Tween.target">
  2442. <summary>Tween target (usable for filtering with DOTween static methods). Automatically set by tween creation shorcuts</summary>
  2443. </member>
  2444. <member name="F:DG.Tweening.Tween.onPlay">
  2445. <summary>Called when the tween is set in a playing state, after any eventual delay.
  2446. Also called each time the tween resumes playing from a paused state</summary>
  2447. </member>
  2448. <member name="F:DG.Tweening.Tween.onPause">
  2449. <summary>Called when the tween state changes from playing to paused.
  2450. If the tween has autoKill set to FALSE, this is called also when the tween reaches completion.</summary>
  2451. </member>
  2452. <member name="F:DG.Tweening.Tween.onRewind">
  2453. <summary>Called when the tween is rewinded,
  2454. either by calling <code>Rewind</code> or by reaching the start position while playing backwards.
  2455. Rewinding a tween that is already rewinded will not fire this callback</summary>
  2456. </member>
  2457. <member name="F:DG.Tweening.Tween.onUpdate">
  2458. <summary>Called each time the tween updates</summary>
  2459. </member>
  2460. <member name="F:DG.Tweening.Tween.onStepComplete">
  2461. <summary>Called the moment the tween completes one loop cycle</summary>
  2462. </member>
  2463. <member name="F:DG.Tweening.Tween.onComplete">
  2464. <summary>Called the moment the tween reaches completion (loops included)</summary>
  2465. </member>
  2466. <member name="F:DG.Tweening.Tween.onKill">
  2467. <summary>Called the moment the tween is killed</summary>
  2468. </member>
  2469. <member name="F:DG.Tweening.Tween.onWaypointChange">
  2470. <summary>Called when a path tween's current waypoint changes</summary>
  2471. </member>
  2472. <member name="P:DG.Tweening.Tween.fullPosition">
  2473. <summary>Gets and sets the time position (loops included, delays excluded) of the tween</summary>
  2474. </member>
  2475. <member name="T:DG.Tweening.Tweener">
  2476. <summary>
  2477. Animates a single value
  2478. </summary>
  2479. </member>
  2480. <member name="M:DG.Tweening.Tweener.ChangeStartValue(System.Object,System.Single)">
  2481. <summary>Changes the start value of a tween and rewinds it (without pausing it).
  2482. Has no effect with tweens that are inside Sequences</summary>
  2483. <param name="newStartValue">The new start value</param>
  2484. <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
  2485. </member>
  2486. <member name="M:DG.Tweening.Tweener.ChangeEndValue(System.Object,System.Single,System.Boolean)">
  2487. <summary>Changes the end value of a tween and rewinds it (without pausing it).
  2488. Has no effect with tweens that are inside Sequences</summary>
  2489. <param name="newEndValue">The new end value</param>
  2490. <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
  2491. <param name="snapStartValue">If TRUE the start value will become the current target's value, otherwise it will stay the same</param>
  2492. </member>
  2493. <member name="M:DG.Tweening.Tweener.ChangeEndValue(System.Object,System.Boolean)">
  2494. <summary>Changes the end value of a tween and rewinds it (without pausing it).
  2495. Has no effect with tweens that are inside Sequences</summary>
  2496. <param name="newEndValue">The new end value</param>
  2497. <param name="snapStartValue">If TRUE the start value will become the current target's value, otherwise it will stay the same</param>
  2498. </member>
  2499. <member name="M:DG.Tweening.Tweener.ChangeValues(System.Object,System.Object,System.Single)">
  2500. <summary>Changes the start and end value of a tween and rewinds it (without pausing it).
  2501. Has no effect with tweens that are inside Sequences</summary>
  2502. <param name="newStartValue">The new start value</param>
  2503. <param name="newEndValue">The new end value</param>
  2504. <param name="newDuration">If bigger than 0 applies it as the new tween duration</param>
  2505. </member>
  2506. <member name="T:DG.Tweening.TweenType">
  2507. <summary>
  2508. Used internally
  2509. </summary>
  2510. </member>
  2511. <member name="T:DG.Tweening.UpdateType">
  2512. <summary>
  2513. Update type
  2514. </summary>
  2515. </member>
  2516. <member name="F:DG.Tweening.UpdateType.Normal">
  2517. <summary>Updates every frame during Update calls</summary>
  2518. </member>
  2519. <member name="F:DG.Tweening.UpdateType.Late">
  2520. <summary>Updates every frame during LateUpdate calls</summary>
  2521. </member>
  2522. <member name="F:DG.Tweening.UpdateType.Fixed">
  2523. <summary>Updates using FixedUpdate calls</summary>
  2524. </member>
  2525. <member name="F:DG.Tweening.UpdateType.Manual">
  2526. <summary>Updates using manual update calls</summary>
  2527. </member>
  2528. </members>
  2529. </doc>