Difference between revisions of "Thread:setFunction"

From GiderosMobile
(removed language stuff)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' 2018.10<br/>
'''<translate>Available since</translate>:''' 2018.10<br/>
+
'''Class:''' [[Thread]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Thread|Thread]]<br/>
 
  
=== <translate>Description</translate> ===
+
=== Description ===
<translate>Sets Lua function that thread will execute. Will return false if the function cannot be set because the thread is
+
Sets a Lua function that thread will execute. Will return false if the function cannot be set because the thread is
 
currently running or suspended.
 
currently running or suspended.
</translate><br/>
+
<source lang="lua">
<source lang="lua">local ok = thread:setFunction(func)</source>
+
local ok = thread:setFunction(func)
 +
</source>
  
=== <translate>Parameters</translate> ===
+
=== Parameters ===
'''func: ''' ''(function)''  <translate>Lua code to run in thread.</translate><br/>
+
'''func: ''' ''(function)''  Lua code to run in thread<br/>
=== <translate>Return values</translate> ===
+
 
'''ok: ''' ''(boolean)''  <translate>success or failure</translate><br/>
+
=== Return values ===
 +
'''ok: ''' ''(boolean)''  success or failure<br/>
  
 
{{Thread}}
 
{{Thread}}

Revision as of 18:09, 25 April 2021

Available since: 2018.10
Class: Thread

Description

Sets a Lua function that thread will execute. Will return false if the function cannot be set because the thread is currently running or suspended.

local ok = thread:setFunction(func)

Parameters

func: (function) Lua code to run in thread

Return values

ok: (boolean) success or failure