| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame^] | 1 | SYNOPSIS |
| 2 | mixed heart_beat_error(object culprit, string err, string prg, |
| 3 | string curobj, int line) |
| 4 | |
| 5 | DESCRIPTION |
| 6 | This function is called when a runtime error occurs while |
| 7 | executing the heart_beat() function of the object culprit. prg |
| 8 | is program where the actual error happened, in object curobj |
| 9 | at the given line. |
| 10 | |
| 11 | At time of call, the heart_beat has been turned off. |
| 12 | Return anything != 0 to restart the heart_beat in culprit. |
| 13 | |
| 14 | If culprit is a user, it should at least get the message ``You |
| 15 | have no heartbeat''. A more advanced handling would destruct |
| 16 | the offending object curobj and and allow the heartbeat to |
| 17 | restart. |
| 18 | |
| 19 | Note that prg denotes the program actually executed (which |
| 20 | might be an inherited one) whereas curobj is just the |
| 21 | offending object. |
| 22 | |
| 23 | SEE ALSO |
| 24 | set_heart_beat(E), heart_beat(A), runtime_error(M) |