Difference between revisions of "Pcall"
(added example) |
|||
| (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:''' [[ | + | '''Class:''' [[(global)]]<br/> |
=== Description === | === Description === | ||
| − | Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated | + | Calls function ''f'' with the given arguments in protected mode. This means that any error inside ''f'' is not propagated, instead '''pcall''' catches the error and returns a status code. |
| − | < | + | <syntaxhighlight lang="lua"> |
(bool), (any) = pcall(f,arg1,arg2,...) | (bool), (any) = pcall(f,arg1,arg2,...) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, '''pcall''' also returns all results from the call, after this first result. In case of any error, '''pcall''' returns false plus the "''error''" message. | ||
=== Parameters === | === Parameters === | ||
| − | '''f''': (function) function to call in protected mode <br/> | + | '''f''': (function) function to call in protected mode<br/> |
'''arg1''': (any) argument to pass to the function '''optional'''<br/> | '''arg1''': (any) argument to pass to the function '''optional'''<br/> | ||
'''arg2''': (any) argument to pass to the function '''optional'''<br/> | '''arg2''': (any) argument to pass to the function '''optional'''<br/> | ||
| Line 21: | Line 22: | ||
=== Example === | === Example === | ||
| − | < | + | <syntaxhighlight lang="lua"> |
| − | local | + | function isValidTexture() |
| − | local result, | + | local result, value = pcall(Texture.new, "gfx/btns/end_down.png") |
| − | print(result, | + | return result, value |
| − | </ | + | end |
| + | |||
| + | local bmp | ||
| + | |||
| + | local result, value = isValidTexture() | ||
| + | if result then | ||
| + | bmp = Bitmap.new(value) | ||
| + | stage:addChild(bmp) | ||
| + | else | ||
| + | print(result, value) | ||
| + | end | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === See Also === | ||
| + | '''[[Assert]]''' | ||
{{(global)}} | {{(global)}} | ||
Latest revision as of 10:54, 5 October 2023
Available since: Gideros 2011.6
Class: (global)
Description
Calls function f with the given arguments in protected mode. This means that any error inside f is not propagated, instead pcall catches the error and returns a status code.
(bool), (any) = pcall(f,arg1,arg2,...)
Its first result is the status code (a boolean), which is true if the call succeeds without errors. In such case, pcall also returns all results from the call, after this first result. In case of any error, pcall returns false plus the "error" message.
Parameters
f: (function) function to call in protected mode
arg1: (any) argument to pass to the function optional
arg2: (any) argument to pass to the function optional
...: (any) other optional arguments optional
Return values
Returns (bool) false if there was error, true if function call succeeded
Returns (any) all the results that function returns
Example
function isValidTexture()
local result, value = pcall(Texture.new, "gfx/btns/end_down.png")
return result, value
end
local bmp
local result, value = isValidTexture()
if result then
bmp = Bitmap.new(value)
stage:addChild(bmp)
else
print(result, value)
end
See Also
