Difference between revisions of "Core.yield"

From GiderosMobile
m
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
+
'''Available since:''' Gideros 2016.06<br/>
'''<translate>Available since</translate>:''' Gideros 2016.06<br/>
+
'''Class:''' [[Core]]<br/>
=== <translate>Description</translate> ===
+
 
<translate>Yield function running as background task.
+
=== Description ===
 +
Yields the function running as background task.
 +
<syntaxhighlight lang="lua">
 +
Core.yield(state)
 +
</syntaxhighlight>
  
 
Core.yield([number of seconds to wait])
 
Core.yield([number of seconds to wait])
 +
 
Core.yield(true) -- yield for a single frame and disable auto yield
 
Core.yield(true) -- yield for a single frame and disable auto yield
Core.yield(false) -- don't yield now, but reenable autoyield</translate>
+
 
<source lang="lua">
+
Core.yield(false) -- don't yield now, but reenable autoyield
Core.yield(state)
+
 
</source>
+
=== Parameters ===
=== <translate>Parameters</translate> ===
+
'''state''': (number or boolean) number of seconds to yield or boolean to enable/disable auto yield<br/>
'''state''': (number or boolean) <translate>number of seconds to yield or boolean to enable/disable auto yield</translate> <br/>
+
 
 +
{{Core}}

Latest revision as of 04:37, 2 November 2024

Available since: Gideros 2016.06
Class: Core

Description

Yields the function running as background task.

Core.yield(state)

Core.yield([number of seconds to wait])

Core.yield(true) -- yield for a single frame and disable auto yield

Core.yield(false) -- don't yield now, but reenable autoyield

Parameters

state: (number or boolean) number of seconds to yield or boolean to enable/disable auto yield