blob: 8fc3cbbcf1bd17a0638546965d2b7c35280dd669 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SYNOPSIS
Zesstra85136122021-05-08 20:32:01 +02002 void reset()
MG Mud User88f12472016-06-24 23:31:02 +02003
4DESCRIPTION
5 The H_RESET hook defines the function or closure to be called
6 when the driver needs to reset an object. In older drivers
7 this was hardwired to the lfun reset(), and a lot of hook
8 implementations still follow this tradition.
9
MG Mud User88f12472016-06-24 23:31:02 +020010 reset() will be called only in objects that have been used
11 since the last call to reset(), i.e. a function in them was
12 called (other than reset() or clean_up()), or it was moved
13 around.
14
15 This function can be used to reset the state of the object or
16 do some checks or what ever. The game wouldn't be fun if no
17 challenges remained.
18
Zesstra85136122021-05-08 20:32:01 +020019HISTORY
20 LDMud 3.2.1 allowed any other lfun to be called.
21 LDMud 3.6.5 removed the argument given.
MG Mud User88f12472016-06-24 23:31:02 +020022
23SEE ALSO
24 clean_up(A), heart_beat(A), call_out(E), create(A), __INIT(A),
25 reset(H), hooks(C), initialisation(M), native(C)