blob: 96426fa79fa75bf7a553cd23fa62767da2540a1f [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SYNOPSIS
Zesstrad59c3892019-11-28 20:53:39 +01002 int remove_call_out(string fun)
3 int remove_call_out(closure fun)
MG Mud User88f12472016-06-24 23:31:02 +02004
Zesstra715ec202025-07-09 22:18:31 +02005DESCRIPTION
6 Remove next pending call-out for function <fun> in the current
7 object, resp. the next pending call-out for closure <fun>.
8 The time left is returned.
MG Mud User88f12472016-06-24 23:31:02 +02009
Zesstra715ec202025-07-09 22:18:31 +020010 -1 is returned if there were no call-outs pending to this
11 function.
MG Mud User88f12472016-06-24 23:31:02 +020012
Zesstra715ec202025-07-09 22:18:31 +020013EXAMPLES
14 To remove every pending call-out to MyTimer() :
MG Mud User88f12472016-06-24 23:31:02 +020015
Zesstra715ec202025-07-09 22:18:31 +020016 while (remove_call_out("MyTimer") != -1) /* continue */ ;
MG Mud User88f12472016-06-24 23:31:02 +020017
Zesstra715ec202025-07-09 22:18:31 +020018HISTORY
19 Removing a call_out to a closure was introduced in 3.2.1@45.
MG Mud User88f12472016-06-24 23:31:02 +020020
Zesstra715ec202025-07-09 22:18:31 +020021SEE ALSO
MG Mud User88f12472016-06-24 23:31:02 +020022 call_out(E), call_out_info(E), find_call_out(E)