Difference between revisions of "Error"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2011.6<br/> | |
| − | ''' | + | '''Class:''' [[(global)]]<br/> |
| − | ''' | ||
| − | === | + | === Description === |
| − | + | Terminates the last protected function called and returns message as the error message. Function error never returns. | |
| + | <syntaxhighlight lang="lua"> | ||
| + | error(message,level) | ||
| + | </syntaxhighlight> | ||
| − | Usually, error adds some information about the error position at the beginning of the message. The level argument specifies how to get the error position. With level 1 (the default), the error position is where the error function was called. Level 2 points the error to where the function that called error was called; and so on. Passing a level 0 avoids the addition of error position information to the message. | + | Usually, error adds some information about the error position at the beginning of the ''message''. The ''level'' argument specifies how to get the error position. With level 1 (the default), the error position is where the error function was called. Level 2 points the error to where the function that called error was called; and so on. Passing a level 0 avoids the addition of error position information to the message. |
| − | |||
| − | |||
| − | |||
| − | === | + | === Parameters === |
| − | '''message''': (string) | + | '''message''': (string) error message<br/> |
| − | '''level''': (number) | + | '''level''': (number) the call stack level '''optional'''<br/> |
{{(global)}} | {{(global)}} | ||
Latest revision as of 14:27, 13 July 2023
Available since: Gideros 2011.6
Class: (global)
Description
Terminates the last protected function called and returns message as the error message. Function error never returns.
error(message,level)
Usually, error adds some information about the error position at the beginning of the message. The level argument specifies how to get the error position. With level 1 (the default), the error position is where the error function was called. Level 2 points the error to where the function that called error was called; and so on. Passing a level 0 avoids the addition of error position information to the message.
Parameters
message: (string) error message
level: (number) the call stack level optional
