| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 1 | SYNOPSIS |
| 2 | int remove(void) |
| 3 | |
| 4 | DESCRIPTION |
| 5 | remove() does some housekeeping to ensure consistency and then |
| 6 | destructs the current object. |
| 7 | |
| 8 | This lfun is not applied by the parser, but by other objects |
| 9 | to tell the current object to self-destruct. remove() should |
| Zesstra | 7ea4a03 | 2019-11-26 20:11:40 +0100 | [diff] [blame] | 10 | be supplied by the base classes of the library. Return 1 if |
| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame] | 11 | actually self-destructed, 0 otherwise. |
| 12 | |
| 13 | An alternative way to ensure the housekeeping on destruction |
| 14 | is through the use of the master apply prepare_destruct(). |
| 15 | |
| 16 | NOTE |
| 17 | Your actual mudlib may name this lfun differently, "remove()" is |
| 18 | just the traditional name. |
| 19 | |
| 20 | SEE ALSO |
| 21 | destruct(E), prepare_destruct(M) |