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.

535 lines
33 KiB

4 years ago
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>LTSeq</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.46</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/LTSeq.html">LTSeq</a></li>
  76. <li><a href="../classes/LTSpline.html">LTSpline</a></li>
  77. </ul>
  78. <ul id="api-modules" class="apis modules">
  79. </ul>
  80. </div>
  81. </div>
  82. </div>
  83. <div id="advertising">
  84. <h2>More From<br><a href="http://www.dentedpixel.com">Dented Pixel</a></h2><br>
  85. <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>
  86. <br>
  87. <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>
  88. <br>
  89. <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>
  90. </div>
  91. </div>
  92. </div>
  93. <div class="yui3-u-3-4">
  94. <div id="api-options">
  95. Show:
  96. <label for="api-show-inherited">
  97. <input type="checkbox" id="api-show-inherited" checked>
  98. Inherited
  99. </label>
  100. <label for="api-show-protected">
  101. <input type="checkbox" id="api-show-protected">
  102. Protected
  103. </label>
  104. <label for="api-show-private">
  105. <input type="checkbox" id="api-show-private">
  106. Private
  107. </label>
  108. <label for="api-show-deprecated">
  109. <input type="checkbox" id="api-show-deprecated">
  110. Deprecated
  111. </label>
  112. </div>
  113. <div class="apidocs">
  114. <div id="docs-main">
  115. <div class="content">
  116. <h1>LTSeq Class</h1>
  117. <div class="box meta">
  118. <div class="foundat">
  119. Defined in: <a href="../files/LTSeq.cs.html#l5"><code>LTSeq.cs:5</code></a>
  120. </div>
  121. </div>
  122. <div class="box intro">
  123. <p>Internal Representation of a Sequence<br>
  124. <br>
  125.   <h4>Example:</h4>
  126. var seq = LeanTween.sequence();<br>
  127. seq.append(1f); <span style="color:gray">// delay everything one second</span><br>
  128. seq.append( () =&gt; { <span style="color:gray">// fire an event before start</span><br>
  129.  Debug.Log(&quot;I have started&quot;);<br>
  130. });<br>
  131. seq.append( LeanTween.move(cube1, Vector3.one * 10f, 1f) ); <span style="color:gray">// do a tween</span><br>
  132. seq.append( (object obj) =&gt; { <span style="color:gray">// fire event after tween</span><br>
  133.  var dict = obj as Dictionary&lt;string,string&gt;;<br>
  134.  Debug.Log(&quot;We are done now obj value:&quot;+dict[&quot;hi&quot;]);<br>
  135. }, new Dictionary&lt;string,string&gt;(){ {&quot;hi&quot;,&quot;sup&quot;} } );<br></p>
  136. </div>
  137. <div class="constructor">
  138. <h2>Constructor</h2>
  139. <div id="method_LTSeq" class="method item">
  140. <h3 class="name"><code>LTSeq</code></h3>
  141. <span class="paren">()</span>
  142. <div class="meta">
  143. <p>
  144. Defined in
  145. <a href="../files/LTSeq.cs.html#l5"><code>LTSeq.cs:5</code></a>
  146. </p>
  147. </div>
  148. <div class="description">
  149. </div>
  150. </div>
  151. </div>
  152. <div id="classdocs" class="tabview">
  153. <ul class="api-class-tabs">
  154. <li class="api-class-tab index"><a href="#index">Index</a></li>
  155. <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
  156. </ul>
  157. <div>
  158. <div id="index" class="api-class-tabpanel index">
  159. <h2 class="off-left">Item Index</h2>
  160. <div class="index-section methods">
  161. <h3>Methods</h3>
  162. <ul class="index-list methods">
  163. <li class="index-item method">
  164. <a href="#method_add (method(object))">add (method(object))</a>
  165. </li>
  166. <li class="index-item method">
  167. <a href="#method_add (tween)">add (tween)</a>
  168. </li>
  169. <li class="index-item method">
  170. <a href="#method_append (delay)">append (delay)</a>
  171. </li>
  172. <li class="index-item method">
  173. <a href="#method_append (method)">append (method)</a>
  174. </li>
  175. </ul>
  176. </div>
  177. </div>
  178. <div id="methods" class="api-class-tabpanel">
  179. <h2 class="off-left">Methods</h2>
  180. <div id="method_add (method(object))" class="method item">
  181. <h3 class="name"><code>add (method(object))</code></h3>
  182. <div class="args">
  183. <span class="paren">(</span><ul class="args-list inline commas">
  184. <li class="arg">
  185. <code>callback:System.Action</code>
  186. </li>
  187. </ul><span class="paren">)</span>
  188. </div>
  189. <span class="returns-inline">
  190. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>
  191. </span>
  192. <div class="meta">
  193. <p>
  194. Defined in
  195. <a href="../files/LTSeq.cs.html#l132"><code>LTSeq.cs:132</code></a>
  196. </p>
  197. </div>
  198. <div class="description">
  199. <p>Add a time delay to the sequence</p>
  200. </div>
  201. <div class="params">
  202. <h4>Parameters:</h4>
  203. <ul class="params-list">
  204. <li class="param">
  205. <code class="param-name">callback:System.Action</code>
  206. <span class="type">System.Action</span>
  207. <div class="param-description">
  208. <p>method you want to be called</p>
  209. </div>
  210. </li>
  211. </ul>
  212. </div>
  213. <div class="returns">
  214. <h4>Returns:</h4>
  215. <div class="returns-description">
  216. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>:
  217. <p>LTSeq an object that you can add tweens, methods and time on to</p>
  218. </div>
  219. </div>
  220. <div class="example">
  221. <h4>Example:</h4>
  222. <div class="example-content">
  223. <p>var seq = LeanTween.sequence();<br>
  224. seq.append( () =&gt; { // fire an event before start<br>
  225.  Debug.Log(&quot;I have started&quot;);<br>
  226. });<br>
  227. seq.append( LeanTween.move(cube1, Vector3.one * 10f, 1f) ); // do a tween<br>
  228. seq.append((object obj) =&gt; { // fire event after tween
  229.  var dict = obj as Dictionary&lt;string,string&gt;;
  230.  Debug.Log(&quot;We are done now obj value:&quot;+dict[&quot;hi&quot;]);
  231.  }, new Dictionary&lt;string,string&gt;(){ {&quot;hi&quot;,&quot;sup&quot;} } );</p>
  232. </div>
  233. </div>
  234. </div>
  235. <div id="method_add (tween)" class="method item">
  236. <h3 class="name"><code>add (tween)</code></h3>
  237. <span class="paren">()</span>
  238. <span class="returns-inline">
  239. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>
  240. </span>
  241. <div class="meta">
  242. <p>
  243. Defined in
  244. <a href="../files/LTSeq.cs.html#l166"><code>LTSeq.cs:166</code></a>
  245. </p>
  246. </div>
  247. <div class="description">
  248. <p>Retrieve a sequencer object where you can easily chain together tweens and methods one after another</p>
  249. </div>
  250. <div class="returns">
  251. <h4>Returns:</h4>
  252. <div class="returns-description">
  253. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>:
  254. <p>LTSeq an object that you can add tweens, methods and time on to</p>
  255. </div>
  256. </div>
  257. <div class="example">
  258. <h4>Example:</h4>
  259. <div class="example-content">
  260. <p>var seq = LeanTween.sequence();<br>
  261. seq.append( LeanTween.move(cube1, Vector3.one * 10f, 1f) ); // do a move tween<br>
  262. seq.append( LeanTween.rotateAround( avatar1, Vector3.forward, 360f, 1f ) ); // then do a rotate tween<br></p>
  263. </div>
  264. </div>
  265. </div>
  266. <div id="method_append (delay)" class="method item">
  267. <h3 class="name"><code>append (delay)</code></h3>
  268. <div class="args">
  269. <span class="paren">(</span><ul class="args-list inline commas">
  270. <li class="arg">
  271. <code>delay:float</code>
  272. </li>
  273. </ul><span class="paren">)</span>
  274. </div>
  275. <span class="returns-inline">
  276. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>
  277. </span>
  278. <div class="meta">
  279. <p>
  280. Defined in
  281. <a href="../files/LTSeq.cs.html#l94"><code>LTSeq.cs:94</code></a>
  282. </p>
  283. </div>
  284. <div class="description">
  285. <p>Add a time delay to the sequence</p>
  286. </div>
  287. <div class="params">
  288. <h4>Parameters:</h4>
  289. <ul class="params-list">
  290. <li class="param">
  291. <code class="param-name">delay:float</code>
  292. <span class="type">Float</span>
  293. <div class="param-description">
  294. <p>amount of time to add to the sequence</p>
  295. </div>
  296. </li>
  297. </ul>
  298. </div>
  299. <div class="returns">
  300. <h4>Returns:</h4>
  301. <div class="returns-description">
  302. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>:
  303. <p>LTDescr an object that distinguishes the tween
  304. var seq = LeanTween.sequence();<br>
  305. seq.append(1f); // delay everything one second<br>
  306. seq.append( LeanTween.move(cube1, Vector3.one * 10f, 1f) ); // do a tween<br></p>
  307. </div>
  308. </div>
  309. </div>
  310. <div id="method_append (method)" class="method item">
  311. <h3 class="name"><code>append (method)</code></h3>
  312. <div class="args">
  313. <span class="paren">(</span><ul class="args-list inline commas">
  314. <li class="arg">
  315. <code>callback:System.Action</code>
  316. </li>
  317. </ul><span class="paren">)</span>
  318. </div>
  319. <span class="returns-inline">
  320. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>
  321. </span>
  322. <div class="meta">
  323. <p>
  324. Defined in
  325. <a href="../files/LTSeq.cs.html#l109"><code>LTSeq.cs:109</code></a>
  326. </p>
  327. </div>
  328. <div class="description">
  329. <p>Add a time delay to the sequence</p>
  330. </div>
  331. <div class="params">
  332. <h4>Parameters:</h4>
  333. <ul class="params-list">
  334. <li class="param">
  335. <code class="param-name">callback:System.Action</code>
  336. <span class="type">System.Action</span>
  337. <div class="param-description">
  338. <p>method you want to be called</p>
  339. </div>
  340. </li>
  341. </ul>
  342. </div>
  343. <div class="returns">
  344. <h4>Returns:</h4>
  345. <div class="returns-description">
  346. <span class="type"><a href="../classes/LTSeq.html" class="crosslink">LTSeq</a></span>:
  347. <p>LTSeq an object that you can add tweens, methods and time on to</p>
  348. </div>
  349. </div>
  350. <div class="example">
  351. <h4>Example:</h4>
  352. <div class="example-content">
  353. <p>var seq = LeanTween.sequence();<br>
  354. seq.append( () =&gt; { // fire an event before start<br>
  355.  Debug.Log(&quot;I have started&quot;);<br>
  356. });<br>
  357. seq.append( LeanTween.move(cube1, Vector3.one * 10f, 1f) ); // do a tween<br>
  358. seq.append( () =&gt; { // fire event after tween<br>
  359.  Debug.Log(&quot;We are done now&quot;);<br>
  360. });;<br></p>
  361. </div>
  362. </div>
  363. </div>
  364. </div>
  365. </div>
  366. </div>
  367. </div>
  368. </div>
  369. </div>
  370. </div>
  371. </div>
  372. </div>
  373. <script src="../assets/vendor/prettify/prettify-min.js"></script>
  374. <script>prettyPrint();</script>
  375. <script src="../assets/js/yui-prettify.js"></script>
  376. <script src="../assets/../api.js"></script>
  377. <script src="../assets/js/api-filter.js"></script>
  378. <script src="../assets/js/api-list.js"></script>
  379. <script src="../assets/js/api-search.js"></script>
  380. <script src="../assets/js/apidocs.js"></script>
  381. </body>
  382. </html>