Difference between revisions of "Timer.delayedCall"

From GiderosMobile
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Timer]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate><br />
+
Provides a simple way to call a function after a set amount of time. This function returns the '''Timer''' object created inside.
Provides a simple way to call a function after a set amount of time. This function returns the<br />
+
<syntaxhighlight lang="lua">
[[[Timer]]] object created inside.<br />
 
<br /></translate>
 
<source lang="lua">
 
 
(Timer) = Timer.delayedCall(delay,func,data)
 
(Timer) = Timer.delayedCall(delay,func,data)
</source>
+
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''delay''': (number) <translate>Delay in miliseconds before the function is called</translate> <br/>
+
'''delay''': (number) delay in miliseconds before the function is called<br/>
'''func''': (function) <translate>Function to call</translate> <br/>
+
'''func''': (function) function to call<br/>
'''data''': (any) <translate>An optional data parameter that is passed as a first argument to the function</translate> '''optional'''<br/>
+
'''data''': (any) an optional data parameter that is passed as a first argument to the function '''optional'''<br/>
 +
 
 
=== Return values ===
 
=== Return values ===
'''Returns''' (Timer) <translate>The [[[Timer]]] object</translate><br/>
+
'''Returns''' (Timer) the Timer object<br/>
 +
 
 +
{{Timer}}

Latest revision as of 22:37, 24 August 2024

Available since: Gideros 2011.6
Class: Timer

Description

Provides a simple way to call a function after a set amount of time. This function returns the Timer object created inside.

(Timer) = Timer.delayedCall(delay,func,data)

Parameters

delay: (number) delay in miliseconds before the function is called
func: (function) function to call
data: (any) an optional data parameter that is passed as a first argument to the function optional

Return values

Returns (Timer) the Timer object