You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2705 lines
183 KiB

7 years ago
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>LTDescr</title>
  6. <link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0pr2/build/cssgrids/cssgrids-min.css">
  7. <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
  8. <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
  9. <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
  10. <script>
  11. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  12. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  13. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  14. })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  15. ga('create', 'UA-23694672-1', 'dentedpixel.com');
  16. ga('send', 'pageview');
  17. </script>
  18. <script src="../assets/js/leantween.js"></script>
  19. <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
  20. <script src="http://yui.yahooapis.com/combo?3.8.0pr2/build/yui/yui-min.js"></script>
  21. </head>
  22. <body class="yui3-skin-sam">
  23. <div id="doc">
  24. <div id="hd" class="yui3-g header">
  25. <div class="yui3-u-3-4">
  26. <h1><a href="http://dentedpixel.com/developer-diary/leantween-speed-comparison-to-itween/"><img src="http://s3.amazonaws.com/dentedpixel.com/LeanTween/leantween-logo.png" title=""></a></h1> <div style="position:absolute; left:146px; top:90px;">- Developed by <a href="http://www.dentedpixel.com">Dented Pixel</a></div>
  27. </div>
  28. <div class="yui3-u-1-4 version">
  29. <em style="margin-top:2px">API Docs for: LeanTween 2.42</em><br>
  30. <table id="support">
  31. <tr>
  32. <td>
  33. <h3 style="margin:7px 0 3px 0; width: 200px;">Support LeanTween!</h3>
  34. <!--<a href="http://www.amazon.com/?tag=carbcutt-20&camp=1&creative=4365&linkCode=ez&ref-refURL=" target="_blank">Click this link</a> before your<br>next Amazon shopping spree!<br>
  35. -->
  36. </td>
  37. <td><!--
  38. <a href="http://www.amazon.com/?tag=carbcutt-20&camp=1&creative=4365&linkCode=ez&ref-refURL=" target="_blank"><img src="http://dentedpixel.com/LeanTweenDocumentation/assets/img/amz.gif" width="148" height="40" title="shop amazon" /></a>-->
  39. <form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="margin-top:5px;">
  40. <!--<div style="margin:2px 0px 6px 24px; float:left;">or </div>-->
  41. <input type="hidden" name="cmd" value="_s-xclick">
  42. <input type="hidden" name="hosted_button_id" value="YJPUT3RAK5VL8">
  43. <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
  44. <img alt="" border="0" src="https://www.paypalobjects.com/en_US/i/scr/pixel.gif" width="1" height="1">
  45. </form>
  46. </td>
  47. </tr>
  48. </table>
  49. </div>
  50. <h4 style="position:absolute; top:80px; right:7px; width:500px; letter-spacing:normal; word-spacing:normal; font-size:9pt; text-align:right; font-style: italic;">Maintaining and adding new features takes time, your support is appreciated.</h4>
  51. </div>
  52. <div id="bd" class="yui3-g">
  53. <div class="yui3-u-1-4">
  54. <div id="docs-sidebar" class="sidebar apidocs">
  55. <div id="api-list">
  56. <h2 class="off-left">APIs</h2>
  57. <div id="api-tabview" class="tabview">
  58. <ul class="tabs">
  59. <li><a href="#api-classes">Classes</a></li>
  60. <li><a href="#api-modules">Modules</a></li>
  61. </ul>
  62. <div id="api-tabview-filter">
  63. <input type="search" id="api-filter" placeholder="Type to filter APIs">
  64. </div>
  65. <div id="api-tabview-panel">
  66. <ul id="api-classes" class="apis classes">
  67. <li><a href="../classes/LeanAudio.html">LeanAudio</a></li>
  68. <li><a href="../classes/LeanAudioOptions.html">LeanAudioOptions</a></li>
  69. <li><a href="../classes/LeanTween.html">LeanTween</a></li>
  70. <li><a href="../classes/LeanTweenType.html">LeanTweenType</a></li>
  71. <li><a href="../classes/LTBezierPath.html">LTBezierPath</a></li>
  72. <li><a href="../classes/LTDescr.html">LTDescr</a></li>
  73. <li><a href="../classes/LTEvent.html">LTEvent</a></li>
  74. <li><a href="../classes/LTRect.html">LTRect</a></li>
  75. <li><a href="../classes/LTSpline.html">LTSpline</a></li>
  76. </ul>
  77. <ul id="api-modules" class="apis modules">
  78. </ul>
  79. </div>
  80. </div>
  81. </div>
  82. <div id="advertising">
  83. <h2>More From<br><a href="http://www.dentedpixel.com">Dented Pixel</a></h2><br>
  84. <a href="https://www.assetstore.unity3d.com/en/#!/content/9455" target="_blank"><img src="http://dentedpixel.com/assets/LTEditor-doc-icon.jpg" width="175" height="175" /><br>Create tweens with: Visual Editor. Sculpt complex spline paths.</a>
  85. <br>
  86. <a href="https://itunes.apple.com/us/app/monkeyshines/id530998075?mt=8" target="_blank"><img src="http://a1.mzstatic.com/us/r30/Purple3/v4/d4/2b/ce/d42bce69-b3d3-d7f8-88e9-caa92664b5b1/icon350x350.jpeg" width="175" height="175" /><br>RIN - A swinging good time!</a>
  87. <br>
  88. <a href="https://itunes.apple.com/us/app/princess-piano/id445283531?mt=8" target="_blank"><img src="http://a3.mzstatic.com/us/r1000/096/Purple/v4/8c/1e/05/8c1e0590-db82-1d72-2956-2b6470f37ed0/mza_4230031260893485317.175x175-75.jpg" width="175" height="175" /><br>Princess Piano - Learn musical notation<br>in this melodious adventure!</a>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="yui3-u-3-4">
  93. <div id="api-options">
  94. Show:
  95. <label for="api-show-inherited">
  96. <input type="checkbox" id="api-show-inherited" checked>
  97. Inherited
  98. </label>
  99. <label for="api-show-protected">
  100. <input type="checkbox" id="api-show-protected">
  101. Protected
  102. </label>
  103. <label for="api-show-private">
  104. <input type="checkbox" id="api-show-private">
  105. Private
  106. </label>
  107. <label for="api-show-deprecated">
  108. <input type="checkbox" id="api-show-deprecated">
  109. Deprecated
  110. </label>
  111. </div>
  112. <div class="apidocs">
  113. <div id="docs-main">
  114. <div class="content">
  115. <h1>LTDescr Class</h1>
  116. <div class="box meta">
  117. <div class="foundat">
  118. Defined in: <a href="../files/LTDescr.cs.html#l4"><code>LTDescr.cs:4</code></a>
  119. </div>
  120. </div>
  121. <div class="box intro">
  122. <p>Internal Representation of a Tween<br>
  123. <br>
  124. This class represents all of the optional parameters you can pass to a method (it also represents the internal representation of the tween).<br><br>
  125. <strong id='optional'>Optional Parameters</strong> are passed at the end of every method:<br>
  126. <br>
  127.   <i>Example:</i><br>
  128.   LeanTween.moveX( gameObject, 1f, 1f).setEase( <a href="LeanTweenType.html">LeanTweenType</a>.easeInQuad ).setDelay(1f);<br>
  129. <br>
  130. You can pass the optional parameters in any order, and chain on as many as you wish.<br>
  131. You can also <strong>pass parameters at a later time</strong> by saving a reference to what is returned.<br>
  132. <br>
  133. Retrieve a <strong>unique id</strong> for the tween by using the &quot;id&quot; property. You can pass this to LeanTween.pause, LeanTween.resume, LeanTween.cancel, LeanTween.isTweening methods<br>
  134. <br>
  135.   <h4>Example:</h4>
  136.   int id = LeanTween.moveX(gameObject, 1f, 3f).id;<br></p>
  137. <div style="color:gray">&nbsp;&nbsp;// pause a specific tween</div>
  138. &nbsp;&nbsp;LeanTween.pause(id);<br>
  139. <div style="color:gray">&nbsp;&nbsp;// resume later</div>
  140. &nbsp;&nbsp;LeanTween.resume(id);<br>
  141. <div style="color:gray">&nbsp;&nbsp;// check if it is tweening before kicking of a new tween</div>
  142. &nbsp;&nbsp;if( LeanTween.isTweening( id ) ){<br>
  143. &nbsp;&nbsp; &nbsp;&nbsp; LeanTween.cancel( id );<br>
  144. &nbsp;&nbsp; &nbsp;&nbsp; LeanTween.moveZ(gameObject, 10f, 3f);<br>
  145. &nbsp;&nbsp;}<br>
  146. </div>
  147. <div class="constructor">
  148. <h2>Constructor</h2>
  149. <div id="method_LTDescr" class="method item">
  150. <h3 class="name"><code>LTDescr</code></h3>
  151. <span class="paren">()</span>
  152. <div class="meta">
  153. <p>
  154. Defined in
  155. <a href="../files/LTDescr.cs.html#l4"><code>LTDescr.cs:4</code></a>
  156. </p>
  157. </div>
  158. <div class="description">
  159. </div>
  160. </div>
  161. </div>
  162. <div id="classdocs" class="tabview">
  163. <ul class="api-class-tabs">
  164. <li class="api-class-tab index"><a href="#index">Index</a></li>
  165. <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
  166. </ul>
  167. <div>
  168. <div id="index" class="api-class-tabpanel index">
  169. <h2 class="off-left">Item Index</h2>
  170. <div class="index-section methods">
  171. <h3>Methods</h3>
  172. <ul class="index-list methods">
  173. <li class="index-item method">
  174. <a href="#method_pause">pause</a>
  175. </li>
  176. <li class="index-item method">
  177. <a href="#method_resume">resume</a>
  178. </li>
  179. <li class="index-item method">
  180. <a href="#method_setDelay">setDelay</a>
  181. </li>
  182. <li class="index-item method">
  183. <a href="#method_setDirection">setDirection</a>
  184. </li>
  185. <li class="index-item method">
  186. <a href="#method_setEase">setEase</a>
  187. </li>
  188. <li class="index-item method">
  189. <a href="#method_setEase (AnimationCurve)">setEase (AnimationCurve)</a>
  190. </li>
  191. <li class="index-item method">
  192. <a href="#method_setIgnoreTimeScale">setIgnoreTimeScale</a>
  193. </li>
  194. <li class="index-item method">
  195. <a href="#method_setLoopClamp">setLoopClamp</a>
  196. </li>
  197. <li class="index-item method">
  198. <a href="#method_setLoopOnce">setLoopOnce</a>
  199. </li>
  200. <li class="index-item method">
  201. <a href="#method_setLoopPingPong">setLoopPingPong</a>
  202. </li>
  203. <li class="index-item method">
  204. <a href="#method_setOnComplete">setOnComplete</a>
  205. </li>
  206. <li class="index-item method">
  207. <a href="#method_setOnComplete (object)">setOnComplete (object)</a>
  208. </li>
  209. <li class="index-item method">
  210. <a href="#method_setOnCompleteOnRepeat">setOnCompleteOnRepeat</a>
  211. </li>
  212. <li class="index-item method">
  213. <a href="#method_setOnCompleteOnStart">setOnCompleteOnStart</a>
  214. </li>
  215. <li class="index-item method">
  216. <a href="#method_setOnCompleteParam">setOnCompleteParam</a>
  217. </li>
  218. <li class="index-item method">
  219. <a href="#method_setOnStart">setOnStart</a>
  220. </li>
  221. <li class="index-item method">
  222. <a href="#method_setOnUpdate">setOnUpdate</a>
  223. </li>
  224. <li class="index-item method">
  225. <a href="#method_setOnUpdate (object)">setOnUpdate (object)</a>
  226. </li>
  227. <li class="index-item method">
  228. <a href="#method_setOnUpdate (Vector3)">setOnUpdate (Vector3)</a>
  229. </li>
  230. <li class="index-item method">
  231. <a href="#method_setOnUpdateParam">setOnUpdateParam</a>
  232. </li>
  233. <li class="index-item method">
  234. <a href="#method_setOrientToPath">setOrientToPath</a>
  235. </li>
  236. <li class="index-item method">
  237. <a href="#method_setOrientToPath2d">setOrientToPath2d</a>
  238. </li>
  239. <li class="index-item method">
  240. <a href="#method_setOvershoot">setOvershoot</a>
  241. </li>
  242. <li class="index-item method">
  243. <a href="#method_setPeriod">setPeriod</a>
  244. </li>
  245. <li class="index-item method">
  246. <a href="#method_setPoint">setPoint</a>
  247. </li>
  248. <li class="index-item method">
  249. <a href="#method_setRecursive">setRecursive</a>
  250. </li>
  251. <li class="index-item method">
  252. <a href="#method_setRepeat">setRepeat</a>
  253. </li>
  254. <li class="index-item method">
  255. <a href="#method_setScale">setScale</a>
  256. </li>
  257. <li class="index-item method">
  258. <a href="#method_setSpeed">setSpeed</a>
  259. </li>
  260. <li class="index-item method">
  261. <a href="#method_setTime">setTime</a>
  262. </li>
  263. <li class="index-item method">
  264. <a href="#method_setTo">setTo</a>
  265. </li>
  266. <li class="index-item method">
  267. <a href="#method_setUseFrames">setUseFrames</a>
  268. </li>
  269. <li class="index-item method">
  270. <a href="#method_updateNow">updateNow</a>
  271. </li>
  272. </ul>
  273. </div>
  274. </div>
  275. <div id="methods" class="api-class-tabpanel">
  276. <h2 class="off-left">Methods</h2>
  277. <div id="method_pause" class="method item">
  278. <h3 class="name"><code>pause</code></h3>
  279. <span class="paren">()</span>
  280. <span class="returns-inline">
  281. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  282. </span>
  283. <div class="meta">
  284. <p>
  285. Defined in
  286. <a href="../files/LTDescr.cs.html#l1113"><code>LTDescr.cs:1113</code></a>
  287. </p>
  288. </div>
  289. <div class="description">
  290. <p>Pause a tween</p>
  291. </div>
  292. <div class="returns">
  293. <h4>Returns:</h4>
  294. <div class="returns-description">
  295. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  296. <p>LTDescr an object that distinguishes the tween</p>
  297. </div>
  298. </div>
  299. </div>
  300. <div id="method_resume" class="method item">
  301. <h3 class="name"><code>resume</code></h3>
  302. <span class="paren">()</span>
  303. <span class="returns-inline">
  304. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  305. </span>
  306. <div class="meta">
  307. <p>
  308. Defined in
  309. <a href="../files/LTDescr.cs.html#l1128"><code>LTDescr.cs:1128</code></a>
  310. </p>
  311. </div>
  312. <div class="description">
  313. <p>Resume a paused tween</p>
  314. </div>
  315. <div class="returns">
  316. <h4>Returns:</h4>
  317. <div class="returns-description">
  318. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  319. <p>LTDescr an object that distinguishes the tween</p>
  320. </div>
  321. </div>
  322. </div>
  323. <div id="method_setDelay" class="method item">
  324. <h3 class="name"><code>setDelay</code></h3>
  325. <div class="args">
  326. <span class="paren">(</span><ul class="args-list inline commas">
  327. <li class="arg">
  328. <code>float</code>
  329. </li>
  330. </ul><span class="paren">)</span>
  331. </div>
  332. <span class="returns-inline">
  333. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  334. </span>
  335. <div class="meta">
  336. <p>
  337. Defined in
  338. <a href="../files/LTDescr.cs.html#l1145"><code>LTDescr.cs:1145</code></a>
  339. </p>
  340. </div>
  341. <div class="description">
  342. <p>Delay the start of a tween</p>
  343. </div>
  344. <div class="params">
  345. <h4>Parameters:</h4>
  346. <ul class="params-list">
  347. <li class="param">
  348. <code class="param-name">float</code>
  349. <span class="type">Float</span>
  350. <div class="param-description">
  351. <p>time The time to complete the tween in</p>
  352. </div>
  353. </li>
  354. </ul>
  355. </div>
  356. <div class="returns">
  357. <h4>Returns:</h4>
  358. <div class="returns-description">
  359. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  360. <p>LTDescr an object that distinguishes the tween</p>
  361. </div>
  362. </div>
  363. <div class="example">
  364. <h4>Example:</h4>
  365. <div class="example-content">
  366. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setDelay( 1.5f );</p>
  367. </div>
  368. </div>
  369. </div>
  370. <div id="method_setDirection" class="method item">
  371. <h3 class="name"><code>setDirection</code></h3>
  372. <div class="args">
  373. <span class="paren">(</span><ul class="args-list inline commas">
  374. <li class="arg">
  375. <code>direction:float</code>
  376. </li>
  377. </ul><span class="paren">)</span>
  378. </div>
  379. <span class="returns-inline">
  380. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  381. </span>
  382. <div class="meta">
  383. <p>
  384. Defined in
  385. <a href="../files/LTDescr.cs.html#l2157"><code>LTDescr.cs:2157</code></a>
  386. </p>
  387. </div>
  388. <div class="description">
  389. <p>Set the direction of a tween -1f for backwards 1f for forwards (currently only bezier and spline paths are supported)</p>
  390. </div>
  391. <div class="params">
  392. <h4>Parameters:</h4>
  393. <ul class="params-list">
  394. <li class="param">
  395. <code class="param-name">direction:float</code>
  396. <span class="type">Float</span>
  397. <div class="param-description">
  398. <p>the direction that the tween should run, -1f for backwards 1f for forwards</p>
  399. </div>
  400. </li>
  401. </ul>
  402. </div>
  403. <div class="returns">
  404. <h4>Returns:</h4>
  405. <div class="returns-description">
  406. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  407. <p>LTDescr an object that distinguishes the tween</p>
  408. </div>
  409. </div>
  410. <div class="example">
  411. <h4>Example:</h4>
  412. <div class="example-content">
  413. <p>LeanTween.moveSpline(gameObject, new Vector3[]{new Vector3(0f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,0f),new Vector3(1f,0f,1f)}, 1.5f).setDirection(-1f);<br></p>
  414. </div>
  415. </div>
  416. </div>
  417. <div id="method_setEase" class="method item">
  418. <h3 class="name"><code>setEase</code></h3>
  419. <div class="args">
  420. <span class="paren">(</span><ul class="args-list inline commas">
  421. <li class="arg">
  422. <code>easeType:LeanTweenType</code>
  423. </li>
  424. </ul><span class="paren">)</span>
  425. </div>
  426. <span class="returns-inline">
  427. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  428. </span>
  429. <div class="meta">
  430. <p>
  431. Defined in
  432. <a href="../files/LTDescr.cs.html#l1164"><code>LTDescr.cs:1164</code></a>
  433. </p>
  434. </div>
  435. <div class="description">
  436. <p>Set the type of easing used for the tween. <br></p>
  437. <ul><li><a href="LeanTweenType.html">List of all the ease types</a>.</li>
  438. <li><a href="http://www.robertpenner.com/easing/easing_demo.html">This page helps visualize the different easing equations</a></li>
  439. </ul>
  440. </div>
  441. <div class="params">
  442. <h4>Parameters:</h4>
  443. <ul class="params-list">
  444. <li class="param">
  445. <code class="param-name">easeType:LeanTweenType</code>
  446. <span class="type"><a href="../classes/LeanTweenType.html" class="crosslink">LeanTweenType</a></span>
  447. <div class="param-description">
  448. <p>the easing type to use</p>
  449. </div>
  450. </li>
  451. </ul>
  452. </div>
  453. <div class="returns">
  454. <h4>Returns:</h4>
  455. <div class="returns-description">
  456. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  457. <p>LTDescr an object that distinguishes the tween</p>
  458. </div>
  459. </div>
  460. <div class="example">
  461. <h4>Example:</h4>
  462. <div class="example-content">
  463. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setEase( LeanTweenType.easeInBounce );</p>
  464. </div>
  465. </div>
  466. </div>
  467. <div id="method_setEase (AnimationCurve)" class="method item">
  468. <h3 class="name"><code>setEase (AnimationCurve)</code></h3>
  469. <div class="args">
  470. <span class="paren">(</span><ul class="args-list inline commas">
  471. <li class="arg">
  472. <code>easeDefinition:AnimationCurve</code>
  473. </li>
  474. </ul><span class="paren">)</span>
  475. </div>
  476. <span class="returns-inline">
  477. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  478. </span>
  479. <div class="meta">
  480. <p>
  481. Defined in
  482. <a href="../files/LTDescr.cs.html#l1616"><code>LTDescr.cs:1616</code></a>
  483. </p>
  484. </div>
  485. <div class="description">
  486. <p>Set the type of easing used for the tween with a custom curve. <br></p>
  487. </div>
  488. <div class="params">
  489. <h4>Parameters:</h4>
  490. <ul class="params-list">
  491. <li class="param">
  492. <code class="param-name">easeDefinition:AnimationCurve</code>
  493. <span class="type">AnimationCurve</span>
  494. <div class="param-description">
  495. <p>an <a href="http://docs.unity3d.com/Documentation/ScriptReference/AnimationCurve.html" target="_blank">AnimationCure</a> that describes the type of easing you want, this is great for when you want a unique type of movement</p>
  496. </div>
  497. </li>
  498. </ul>
  499. </div>
  500. <div class="returns">
  501. <h4>Returns:</h4>
  502. <div class="returns-description">
  503. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  504. <p>LTDescr an object that distinguishes the tween</p>
  505. </div>
  506. </div>
  507. <div class="example">
  508. <h4>Example:</h4>
  509. <div class="example-content">
  510. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setEase( LeanTweenType.easeInBounce );</p>
  511. </div>
  512. </div>
  513. </div>
  514. <div id="method_setIgnoreTimeScale" class="method item">
  515. <h3 class="name"><code>setIgnoreTimeScale</code></h3>
  516. <div class="args">
  517. <span class="paren">(</span><ul class="args-list inline commas">
  518. <li class="arg">
  519. <code>useUnScaledTime:bool</code>
  520. </li>
  521. </ul><span class="paren">)</span>
  522. </div>
  523. <span class="returns-inline">
  524. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  525. </span>
  526. <div class="meta">
  527. <p>
  528. Defined in
  529. <a href="../files/LTDescr.cs.html#l1750"><code>LTDescr.cs:1750</code></a>
  530. </p>
  531. </div>
  532. <div class="description">
  533. <p>Set ignore time scale when tweening an object when you want the animation to be time-scale independent (ignores the Time.timeScale value). Great for pause screens, when you want all other action to be stopped (or slowed down)</p>
  534. </div>
  535. <div class="params">
  536. <h4>Parameters:</h4>
  537. <ul class="params-list">
  538. <li class="param">
  539. <code class="param-name">useUnScaledTime:bool</code>
  540. <span class="type">Bool</span>
  541. <div class="param-description">
  542. <p>whether to use the unscaled time or not</p>
  543. </div>
  544. </li>
  545. </ul>
  546. </div>
  547. <div class="returns">
  548. <h4>Returns:</h4>
  549. <div class="returns-description">
  550. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  551. <p>LTDescr an object that distinguishes the tween</p>
  552. </div>
  553. </div>
  554. <div class="example">
  555. <h4>Example:</h4>
  556. <div class="example-content">
  557. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setRepeat( 2 ).setIgnoreTimeScale( true );</p>
  558. </div>
  559. </div>
  560. </div>
  561. <div id="method_setLoopClamp" class="method item">
  562. <h3 class="name"><code>setLoopClamp</code></h3>
  563. <div class="args">
  564. <span class="paren">(</span><ul class="args-list inline commas">
  565. <li class="arg">
  566. <code>loops:int</code>
  567. </li>
  568. </ul><span class="paren">)</span>
  569. </div>
  570. <span class="returns-inline">
  571. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  572. </span>
  573. <div class="meta">
  574. <p>
  575. Defined in
  576. <a href="../files/LTDescr.cs.html#l1796"><code>LTDescr.cs:1796</code></a>
  577. </p>
  578. </div>
  579. <div class="description">
  580. <p>When the animation gets to the end it starts back at where it began</p>
  581. </div>
  582. <div class="params">
  583. <h4>Parameters:</h4>
  584. <ul class="params-list">
  585. <li class="param">
  586. <code class="param-name">loops:int</code>
  587. <span class="type">Int</span>
  588. <div class="param-description">
  589. <p>(defaults to -1) how many times you want the loop to happen (-1 for an infinite number of times)</p>
  590. </div>
  591. </li>
  592. </ul>
  593. </div>
  594. <div class="returns">
  595. <h4>Returns:</h4>
  596. <div class="returns-description">
  597. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  598. <p>LTDescr an object that distinguishes the tween</p>
  599. </div>
  600. </div>
  601. <div class="example">
  602. <h4>Example:</h4>
  603. <div class="example-content">
  604. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setLoopClamp( 2 );</p>
  605. </div>
  606. </div>
  607. </div>
  608. <div id="method_setLoopOnce" class="method item">
  609. <h3 class="name"><code>setLoopOnce</code></h3>
  610. <span class="paren">()</span>
  611. <span class="returns-inline">
  612. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  613. </span>
  614. <div class="meta">
  615. <p>
  616. Defined in
  617. <a href="../files/LTDescr.cs.html#l1787"><code>LTDescr.cs:1787</code></a>
  618. </p>
  619. </div>
  620. <div class="description">
  621. <p>No looping involved, just run once (the default)</p>
  622. </div>
  623. <div class="returns">
  624. <h4>Returns:</h4>
  625. <div class="returns-description">
  626. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  627. <p>LTDescr an object that distinguishes the tween</p>
  628. </div>
  629. </div>
  630. <div class="example">
  631. <h4>Example:</h4>
  632. <div class="example-content">
  633. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setLoopOnce();</p>
  634. </div>
  635. </div>
  636. </div>
  637. <div id="method_setLoopPingPong" class="method item">
  638. <h3 class="name"><code>setLoopPingPong</code></h3>
  639. <div class="args">
  640. <span class="paren">(</span><ul class="args-list inline commas">
  641. <li class="arg">
  642. <code>loops:int</code>
  643. </li>
  644. </ul><span class="paren">)</span>
  645. </div>
  646. <span class="returns-inline">
  647. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  648. </span>
  649. <div class="meta">
  650. <p>
  651. Defined in
  652. <a href="../files/LTDescr.cs.html#l1815"><code>LTDescr.cs:1815</code></a>
  653. </p>
  654. </div>
  655. <div class="description">
  656. <p>When the animation gets to the end it then tweens back to where it started (and on, and on)</p>
  657. </div>
  658. <div class="params">
  659. <h4>Parameters:</h4>
  660. <ul class="params-list">
  661. <li class="param">
  662. <code class="param-name">loops:int</code>
  663. <span class="type">Int</span>
  664. <div class="param-description">
  665. <p>(defaults to -1) how many times you want the loop to happen in both directions (-1 for an infinite number of times). Passing a value of 1 will cause the object to go towards and back from it's destination once.</p>
  666. </div>
  667. </li>
  668. </ul>
  669. </div>
  670. <div class="returns">
  671. <h4>Returns:</h4>
  672. <div class="returns-description">
  673. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  674. <p>LTDescr an object that distinguishes the tween</p>
  675. </div>
  676. </div>
  677. <div class="example">
  678. <h4>Example:</h4>
  679. <div class="example-content">
  680. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setLoopPingPong( 2 );</p>
  681. </div>
  682. </div>
  683. </div>
  684. <div id="method_setOnComplete" class="method item">
  685. <h3 class="name"><code>setOnComplete</code></h3>
  686. <div class="args">
  687. <span class="paren">(</span><ul class="args-list inline commas">
  688. <li class="arg">
  689. <code>onComplete:Action</code>
  690. </li>
  691. </ul><span class="paren">)</span>
  692. </div>
  693. <span class="returns-inline">
  694. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  695. </span>
  696. <div class="meta">
  697. <p>
  698. Defined in
  699. <a href="../files/LTDescr.cs.html#l1835"><code>LTDescr.cs:1835</code></a>
  700. </p>
  701. </div>
  702. <div class="description">
  703. <p>Have a method called when the tween finishes</p>
  704. </div>
  705. <div class="params">
  706. <h4>Parameters:</h4>
  707. <ul class="params-list">
  708. <li class="param">
  709. <code class="param-name">onComplete:Action</code>
  710. <span class="type">Action</span>
  711. <div class="param-description">
  712. <p>the method that should be called when the tween is finished ex: tweenFinished(){ }</p>
  713. </div>
  714. </li>
  715. </ul>
  716. </div>
  717. <div class="returns">
  718. <h4>Returns:</h4>
  719. <div class="returns-description">
  720. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  721. <p>LTDescr an object that distinguishes the tween</p>
  722. </div>
  723. </div>
  724. <div class="example">
  725. <h4>Example:</h4>
  726. <div class="example-content">
  727. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setOnComplete( tweenFinished );</p>
  728. </div>
  729. </div>
  730. </div>
  731. <div id="method_setOnComplete (object)" class="method item">
  732. <h3 class="name"><code>setOnComplete (object)</code></h3>
  733. <div class="args">
  734. <span class="paren">(</span><ul class="args-list inline commas">
  735. <li class="arg">
  736. <code>onComplete:Action&lt;object&gt;</code>
  737. </li>
  738. </ul><span class="paren">)</span>
  739. </div>
  740. <span class="returns-inline">
  741. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  742. </span>
  743. <div class="meta">
  744. <p>
  745. Defined in
  746. <a href="../files/LTDescr.cs.html#l1849"><code>LTDescr.cs:1849</code></a>
  747. </p>
  748. </div>
  749. <div class="description">
  750. <p>Have a method called when the tween finishes</p>
  751. </div>
  752. <div class="params">
  753. <h4>Parameters:</h4>
  754. <ul class="params-list">
  755. <li class="param">
  756. <code class="param-name">onComplete:Action&lt;object&gt;</code>
  757. <span class="type">Action<object></span>
  758. <div class="param-description">
  759. <p>the method that should be called when the tween is finished ex: tweenFinished( object myObj ){ }</p>
  760. </div>
  761. </li>
  762. </ul>
  763. </div>
  764. <div class="returns">
  765. <h4>Returns:</h4>
  766. <div class="returns-description">
  767. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  768. <p>LTDescr an object that distinguishes the tween</p>
  769. </div>
  770. </div>
  771. <div class="example">
  772. <h4>Example:</h4>
  773. <div class="example-content">
  774. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setOnComplete( tweenFinished );</p>
  775. </div>
  776. </div>
  777. </div>
  778. <div id="method_setOnCompleteOnRepeat" class="method item">
  779. <h3 class="name"><code>setOnCompleteOnRepeat</code></h3>
  780. <div class="args">
  781. <span class="paren">(</span><ul class="args-list inline commas">
  782. <li class="arg">
  783. <code>isOn:bool</code>
  784. </li>
  785. </ul><span class="paren">)</span>
  786. </div>
  787. <span class="returns-inline">
  788. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  789. </span>
  790. <div class="meta">
  791. <p>
  792. Defined in
  793. <a href="../files/LTDescr.cs.html#l2095"><code>LTDescr.cs:2095</code></a>
  794. </p>
  795. </div>
  796. <div class="description">
  797. <p>Set the onComplete method to be called at the end of every loop cycle (also applies to the delayedCall method)</p>
  798. </div>
  799. <div class="params">
  800. <h4>Parameters:</h4>
  801. <ul class="params-list">
  802. <li class="param">
  803. <code class="param-name">isOn:bool</code>
  804. <span class="type">Bool</span>
  805. <div class="param-description">
  806. <p>does call onComplete on every loop cycle</p>
  807. </div>
  808. </li>
  809. </ul>
  810. </div>
  811. <div class="returns">
  812. <h4>Returns:</h4>
  813. <div class="returns-description">
  814. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  815. <p>LTDescr an object that distinguishes the tween</p>
  816. </div>
  817. </div>
  818. <div class="example">
  819. <h4>Example:</h4>
  820. <div class="example-content">
  821. <p>LeanTween.delayedCall(gameObject,0.3f, delayedMethod).setRepeat(4).setOnCompleteOnRepeat(true);</p>
  822. </div>
  823. </div>
  824. </div>
  825. <div id="method_setOnCompleteOnStart" class="method item">
  826. <h3 class="name"><code>setOnCompleteOnStart</code></h3>
  827. <div class="args">
  828. <span class="paren">(</span><ul class="args-list inline commas">
  829. <li class="arg">
  830. <code>isOn:bool</code>
  831. </li>
  832. </ul><span class="paren">)</span>
  833. </div>
  834. <span class="returns-inline">
  835. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  836. </span>
  837. <div class="meta">
  838. <p>
  839. Defined in
  840. <a href="../files/LTDescr.cs.html#l2108"><code>LTDescr.cs:2108</code></a>
  841. </p>
  842. </div>
  843. <div class="description">
  844. <p>Set the onComplete method to be called at the beginning of the tween (it will still be called when it is completed as well)</p>
  845. </div>
  846. <div class="params">
  847. <h4>Parameters:</h4>
  848. <ul class="params-list">
  849. <li class="param">
  850. <code class="param-name">isOn:bool</code>
  851. <span class="type">Bool</span>
  852. <div class="param-description">
  853. <p>does call onComplete at the start of the tween</p>
  854. </div>
  855. </li>
  856. </ul>
  857. </div>
  858. <div class="returns">
  859. <h4>Returns:</h4>
  860. <div class="returns-description">
  861. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  862. <p>LTDescr an object that distinguishes the tween</p>
  863. </div>
  864. </div>
  865. <div class="example">
  866. <h4>Example:</h4>
  867. <div class="example-content">
  868. <p>LeanTween.delayedCall(gameObject, 2f, ()=&gt;{<br> // Flash an object 5 times
  869.  LeanTween.alpha(gameObject, 0f, 1f);<br>
  870.  LeanTween.alpha(gameObject, 1f, 0f).setDelay(1f);<br>
  871. }).setOnCompleteOnStart(true).setRepeat(5);<br></p>
  872. </div>
  873. </div>
  874. </div>
  875. <div id="method_setOnCompleteParam" class="method item">
  876. <h3 class="name"><code>setOnCompleteParam</code></h3>
  877. <div class="args">
  878. <span class="paren">(</span><ul class="args-list inline commas">
  879. <li class="arg">
  880. <code>onComplete:object</code>
  881. </li>
  882. </ul><span class="paren">)</span>
  883. </div>
  884. <span class="returns-inline">
  885. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  886. </span>
  887. <div class="meta">
  888. <p>
  889. Defined in
  890. <a href="../files/LTDescr.cs.html#l1870"><code>LTDescr.cs:1870</code></a>
  891. </p>
  892. </div>
  893. <div class="description">
  894. <p>Pass an object to along with the onComplete Function</p>
  895. </div>
  896. <div class="params">
  897. <h4>Parameters:</h4>
  898. <ul class="params-list">
  899. <li class="param">
  900. <code class="param-name">onComplete:object</code>
  901. <span class="type">Object</span>
  902. <div class="param-description">
  903. <p>an object that</p>
  904. </div>
  905. </li>
  906. </ul>
  907. </div>
  908. <div class="returns">
  909. <h4>Returns:</h4>
  910. <div class="returns-description">
  911. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  912. <p>LTDescr an object that distinguishes the tween</p>
  913. </div>
  914. </div>
  915. <div class="example">
  916. <h4>Example:</h4>
  917. <div class="example-content">
  918. <p>LeanTween.delayedCall(1.5f, enterMiniGameStart).setOnCompleteParam( new object[]{&quot;&quot;+5} );<br><br>
  919. void enterMiniGameStart( object val ){<br>
  920.  object[] arr = (object [])val;<br>
  921.  int lvl = int.Parse((string)arr[0]);<br>
  922. }<br></p>
  923. </div>
  924. </div>
  925. </div>
  926. <div id="method_setOnStart" class="method item">
  927. <h3 class="name"><code>setOnStart</code></h3>
  928. <div class="args">
  929. <span class="paren">(</span><ul class="args-list inline commas">
  930. <li class="arg">
  931. <code>onStart:Action&lt;&gt;</code>
  932. </li>
  933. </ul><span class="paren">)</span>
  934. </div>
  935. <span class="returns-inline">
  936. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  937. </span>
  938. <div class="meta">
  939. <p>
  940. Defined in
  941. <a href="../files/LTDescr.cs.html#l2141"><code>LTDescr.cs:2141</code></a>
  942. </p>
  943. </div>
  944. <div class="description">
  945. <p>Have a method called when the tween starts</p>
  946. </div>
  947. <div class="params">
  948. <h4>Parameters:</h4>
  949. <ul class="params-list">
  950. <li class="param">
  951. <code class="param-name">onStart:Action&lt;&gt;</code>
  952. <span class="type">Action<></span>
  953. <div class="param-description">
  954. <p>the method that should be called when the tween is starting ex: tweenStarted( ){ }</p>
  955. </div>
  956. </li>
  957. </ul>
  958. </div>
  959. <div class="returns">
  960. <h4>Returns:</h4>
  961. <div class="returns-description">
  962. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  963. <p>LTDescr an object that distinguishes the tween</p>
  964. </div>
  965. </div>
  966. <div class="example">
  967. <h4>Example:</h4>
  968. <div class="example-content">
  969. <p><i>C#:</i><br>
  970. LeanTween.moveX(gameObject, 5f, 2.0f ).setOnStart( ()=&gt;{ Debug.Log(&quot;I started!&quot;); });
  971. <i>Javascript:</i><br>
  972. LeanTween.moveX(gameObject, 5f, 2.0f ).setOnStart( function(){ Debug.Log(&quot;I started!&quot;); } );</p>
  973. </div>
  974. </div>
  975. </div>
  976. <div id="method_setOnUpdate" class="method item">
  977. <h3 class="name"><code>setOnUpdate</code></h3>
  978. <div class="args">
  979. <span class="paren">(</span><ul class="args-list inline commas">
  980. <li class="arg">
  981. <code>onUpdate:Action&lt;float&gt;</code>
  982. </li>
  983. </ul><span class="paren">)</span>
  984. </div>
  985. <span class="returns-inline">
  986. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  987. </span>
  988. <div class="meta">
  989. <p>
  990. Defined in
  991. <a href="../files/LTDescr.cs.html#l1889"><code>LTDescr.cs:1889</code></a>
  992. </p>
  993. </div>
  994. <div class="description">
  995. <p>Have a method called on each frame that the tween is being animated (passes a float value)</p>
  996. </div>
  997. <div class="params">
  998. <h4>Parameters:</h4>
  999. <ul class="params-list">
  1000. <li class="param">
  1001. <code class="param-name">onUpdate:Action&lt;float&gt;</code>
  1002. <span class="type">Action<float></span>
  1003. <div class="param-description">
  1004. <p>a method that will be called on every frame with the float value of the tweened object</p>
  1005. </div>
  1006. </li>
  1007. </ul>
  1008. </div>
  1009. <div class="returns">
  1010. <h4>Returns:</h4>
  1011. <div class="returns-description">
  1012. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1013. <p>LTDescr an object that distinguishes the tween</p>
  1014. </div>
  1015. </div>
  1016. <div class="example">
  1017. <h4>Example:</h4>
  1018. <div class="example-content">
  1019. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setOnUpdate( tweenMoved );<br>
  1020. <br>
  1021. void tweenMoved( float val ){ }<br></p>
  1022. </div>
  1023. </div>
  1024. </div>
  1025. <div id="method_setOnUpdate (object)" class="method item">
  1026. <h3 class="name"><code>setOnUpdate (object)</code></h3>
  1027. <div class="args">
  1028. <span class="paren">(</span><ul class="args-list inline commas">
  1029. <li class="arg">
  1030. <code>onUpdate:Action&lt;float,object&gt;</code>
  1031. </li>
  1032. </ul><span class="paren">)</span>
  1033. </div>
  1034. <span class="returns-inline">
  1035. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1036. </span>
  1037. <div class="meta">
  1038. <p>
  1039. Defined in
  1040. <a href="../files/LTDescr.cs.html#l1951"><code>LTDescr.cs:1951</code></a>
  1041. </p>
  1042. </div>
  1043. <div class="description">
  1044. <p>Have a method called on each frame that the tween is being animated (passes a float value and a object)</p>
  1045. </div>
  1046. <div class="params">
  1047. <h4>Parameters:</h4>
  1048. <ul class="params-list">
  1049. <li class="param">
  1050. <code class="param-name">onUpdate:Action&lt;float,object&gt;</code>
  1051. <span class="type">Action<float,object></span>
  1052. <div class="param-description">
  1053. <p>a method that will be called on every frame with the float value of the tweened object, and an object of the person's choosing</p>
  1054. </div>
  1055. </li>
  1056. </ul>
  1057. </div>
  1058. <div class="returns">
  1059. <h4>Returns:</h4>
  1060. <div class="returns-description">
  1061. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1062. <p>LTDescr an object that distinguishes the tween</p>
  1063. </div>
  1064. </div>
  1065. <div class="example">
  1066. <h4>Example:</h4>
  1067. <div class="example-content">
  1068. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setOnUpdate( tweenMoved ).setOnUpdateParam( myObject );<br>
  1069. <br>
  1070. void tweenMoved( float val, object obj ){ }<br></p>
  1071. </div>
  1072. </div>
  1073. </div>
  1074. <div id="method_setOnUpdate (Vector3)" class="method item">
  1075. <h3 class="name"><code>setOnUpdate (Vector3)</code></h3>
  1076. <div class="args">
  1077. <span class="paren">(</span><ul class="args-list inline commas">
  1078. <li class="arg">
  1079. <code>onUpdate:Action&lt;Vector3&gt;</code>
  1080. </li>
  1081. </ul><span class="paren">)</span>
  1082. </div>
  1083. <span class="returns-inline">
  1084. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1085. </span>
  1086. <div class="meta">
  1087. <p>
  1088. Defined in
  1089. <a href="../files/LTDescr.cs.html#l1985"><code>LTDescr.cs:1985</code></a>
  1090. </p>
  1091. </div>
  1092. <div class="description">
  1093. <p>Have a method called on each frame that the tween is being animated (passes a float value)</p>
  1094. </div>
  1095. <div class="params">
  1096. <h4>Parameters:</h4>
  1097. <ul class="params-list">
  1098. <li class="param">
  1099. <code class="param-name">onUpdate:Action&lt;Vector3&gt;</code>
  1100. <span class="type">Action<Vector3></span>
  1101. <div class="param-description">
  1102. <p>a method that will be called on every frame with the float value of the tweened object</p>
  1103. </div>
  1104. </li>
  1105. </ul>
  1106. </div>
  1107. <div class="returns">
  1108. <h4>Returns:</h4>
  1109. <div class="returns-description">
  1110. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1111. <p>LTDescr an object that distinguishes the tween</p>
  1112. </div>
  1113. </div>
  1114. <div class="example">
  1115. <h4>Example:</h4>
  1116. <div class="example-content">
  1117. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setOnUpdate( tweenMoved );<br>
  1118. <br>
  1119. void tweenMoved( Vector3 val ){ }<br></p>
  1120. </div>
  1121. </div>
  1122. </div>
  1123. <div id="method_setOnUpdateParam" class="method item">
  1124. <h3 class="name"><code>setOnUpdateParam</code></h3>
  1125. <div class="args">
  1126. <span class="paren">(</span><ul class="args-list inline commas">
  1127. <li class="arg">
  1128. <code>onUpdateParam:object</code>
  1129. </li>
  1130. </ul><span class="paren">)</span>
  1131. </div>
  1132. <span class="returns-inline">
  1133. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1134. </span>
  1135. <div class="meta">
  1136. <p>
  1137. Defined in
  1138. <a href="../files/LTDescr.cs.html#l2005"><code>LTDescr.cs:2005</code></a>
  1139. </p>
  1140. </div>
  1141. <div class="description">
  1142. <p>Have an object passed along with the onUpdate method</p>
  1143. </div>
  1144. <div class="params">
  1145. <h4>Parameters:</h4>
  1146. <ul class="params-list">
  1147. <li class="param">
  1148. <code class="param-name">onUpdateParam:object</code>
  1149. <span class="type">Object</span>
  1150. <div class="param-description">
  1151. <p>an object that will be passed along with the onUpdate method</p>
  1152. </div>
  1153. </li>
  1154. </ul>
  1155. </div>
  1156. <div class="returns">
  1157. <h4>Returns:</h4>
  1158. <div class="returns-description">
  1159. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1160. <p>LTDescr an object that distinguishes the tween</p>
  1161. </div>
  1162. </div>
  1163. <div class="example">
  1164. <h4>Example:</h4>
  1165. <div class="example-content">
  1166. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setOnUpdate( tweenMoved ).setOnUpdateParam( myObject );<br>
  1167. <br>
  1168. void tweenMoved( float val, object obj ){ }<br></p>
  1169. </div>
  1170. </div>
  1171. </div>
  1172. <div id="method_setOrientToPath" class="method item">
  1173. <h3 class="name"><code>setOrientToPath</code></h3>
  1174. <div class="args">
  1175. <span class="paren">(</span><ul class="args-list inline commas">
  1176. <li class="arg">
  1177. <code>doesOrient:bool</code>
  1178. </li>
  1179. </ul><span class="paren">)</span>
  1180. </div>
  1181. <span class="returns-inline">
  1182. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1183. </span>
  1184. <div class="meta">
  1185. <p>
  1186. Defined in
  1187. <a href="../files/LTDescr.cs.html#l2020"><code>LTDescr.cs:2020</code></a>
  1188. </p>
  1189. </div>
  1190. <div class="description">
  1191. <p>While tweening along a curve, set this property to true, to be perpendicalur to the path it is moving upon</p>
  1192. </div>
  1193. <div class="params">
  1194. <h4>Parameters:</h4>
  1195. <ul class="params-list">
  1196. <li class="param">
  1197. <code class="param-name">doesOrient:bool</code>
  1198. <span class="type">Bool</span>
  1199. <div class="param-description">
  1200. <p>whether the gameobject will orient to the path it is animating along</p>
  1201. </div>
  1202. </li>
  1203. </ul>
  1204. </div>
  1205. <div class="returns">
  1206. <h4>Returns:</h4>
  1207. <div class="returns-description">
  1208. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1209. <p>LTDescr an object that distinguishes the tween</p>
  1210. </div>
  1211. </div>
  1212. <div class="example">
  1213. <h4>Example:</h4>
  1214. <div class="example-content">
  1215. <p>LeanTween.move( ltLogo, path, 1.0f ).setEase(LeanTweenType.easeOutQuad).setOrientToPath(true).setAxis(Vector3.forward);<br></p>
  1216. </div>
  1217. </div>
  1218. </div>
  1219. <div id="method_setOrientToPath2d" class="method item">
  1220. <h3 class="name"><code>setOrientToPath2d</code></h3>
  1221. <div class="args">
  1222. <span class="paren">(</span><ul class="args-list inline commas">
  1223. <li class="arg">
  1224. <code>doesOrient:bool</code>
  1225. </li>
  1226. </ul><span class="paren">)</span>
  1227. </div>
  1228. <span class="returns-inline">
  1229. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1230. </span>
  1231. <div class="meta">
  1232. <p>
  1233. Defined in
  1234. <a href="../files/LTDescr.cs.html#l2039"><code>LTDescr.cs:2039</code></a>
  1235. </p>
  1236. </div>
  1237. <div class="description">
  1238. <p>While tweening along a curve, set this property to true, to be perpendicalur to the path it is moving upon</p>
  1239. </div>
  1240. <div class="params">
  1241. <h4>Parameters:</h4>
  1242. <ul class="params-list">
  1243. <li class="param">
  1244. <code class="param-name">doesOrient:bool</code>
  1245. <span class="type">Bool</span>
  1246. <div class="param-description">
  1247. <p>whether the gameobject will orient to the path it is animating along</p>
  1248. </div>
  1249. </li>
  1250. </ul>
  1251. </div>
  1252. <div class="returns">
  1253. <h4>Returns:</h4>
  1254. <div class="returns-description">
  1255. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1256. <p>LTDescr an object that distinguishes the tween</p>
  1257. </div>
  1258. </div>
  1259. <div class="example">
  1260. <h4>Example:</h4>
  1261. <div class="example-content">
  1262. <p>LeanTween.move( ltLogo, path, 1.0f ).setEase(LeanTweenType.easeOutQuad).setOrientToPath2d(true).setAxis(Vector3.forward);<br></p>
  1263. </div>
  1264. </div>
  1265. </div>
  1266. <div id="method_setOvershoot" class="method item">
  1267. <h3 class="name"><code>setOvershoot</code></h3>
  1268. <div class="args">
  1269. <span class="paren">(</span><ul class="args-list inline commas">
  1270. <li class="arg">
  1271. <code>overshoot:float</code>
  1272. </li>
  1273. </ul><span class="paren">)</span>
  1274. </div>
  1275. <span class="returns-inline">
  1276. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1277. </span>
  1278. <div class="meta">
  1279. <p>
  1280. Defined in
  1281. <a href="../files/LTDescr.cs.html#l1577"><code>LTDescr.cs:1577</code></a>
  1282. </p>
  1283. </div>
  1284. <div class="description">
  1285. <p>Set how far past a tween will overshoot for certain ease types (compatible: easeInBack, easeInOutBack, easeOutBack, easeOutElastic, easeInElastic, easeInOutElastic). <br></p>
  1286. </div>
  1287. <div class="params">
  1288. <h4>Parameters:</h4>
  1289. <ul class="params-list">
  1290. <li class="param">
  1291. <code class="param-name">overshoot:float</code>
  1292. <span class="type">Float</span>
  1293. <div class="param-description">
  1294. <p>how far past the destination it will go before settling in</p>
  1295. </div>
  1296. </li>
  1297. </ul>
  1298. </div>
  1299. <div class="returns">
  1300. <h4>Returns:</h4>
  1301. <div class="returns-description">
  1302. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1303. <p>LTDescr an object that distinguishes the tween</p>
  1304. </div>
  1305. </div>
  1306. <div class="example">
  1307. <h4>Example:</h4>
  1308. <div class="example-content">
  1309. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setEase( LeanTweenType.easeOutBack ).setOvershoot(2f);</p>
  1310. </div>
  1311. </div>
  1312. </div>
  1313. <div id="method_setPeriod" class="method item">
  1314. <h3 class="name"><code>setPeriod</code></h3>
  1315. <div class="args">
  1316. <span class="paren">(</span><ul class="args-list inline commas">
  1317. <li class="arg">
  1318. <code>period:float</code>
  1319. </li>
  1320. </ul><span class="paren">)</span>
  1321. </div>
  1322. <span class="returns-inline">
  1323. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1324. </span>
  1325. <div class="meta">
  1326. <p>
  1327. Defined in
  1328. <a href="../files/LTDescr.cs.html#l1590"><code>LTDescr.cs:1590</code></a>
  1329. </p>
  1330. </div>
  1331. <div class="description">
  1332. <p>Set how short the iterations are for certain ease types (compatible: easeOutElastic, easeInElastic, easeInOutElastic). <br></p>
  1333. </div>
  1334. <div class="params">
  1335. <h4>Parameters:</h4>
  1336. <ul class="params-list">
  1337. <li class="param">
  1338. <code class="param-name">period:float</code>
  1339. <span class="type">Float</span>
  1340. <div class="param-description">
  1341. <p>how short the iterations are that the tween will animate at (default 0.3f)</p>
  1342. </div>
  1343. </li>
  1344. </ul>
  1345. </div>
  1346. <div class="returns">
  1347. <h4>Returns:</h4>
  1348. <div class="returns-description">
  1349. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1350. <p>LTDescr an object that distinguishes the tween</p>
  1351. </div>
  1352. </div>
  1353. <div class="example">
  1354. <h4>Example:</h4>
  1355. <div class="example-content">
  1356. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setEase( LeanTweenType.easeOutElastic ).setPeriod(0.3f);</p>
  1357. </div>
  1358. </div>
  1359. </div>
  1360. <div id="method_setPoint" class="method item">
  1361. <h3 class="name"><code>setPoint</code></h3>
  1362. <div class="args">
  1363. <span class="paren">(</span><ul class="args-list inline commas">
  1364. <li class="arg">
  1365. <code>point:Vector3</code>
  1366. </li>
  1367. </ul><span class="paren">)</span>
  1368. </div>
  1369. <span class="returns-inline">
  1370. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1371. </span>
  1372. <div class="meta">
  1373. <p>
  1374. Defined in
  1375. <a href="../files/LTDescr.cs.html#l2072"><code>LTDescr.cs:2072</code></a>
  1376. </p>
  1377. </div>
  1378. <div class="description">
  1379. <p>Set the point at which the GameObject will be rotated around</p>
  1380. </div>
  1381. <div class="params">
  1382. <h4>Parameters:</h4>
  1383. <ul class="params-list">
  1384. <li class="param">
  1385. <code class="param-name">point:Vector3</code>
  1386. <span class="type">Vector3</span>
  1387. <div class="param-description">
  1388. <p>point at which you want the object to rotate around (local space)</p>
  1389. </div>
  1390. </li>
  1391. </ul>
  1392. </div>
  1393. <div class="returns">
  1394. <h4>Returns:</h4>
  1395. <div class="returns-description">
  1396. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1397. <p>LTDescr an object that distinguishes the tween</p>
  1398. </div>
  1399. </div>
  1400. <div class="example">
  1401. <h4>Example:</h4>
  1402. <div class="example-content">
  1403. <p>LeanTween.rotateAround( cube, Vector3.up, 360.0f, 1.0f ) .setPoint( new Vector3(1f,0f,0f) ) .setEase( LeanTweenType.easeInOutBounce );<br></p>
  1404. </div>
  1405. </div>
  1406. </div>
  1407. <div id="method_setRecursive" class="method item">
  1408. <h3 class="name"><code>setRecursive</code></h3>
  1409. <div class="args">
  1410. <span class="paren">(</span><ul class="args-list inline commas">
  1411. <li class="arg">
  1412. <code>useRecursion:bool</code>
  1413. </li>
  1414. </ul><span class="paren">)</span>
  1415. </div>
  1416. <span class="returns-inline">
  1417. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1418. </span>
  1419. <div class="meta">
  1420. <p>
  1421. Defined in
  1422. <a href="../files/LTDescr.cs.html#l2189"><code>LTDescr.cs:2189</code></a>
  1423. </p>
  1424. </div>
  1425. <div class="description">
  1426. <p>Set whether or not the tween will recursively effect an objects children in the hierarchy</p>
  1427. </div>
  1428. <div class="params">
  1429. <h4>Parameters:</h4>
  1430. <ul class="params-list">
  1431. <li class="param">
  1432. <code class="param-name">useRecursion:bool</code>
  1433. <span class="type">Bool</span>
  1434. <div class="param-description">
  1435. <p>whether the tween will recursively effect an objects children in the hierarchy</p>
  1436. </div>
  1437. </li>
  1438. </ul>
  1439. </div>
  1440. <div class="returns">
  1441. <h4>Returns:</h4>
  1442. <div class="returns-description">
  1443. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1444. <p>LTDescr an object that distinguishes the tween</p>
  1445. </div>
  1446. </div>
  1447. <div class="example">
  1448. <h4>Example:</h4>
  1449. <div class="example-content">
  1450. <p>LeanTween.alpha(gameObject, 0f, 1f).setRecursive(true);<br></p>
  1451. </div>
  1452. </div>
  1453. </div>
  1454. <div id="method_setRepeat" class="method item">
  1455. <h3 class="name"><code>setRepeat</code></h3>
  1456. <div class="args">
  1457. <span class="paren">(</span><ul class="args-list inline commas">
  1458. <li class="arg">
  1459. <code>repeatNum:int</code>
  1460. </li>
  1461. </ul><span class="paren">)</span>
  1462. </div>
  1463. <span class="returns-inline">
  1464. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1465. </span>
  1466. <div class="meta">
  1467. <p>
  1468. Defined in
  1469. <a href="../files/LTDescr.cs.html#l1721"><code>LTDescr.cs:1721</code></a>
  1470. </p>
  1471. </div>
  1472. <div class="description">
  1473. <p>Set the tween to repeat a number of times.</p>
  1474. </div>
  1475. <div class="params">
  1476. <h4>Parameters:</h4>
  1477. <ul class="params-list">
  1478. <li class="param">
  1479. <code class="param-name">repeatNum:int</code>
  1480. <span class="type">Int</span>
  1481. <div class="param-description">
  1482. <p>the number of times to repeat the tween. -1 to repeat infinite times</p>
  1483. </div>
  1484. </li>
  1485. </ul>
  1486. </div>
  1487. <div class="returns">
  1488. <h4>Returns:</h4>
  1489. <div class="returns-description">
  1490. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1491. <p>LTDescr an object that distinguishes the tween</p>
  1492. </div>
  1493. </div>
  1494. <div class="example">
  1495. <h4>Example:</h4>
  1496. <div class="example-content">
  1497. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setRepeat( 10 ).setLoopPingPong();</p>
  1498. </div>
  1499. </div>
  1500. </div>
  1501. <div id="method_setScale" class="method item">
  1502. <h3 class="name"><code>setScale</code></h3>
  1503. <div class="args">
  1504. <span class="paren">(</span><ul class="args-list inline commas">
  1505. <li class="arg">
  1506. <code>scale:float</code>
  1507. </li>
  1508. </ul><span class="paren">)</span>
  1509. </div>
  1510. <span class="returns-inline">
  1511. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1512. </span>
  1513. <div class="meta">
  1514. <p>
  1515. Defined in
  1516. <a href="../files/LTDescr.cs.html#l1603"><code>LTDescr.cs:1603</code></a>
  1517. </p>
  1518. </div>
  1519. <div class="description">
  1520. <p>Set how large the effect is for certain ease types (compatible: punch, shake, animation curves). <br></p>
  1521. </div>
  1522. <div class="params">
  1523. <h4>Parameters:</h4>
  1524. <ul class="params-list">
  1525. <li class="param">
  1526. <code class="param-name">scale:float</code>
  1527. <span class="type">Float</span>
  1528. <div class="param-description">
  1529. <p>how much the ease will be multiplied by (default 1f)</p>
  1530. </div>
  1531. </li>
  1532. </ul>
  1533. </div>
  1534. <div class="returns">
  1535. <h4>Returns:</h4>
  1536. <div class="returns-description">
  1537. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1538. <p>LTDescr an object that distinguishes the tween</p>
  1539. </div>
  1540. </div>
  1541. <div class="example">
  1542. <h4>Example:</h4>
  1543. <div class="example-content">
  1544. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setEase( LeanTweenType.punch ).setScale(2f);</p>
  1545. </div>
  1546. </div>
  1547. </div>
  1548. <div id="method_setSpeed" class="method item">
  1549. <h3 class="name"><code>setSpeed</code></h3>
  1550. <div class="args">
  1551. <span class="paren">(</span><ul class="args-list inline commas">
  1552. <li class="arg">
  1553. <code>speed:float</code>
  1554. </li>
  1555. </ul><span class="paren">)</span>
  1556. </div>
  1557. <span class="returns-inline">
  1558. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1559. </span>
  1560. <div class="meta">
  1561. <p>
  1562. Defined in
  1563. <a href="../files/LTDescr.cs.html#l1706"><code>LTDescr.cs:1706</code></a>
  1564. </p>
  1565. </div>
  1566. <div class="description">
  1567. <p>Set the finish time of the tween</p>
  1568. </div>
  1569. <div class="params">
  1570. <h4>Parameters:</h4>
  1571. <ul class="params-list">
  1572. <li class="param">
  1573. <code class="param-name">speed:float</code>
  1574. <span class="type">Float</span>
  1575. <div class="param-description">
  1576. <p>the speed in unity units per second you wish the object to travel (overrides the given time)</p>
  1577. </div>
  1578. </li>
  1579. </ul>
  1580. </div>
  1581. <div class="returns">
  1582. <h4>Returns:</h4>
  1583. <div class="returns-description">
  1584. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1585. <p>LTDescr an object that distinguishes the tween</p>
  1586. </div>
  1587. </div>
  1588. <div class="example">
  1589. <h4>Example:</h4>
  1590. <div class="example-content">
  1591. <p>LeanTween.moveLocalZ( gameObject, 10f, 1f).setSpeed(0.2f) // the given time is ignored when speed is set<br></p>
  1592. </div>
  1593. </div>
  1594. </div>
  1595. <div id="method_setTime" class="method item">
  1596. <h3 class="name"><code>setTime</code></h3>
  1597. <div class="args">
  1598. <span class="paren">(</span><ul class="args-list inline commas">
  1599. <li class="arg">
  1600. <code>finishTime:float</code>
  1601. </li>
  1602. </ul><span class="paren">)</span>
  1603. </div>
  1604. <span class="returns-inline">
  1605. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1606. </span>
  1607. <div class="meta">
  1608. <p>
  1609. Defined in
  1610. <a href="../files/LTDescr.cs.html#l1688"><code>LTDescr.cs:1688</code></a>
  1611. </p>
  1612. </div>
  1613. <div class="description">
  1614. <p>Set the finish time of the tween</p>
  1615. </div>
  1616. <div class="params">
  1617. <h4>Parameters:</h4>
  1618. <ul class="params-list">
  1619. <li class="param">
  1620. <code class="param-name">finishTime:float</code>
  1621. <span class="type">Float</span>
  1622. <div class="param-description">
  1623. <p>the length of time in seconds you wish the tween to complete in</p>
  1624. </div>
  1625. </li>
  1626. </ul>
  1627. </div>
  1628. <div class="returns">
  1629. <h4>Returns:</h4>
  1630. <div class="returns-description">
  1631. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1632. <p>LTDescr an object that distinguishes the tween</p>
  1633. </div>
  1634. </div>
  1635. <div class="example">
  1636. <h4>Example:</h4>
  1637. <div class="example-content">
  1638. <p>int tweenId = LeanTween.moveX(gameObject, 5f, 2.0f ).id;<br>
  1639. // Later<br>
  1640. LTDescr descr = description( tweenId );<br>
  1641. descr.setTime( 1f );<br></p>
  1642. </div>
  1643. </div>
  1644. </div>
  1645. <div id="method_setTo" class="method item">
  1646. <h3 class="name"><code>setTo</code></h3>
  1647. <div class="args">
  1648. <span class="paren">(</span><ul class="args-list inline commas">
  1649. <li class="arg">
  1650. <code>to:Vector3</code>
  1651. </li>
  1652. </ul><span class="paren">)</span>
  1653. </div>
  1654. <span class="returns-inline">
  1655. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1656. </span>
  1657. <div class="meta">
  1658. <p>
  1659. Defined in
  1660. <a href="../files/LTDescr.cs.html#l1631"><code>LTDescr.cs:1631</code></a>
  1661. </p>
  1662. </div>
  1663. <div class="description">
  1664. <p>Set the end that the GameObject is tweening towards</p>
  1665. </div>
  1666. <div class="params">
  1667. <h4>Parameters:</h4>
  1668. <ul class="params-list">
  1669. <li class="param">
  1670. <code class="param-name">to:Vector3</code>
  1671. <span class="type">Vector3</span>
  1672. <div class="param-description">
  1673. <p>point at which you want the tween to reach</p>
  1674. </div>
  1675. </li>
  1676. </ul>
  1677. </div>
  1678. <div class="returns">
  1679. <h4>Returns:</h4>
  1680. <div class="returns-description">
  1681. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1682. <p>LTDescr an object that distinguishes the tween</p>
  1683. </div>
  1684. </div>
  1685. <div class="example">
  1686. <h4>Example:</h4>
  1687. <div class="example-content">
  1688. <p>LTDescr descr = LeanTween.move( cube, Vector3.up, new Vector3(1f,3f,0f), 1.0f ).setEase( LeanTweenType.easeInOutBounce );<br>
  1689. // Later your want to change your destination or your destiation is constantly moving<br>
  1690. descr.setTo( new Vector3(5f,10f,3f); );<br></p>
  1691. </div>
  1692. </div>
  1693. </div>
  1694. <div id="method_setUseFrames" class="method item">
  1695. <h3 class="name"><code>setUseFrames</code></h3>
  1696. <div class="args">
  1697. <span class="paren">(</span><ul class="args-list inline commas">
  1698. <li class="arg">
  1699. <code>useFrames:bool</code>
  1700. </li>
  1701. </ul><span class="paren">)</span>
  1702. </div>
  1703. <span class="returns-inline">
  1704. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1705. </span>
  1706. <div class="meta">
  1707. <p>
  1708. Defined in
  1709. <a href="../files/LTDescr.cs.html#l1763"><code>LTDescr.cs:1763</code></a>
  1710. </p>
  1711. </div>
  1712. <div class="description">
  1713. <p>Use frames when tweening an object, when you don't want the animation to be time-frame independent...</p>
  1714. </div>
  1715. <div class="params">
  1716. <h4>Parameters:</h4>
  1717. <ul class="params-list">
  1718. <li class="param">
  1719. <code class="param-name">useFrames:bool</code>
  1720. <span class="type">Bool</span>
  1721. <div class="param-description">
  1722. <p>whether to use estimated time or not</p>
  1723. </div>
  1724. </li>
  1725. </ul>
  1726. </div>
  1727. <div class="returns">
  1728. <h4>Returns:</h4>
  1729. <div class="returns-description">
  1730. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1731. <p>LTDescr an object that distinguishes the tween</p>
  1732. </div>
  1733. </div>
  1734. <div class="example">
  1735. <h4>Example:</h4>
  1736. <div class="example-content">
  1737. <p>LeanTween.moveX(gameObject, 5f, 2.0f ).setRepeat( 2 ).setUseFrames( true );</p>
  1738. </div>
  1739. </div>
  1740. </div>
  1741. <div id="method_updateNow" class="method item">
  1742. <h3 class="name"><code>updateNow</code></h3>
  1743. <span class="paren">()</span>
  1744. <span class="returns-inline">
  1745. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>
  1746. </span>
  1747. <div class="meta">
  1748. <p>
  1749. Defined in
  1750. <a href="../files/LTDescr.cs.html#l904"><code>LTDescr.cs:904</code></a>
  1751. </p>
  1752. </div>
  1753. <div class="description">
  1754. <p>If you need a tween to happen immediately instead of waiting for the next Update call, you can force it with this method</p>
  1755. </div>
  1756. <div class="returns">
  1757. <h4>Returns:</h4>
  1758. <div class="returns-description">
  1759. <span class="type"><a href="../classes/LTDescr.html" class="crosslink">LTDescr</a></span>:
  1760. <p>LTDescr an object that distinguishes the tween</p>
  1761. </div>
  1762. </div>
  1763. <div class="example">
  1764. <h4>Example:</h4>
  1765. <div class="example-content">
  1766. <p>LeanTween.moveX(gameObject, 5f, 0f ).updateNow();</p>
  1767. </div>
  1768. </div>
  1769. </div>
  1770. </div>
  1771. </div>
  1772. </div>
  1773. </div>
  1774. </div>
  1775. </div>
  1776. </div>
  1777. </div>
  1778. </div>
  1779. <script src="../assets/vendor/prettify/prettify-min.js"></script>
  1780. <script>prettyPrint();</script>
  1781. <script src="../assets/js/yui-prettify.js"></script>
  1782. <script src="../assets/../api.js"></script>
  1783. <script src="../assets/js/api-filter.js"></script>
  1784. <script src="../assets/js/api-list.js"></script>
  1785. <script src="../assets/js/api-search.js"></script>
  1786. <script src="../assets/js/apidocs.js"></script>
  1787. </body>
  1788. </html>