Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 356 | chris | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 2 | <!--NewPage--> |
||
| 3 | <HTML> |
||
| 4 | <HEAD> |
||
| 5 | <!-- Generated by javadoc (build 1.6.0_26) on Sun Jan 27 20:37:07 CET 2013 --> |
||
| 6 | <TITLE> |
||
| 7 | Action (libgdx API) |
||
| 8 | </TITLE> |
||
| 9 | |||
| 10 | <META NAME="date" CONTENT="2013-01-27"> |
||
| 11 | |||
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
||
| 13 | |||
| 14 | <SCRIPT type="text/javascript"> |
||
| 15 | function windowTitle() |
||
| 16 | { |
||
| 17 | if (location.href.indexOf('is-external=true') == -1) { |
||
| 18 | parent.document.title="Action (libgdx API)"; |
||
| 19 | } |
||
| 20 | } |
||
| 21 | </SCRIPT> |
||
| 22 | <NOSCRIPT> |
||
| 23 | </NOSCRIPT> |
||
| 24 | |||
| 25 | </HEAD> |
||
| 26 | |||
| 27 | <BODY BGCOLOR="white" onload="windowTitle();"> |
||
| 28 | <HR> |
||
| 29 | |||
| 30 | |||
| 31 | <!-- ========= START OF TOP NAVBAR ======= --> |
||
| 32 | <A NAME="navbar_top"><!-- --></A> |
||
| 33 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
||
| 34 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
||
| 35 | <TR> |
||
| 36 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
||
| 37 | <A NAME="navbar_top_firstrow"><!-- --></A> |
||
| 38 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
||
| 39 | <TR ALIGN="center" VALIGN="top"> |
||
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
||
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
||
| 42 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
||
| 43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Action.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
||
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
||
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
||
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
||
| 47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
||
| 48 | </TR> |
||
| 49 | </TABLE> |
||
| 50 | </TD> |
||
| 51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
||
| 52 | |||
| 53 | libgdx API |
||
| 54 | <style> |
||
| 55 | body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt } |
||
| 56 | pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif } |
||
| 57 | h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold } |
||
| 58 | .TableHeadingColor { background:#EEEEFF; } |
||
| 59 | a { text-decoration:none } |
||
| 60 | a:hover { text-decoration:underline } |
||
| 61 | a:link, a:visited { color:blue } |
||
| 62 | table { border:0px } |
||
| 63 | .TableRowColor td:first-child { border-left:1px solid black } |
||
| 64 | .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black } |
||
| 65 | hr { border:0px; border-bottom:1px solid #333366; } |
||
| 66 | </style> |
||
| 67 | </EM> |
||
| 68 | </TD> |
||
| 69 | </TR> |
||
| 70 | |||
| 71 | <TR> |
||
| 72 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 73 | PREV CLASS |
||
| 74 | <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d"><B>NEXT CLASS</B></A></FONT></TD> |
||
| 75 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 76 | <A HREF="../../../../../index.html?com/badlogic/gdx/scenes/scene2d/Action.html" target="_top"><B>FRAMES</B></A> |
||
| 77 | <A HREF="Action.html" target="_top"><B>NO FRAMES</B></A> |
||
| 78 | <SCRIPT type="text/javascript"> |
||
| 79 | <!-- |
||
| 80 | if(window==top) { |
||
| 81 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
||
| 82 | } |
||
| 83 | //--> |
||
| 84 | </SCRIPT> |
||
| 85 | <NOSCRIPT> |
||
| 86 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
||
| 87 | </NOSCRIPT> |
||
| 88 | |||
| 89 | |||
| 90 | </FONT></TD> |
||
| 91 | </TR> |
||
| 92 | <TR> |
||
| 93 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 94 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
||
| 95 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 96 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
||
| 97 | </TR> |
||
| 98 | </TABLE> |
||
| 99 | <A NAME="skip-navbar_top"></A> |
||
| 100 | <!-- ========= END OF TOP NAVBAR ========= --> |
||
| 101 | |||
| 102 | <HR> |
||
| 103 | <!-- ======== START OF CLASS DATA ======== --> |
||
| 104 | <H2> |
||
| 105 | <FONT SIZE="-1"> |
||
| 106 | com.badlogic.gdx.scenes.scene2d</FONT> |
||
| 107 | <BR> |
||
| 108 | Class Action</H2> |
||
| 109 | <PRE> |
||
| 110 | java.lang.Object |
||
| 111 | <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.badlogic.gdx.scenes.scene2d.Action</B> |
||
| 112 | </PRE> |
||
| 113 | <DL> |
||
| 114 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/badlogic/gdx/utils/Pool.Poolable.html" title="interface in com.badlogic.gdx.utils">Pool.Poolable</A></DD> |
||
| 115 | </DL> |
||
| 116 | <DL> |
||
| 117 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/AddAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">AddAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/DelegateAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">DelegateAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/LayoutAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">LayoutAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/ParallelAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">ParallelAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/RemoveActorAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">RemoveActorAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/RunnableAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">RunnableAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/TemporalAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">TemporalAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/TouchableAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">TouchableAction</A>, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/VisibleAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions">VisibleAction</A></DD> |
||
| 118 | </DL> |
||
| 119 | <HR> |
||
| 120 | <DL> |
||
| 121 | <DT><PRE>public abstract class <B>Action</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/badlogic/gdx/utils/Pool.Poolable.html" title="interface in com.badlogic.gdx.utils">Pool.Poolable</A></DL> |
||
| 122 | </PRE> |
||
| 123 | |||
| 124 | <P> |
||
| 125 | Actions attach to an <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d"><CODE>Actor</CODE></A> and perform some task, often over time. |
||
| 126 | <P> |
||
| 127 | |||
| 128 | <P> |
||
| 129 | <DL> |
||
| 130 | <DT><B>Author:</B></DT> |
||
| 131 | <DD>Nathan Sweet</DD> |
||
| 132 | </DL> |
||
| 133 | <HR> |
||
| 134 | |||
| 135 | <P> |
||
| 136 | <!-- =========== FIELD SUMMARY =========== --> |
||
| 137 | |||
| 138 | <A NAME="field_summary"><!-- --></A> |
||
| 139 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 140 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 141 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 142 | <B>Field Summary</B></FONT></TH> |
||
| 143 | </TR> |
||
| 144 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 145 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 146 | <CODE>protected <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d">Actor</A></CODE></FONT></TD> |
||
| 147 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#actor">actor</A></B></CODE> |
||
| 148 | |||
| 149 | <BR> |
||
| 150 | The actor this action is attached to, or null if it is not attached.</TD> |
||
| 151 | </TR> |
||
| 152 | </TABLE> |
||
| 153 | |
||
| 154 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
||
| 155 | |||
| 156 | <A NAME="constructor_summary"><!-- --></A> |
||
| 157 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 158 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 159 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 160 | <B>Constructor Summary</B></FONT></TH> |
||
| 161 | </TR> |
||
| 162 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 163 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#Action()">Action</A></B>()</CODE> |
||
| 164 | |||
| 165 | <BR> |
||
| 166 | </TD> |
||
| 167 | </TR> |
||
| 168 | </TABLE> |
||
| 169 | |
||
| 170 | <!-- ========== METHOD SUMMARY =========== --> |
||
| 171 | |||
| 172 | <A NAME="method_summary"><!-- --></A> |
||
| 173 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 174 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 175 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
||
| 176 | <B>Method Summary</B></FONT></TH> |
||
| 177 | </TR> |
||
| 178 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 179 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 180 | <CODE>abstract boolean</CODE></FONT></TD> |
||
| 181 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#act(float)">act</A></B>(float delta)</CODE> |
||
| 182 | |||
| 183 | <BR> |
||
| 184 | Updates the action based on time.</TD> |
||
| 185 | </TR> |
||
| 186 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 187 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 188 | <CODE> <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d">Actor</A></CODE></FONT></TD> |
||
| 189 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#getActor()">getActor</A></B>()</CODE> |
||
| 190 | |||
| 191 | <BR> |
||
| 192 | </TD> |
||
| 193 | </TR> |
||
| 194 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 195 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 196 | <CODE> <A HREF="../../../../../com/badlogic/gdx/utils/Pool.html" title="class in com.badlogic.gdx.utils">Pool</A></CODE></FONT></TD> |
||
| 197 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#getPool()">getPool</A></B>()</CODE> |
||
| 198 | |||
| 199 | <BR> |
||
| 200 | </TD> |
||
| 201 | </TR> |
||
| 202 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 203 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 204 | <CODE> void</CODE></FONT></TD> |
||
| 205 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#reset()">reset</A></B>()</CODE> |
||
| 206 | |||
| 207 | <BR> |
||
| 208 | Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused.</TD> |
||
| 209 | </TR> |
||
| 210 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 211 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 212 | <CODE> void</CODE></FONT></TD> |
||
| 213 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#restart()">restart</A></B>()</CODE> |
||
| 214 | |||
| 215 | <BR> |
||
| 216 | Sets the state of the action so it can be run again.</TD> |
||
| 217 | </TR> |
||
| 218 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 219 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 220 | <CODE> void</CODE></FONT></TD> |
||
| 221 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#setActor(com.badlogic.gdx.scenes.scene2d.Actor)">setActor</A></B>(<A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d">Actor</A> actor)</CODE> |
||
| 222 | |||
| 223 | <BR> |
||
| 224 | Sets the actor this action will be used for.</TD> |
||
| 225 | </TR> |
||
| 226 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 227 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 228 | <CODE> void</CODE></FONT></TD> |
||
| 229 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#setPool(com.badlogic.gdx.utils.Pool)">setPool</A></B>(<A HREF="../../../../../com/badlogic/gdx/utils/Pool.html" title="class in com.badlogic.gdx.utils">Pool</A> pool)</CODE> |
||
| 230 | |||
| 231 | <BR> |
||
| 232 | Sets the pool that the action will be returned to when removed from the actor.</TD> |
||
| 233 | </TR> |
||
| 234 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 235 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
||
| 236 | <CODE> java.lang.String</CODE></FONT></TD> |
||
| 237 | <TD><CODE><B><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#toString()">toString</A></B>()</CODE> |
||
| 238 | |||
| 239 | <BR> |
||
| 240 | </TD> |
||
| 241 | </TR> |
||
| 242 | </TABLE> |
||
| 243 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
||
| 244 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 245 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
||
| 246 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
||
| 247 | </TR> |
||
| 248 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
||
| 249 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
||
| 250 | </TR> |
||
| 251 | </TABLE> |
||
| 252 | |
||
| 253 | <P> |
||
| 254 | |||
| 255 | <!-- ============ FIELD DETAIL =========== --> |
||
| 256 | |||
| 257 | <A NAME="field_detail"><!-- --></A> |
||
| 258 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 259 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 260 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
||
| 261 | <B>Field Detail</B></FONT></TH> |
||
| 262 | </TR> |
||
| 263 | </TABLE> |
||
| 264 | |||
| 265 | <A NAME="actor"><!-- --></A><H3> |
||
| 266 | actor</H3> |
||
| 267 | <PRE> |
||
| 268 | protected <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d">Actor</A> <B>actor</B></PRE> |
||
| 269 | <DL> |
||
| 270 | <DD>The actor this action is attached to, or null if it is not attached. |
||
| 271 | <P> |
||
| 272 | <DL> |
||
| 273 | </DL> |
||
| 274 | </DL> |
||
| 275 | |||
| 276 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
||
| 277 | |||
| 278 | <A NAME="constructor_detail"><!-- --></A> |
||
| 279 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 280 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 281 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
||
| 282 | <B>Constructor Detail</B></FONT></TH> |
||
| 283 | </TR> |
||
| 284 | </TABLE> |
||
| 285 | |||
| 286 | <A NAME="Action()"><!-- --></A><H3> |
||
| 287 | Action</H3> |
||
| 288 | <PRE> |
||
| 289 | public <B>Action</B>()</PRE> |
||
| 290 | <DL> |
||
| 291 | </DL> |
||
| 292 | |||
| 293 | <!-- ============ METHOD DETAIL ========== --> |
||
| 294 | |||
| 295 | <A NAME="method_detail"><!-- --></A> |
||
| 296 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
||
| 297 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
||
| 298 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
||
| 299 | <B>Method Detail</B></FONT></TH> |
||
| 300 | </TR> |
||
| 301 | </TABLE> |
||
| 302 | |||
| 303 | <A NAME="act(float)"><!-- --></A><H3> |
||
| 304 | act</H3> |
||
| 305 | <PRE> |
||
| 306 | public abstract boolean <B>act</B>(float delta)</PRE> |
||
| 307 | <DL> |
||
| 308 | <DD>Updates the action based on time. Typically this is called each frame by <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html#act(float)"><CODE>Actor.act(float)</CODE></A>. |
||
| 309 | <P> |
||
| 310 | <DD><DL> |
||
| 311 | </DL> |
||
| 312 | </DD> |
||
| 313 | <DD><DL> |
||
| 314 | <DT><B>Parameters:</B><DD><CODE>delta</CODE> - Time in seconds since the last frame. |
||
| 315 | <DT><B>Returns:</B><DD>true if the action is done. This method may continue to be called after the action is done.</DL> |
||
| 316 | </DD> |
||
| 317 | </DL> |
||
| 318 | <HR> |
||
| 319 | |||
| 320 | <A NAME="restart()"><!-- --></A><H3> |
||
| 321 | restart</H3> |
||
| 322 | <PRE> |
||
| 323 | public void <B>restart</B>()</PRE> |
||
| 324 | <DL> |
||
| 325 | <DD>Sets the state of the action so it can be run again. |
||
| 326 | <P> |
||
| 327 | <DD><DL> |
||
| 328 | </DL> |
||
| 329 | </DD> |
||
| 330 | <DD><DL> |
||
| 331 | </DL> |
||
| 332 | </DD> |
||
| 333 | </DL> |
||
| 334 | <HR> |
||
| 335 | |||
| 336 | <A NAME="getActor()"><!-- --></A><H3> |
||
| 337 | getActor</H3> |
||
| 338 | <PRE> |
||
| 339 | public <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d">Actor</A> <B>getActor</B>()</PRE> |
||
| 340 | <DL> |
||
| 341 | <DD><DL> |
||
| 342 | </DL> |
||
| 343 | </DD> |
||
| 344 | <DD><DL> |
||
| 345 | |||
| 346 | <DT><B>Returns:</B><DD>null if the action is not attached to an actor.</DL> |
||
| 347 | </DD> |
||
| 348 | </DL> |
||
| 349 | <HR> |
||
| 350 | |||
| 351 | <A NAME="setActor(com.badlogic.gdx.scenes.scene2d.Actor)"><!-- --></A><H3> |
||
| 352 | setActor</H3> |
||
| 353 | <PRE> |
||
| 354 | public void <B>setActor</B>(<A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d">Actor</A> actor)</PRE> |
||
| 355 | <DL> |
||
| 356 | <DD>Sets the actor this action will be used for. This is called automatically when an action is added to an actor. This is also |
||
| 357 | called with null when an action is removed from an actor. When set to null, if the action has a <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#setPool(com.badlogic.gdx.utils.Pool)"><CODE>pool</CODE></A> |
||
| 358 | then the action is <A HREF="../../../../../com/badlogic/gdx/utils/Pool.html#free(T)"><CODE>returned</CODE></A> to the pool (which calls <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#reset()"><CODE>reset()</CODE></A>) and the pool is set to null. |
||
| 359 | If the action does not have a pool, <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#reset()"><CODE>reset()</CODE></A> is called. |
||
| 360 | <p> |
||
| 361 | This method is not typically a good place for a subclass to query the actor's state because the action may not be executed |
||
| 362 | for some time, eg it may be <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/DelayAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions"><CODE>delayed</CODE></A>. The actor's state is best queried in the first call to |
||
| 363 | <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#act(float)"><CODE>act(float)</CODE></A>. For a <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/actions/TemporalAction.html" title="class in com.badlogic.gdx.scenes.scene2d.actions"><CODE>TemporalAction</CODE></A>, use TemporalAction#begin(). |
||
| 364 | <P> |
||
| 365 | <DD><DL> |
||
| 366 | </DL> |
||
| 367 | </DD> |
||
| 368 | <DD><DL> |
||
| 369 | </DL> |
||
| 370 | </DD> |
||
| 371 | </DL> |
||
| 372 | <HR> |
||
| 373 | |||
| 374 | <A NAME="reset()"><!-- --></A><H3> |
||
| 375 | reset</H3> |
||
| 376 | <PRE> |
||
| 377 | public void <B>reset</B>()</PRE> |
||
| 378 | <DL> |
||
| 379 | <DD>Resets the optional state of this action to as if it were newly created, allowing the action to be pooled and reused. State |
||
| 380 | required to be set for every usage of this action or computed during the action does not need to be reset. |
||
| 381 | <p> |
||
| 382 | The default implementation calls <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#restart()"><CODE>restart()</CODE></A>. |
||
| 383 | <p> |
||
| 384 | If a subclass has optional state, it must override this method, call super, and reset the optional state. |
||
| 385 | <P> |
||
| 386 | <DD><DL> |
||
| 387 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/badlogic/gdx/utils/Pool.Poolable.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../com/badlogic/gdx/utils/Pool.Poolable.html" title="interface in com.badlogic.gdx.utils">Pool.Poolable</A></CODE></DL> |
||
| 388 | </DD> |
||
| 389 | <DD><DL> |
||
| 390 | </DL> |
||
| 391 | </DD> |
||
| 392 | </DL> |
||
| 393 | <HR> |
||
| 394 | |||
| 395 | <A NAME="getPool()"><!-- --></A><H3> |
||
| 396 | getPool</H3> |
||
| 397 | <PRE> |
||
| 398 | public <A HREF="../../../../../com/badlogic/gdx/utils/Pool.html" title="class in com.badlogic.gdx.utils">Pool</A> <B>getPool</B>()</PRE> |
||
| 399 | <DL> |
||
| 400 | <DD><DL> |
||
| 401 | </DL> |
||
| 402 | </DD> |
||
| 403 | <DD><DL> |
||
| 404 | </DL> |
||
| 405 | </DD> |
||
| 406 | </DL> |
||
| 407 | <HR> |
||
| 408 | |||
| 409 | <A NAME="setPool(com.badlogic.gdx.utils.Pool)"><!-- --></A><H3> |
||
| 410 | setPool</H3> |
||
| 411 | <PRE> |
||
| 412 | public void <B>setPool</B>(<A HREF="../../../../../com/badlogic/gdx/utils/Pool.html" title="class in com.badlogic.gdx.utils">Pool</A> pool)</PRE> |
||
| 413 | <DL> |
||
| 414 | <DD>Sets the pool that the action will be returned to when removed from the actor. |
||
| 415 | <P> |
||
| 416 | <DD><DL> |
||
| 417 | </DL> |
||
| 418 | </DD> |
||
| 419 | <DD><DL> |
||
| 420 | <DT><B>See Also:</B><DD><A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Action.html#setActor(com.badlogic.gdx.scenes.scene2d.Actor)"><CODE>setActor(Actor)</CODE></A></DL> |
||
| 421 | </DD> |
||
| 422 | </DL> |
||
| 423 | <HR> |
||
| 424 | |||
| 425 | <A NAME="toString()"><!-- --></A><H3> |
||
| 426 | toString</H3> |
||
| 427 | <PRE> |
||
| 428 | public java.lang.String <B>toString</B>()</PRE> |
||
| 429 | <DL> |
||
| 430 | <DD><DL> |
||
| 431 | <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
||
| 432 | </DD> |
||
| 433 | <DD><DL> |
||
| 434 | </DL> |
||
| 435 | </DD> |
||
| 436 | </DL> |
||
| 437 | <!-- ========= END OF CLASS DATA ========= --> |
||
| 438 | <HR> |
||
| 439 | |||
| 440 | |||
| 441 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
||
| 442 | <A NAME="navbar_bottom"><!-- --></A> |
||
| 443 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
||
| 444 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
||
| 445 | <TR> |
||
| 446 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
||
| 447 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
||
| 448 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
||
| 449 | <TR ALIGN="center" VALIGN="top"> |
||
| 450 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
||
| 451 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
||
| 452 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
||
| 453 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Action.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
||
| 454 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
||
| 455 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
||
| 456 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
||
| 457 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
||
| 458 | </TR> |
||
| 459 | </TABLE> |
||
| 460 | </TD> |
||
| 461 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
||
| 462 | libgdx API</EM> |
||
| 463 | </TD> |
||
| 464 | </TR> |
||
| 465 | |||
| 466 | <TR> |
||
| 467 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 468 | PREV CLASS |
||
| 469 | <A HREF="../../../../../com/badlogic/gdx/scenes/scene2d/Actor.html" title="class in com.badlogic.gdx.scenes.scene2d"><B>NEXT CLASS</B></A></FONT></TD> |
||
| 470 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
||
| 471 | <A HREF="../../../../../index.html?com/badlogic/gdx/scenes/scene2d/Action.html" target="_top"><B>FRAMES</B></A> |
||
| 472 | <A HREF="Action.html" target="_top"><B>NO FRAMES</B></A> |
||
| 473 | <SCRIPT type="text/javascript"> |
||
| 474 | <!-- |
||
| 475 | if(window==top) { |
||
| 476 | document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
||
| 477 | } |
||
| 478 | //--> |
||
| 479 | </SCRIPT> |
||
| 480 | <NOSCRIPT> |
||
| 481 | <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
||
| 482 | </NOSCRIPT> |
||
| 483 | |||
| 484 | |||
| 485 | </FONT></TD> |
||
| 486 | </TR> |
||
| 487 | <TR> |
||
| 488 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 489 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
||
| 490 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
||
| 491 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
||
| 492 | </TR> |
||
| 493 | </TABLE> |
||
| 494 | <A NAME="skip-navbar_bottom"></A> |
||
| 495 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
||
| 496 | |||
| 497 | <HR> |
||
| 498 | |||
| 499 | <div style="font-size:9pt"><i> |
||
| 500 | Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com) |
||
| 501 | </i></div> |
||
| 502 | |||
| 503 | </BODY> |
||
| 504 | </HTML> |