| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame^] | 1 | SYNOPSIS |
| 2 | mixed prepare_destruct(object obj) |
| 3 | |
| 4 | DESCRIPTION |
| 5 | Prepare the destruction of the object obj. Return 0 if the |
| 6 | object is ready for destruction, any other value will abort |
| 7 | the attempt. If a string is returned, an error with the string |
| 8 | as message will be issued. |
| 9 | |
| 10 | The interpreter calls this function whenever an object shall |
| 11 | be destructed. It expects, that this function cleans the |
| 12 | inventory of the object, or the destruct will fail. |
| 13 | Furthermore, the function could notify the former inventory |
| 14 | objects that their holder is under destruction (useful to move |
| 15 | users out of rooms which re updated); and it could announce |
| 16 | systemwide the destruction(quitting) of users. |
| 17 | |
| 18 | Strange things will happen if the mastor object does not |
| 19 | provide this function. |
| 20 | |
| 21 | SEE ALSO |
| 22 | remove_player(M), destruct(E) |