pxt-calliope/docs/reference/control/panic.md

40 lines
1.1 KiB
Markdown

# panic
Display an error number and stop the program.
```sig
control.panic(0)
```
If your board has some way to display error information, ``||control:panic||`` will work
with it to show error numbers.
Your program stops when you use ``||control:panic||``. Use this when you think something bad enough has
happened and your program can't run properly anymore.
## Parameters
* **code**: an error [number](/types/number) you match to an error situation in your program.
### ~hint
**System error codes**
The @boardname@ has error codes reserved for use by the system software. The ```panic()``` function is for advanced usage only. You must carefully chose an error code that doesn't match one currently used by the @boardname@ system.
### ~
## Example
Send a 'code red' error that you created to the error display if the input from pin `P0` is lower than `10`.
```blocks
let codeRed = 1110;
let codeBlue = 1111;
if (pins.analogReadPin(AnalogPin.P0) < 10) {
control.panic(codeRed)
}
```
## See also
[assert](/reference/control/assert), [error codes](/device/error-codes)