blob: a443529ffe19eef05177720f6be22a519a4458e8 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SYNOPSIS
Zesstrad59c3892019-11-28 20:53:39 +01002 int remove_input_to(object player)
3 int remove_input_to(object player, string fun)
4 int remove_input_to(object player, closure fun)
Zesstra5481d492021-04-08 20:07:06 +02005 int remove_input_to(object player, object|lwobject fun)
Zesstra715ec202025-07-09 22:18:31 +02006 int remove_input_to(object player, object|lwobject ob, string fun)
MG Mud User88f12472016-06-24 23:31:02 +02007
Zesstra715ec202025-07-09 22:18:31 +02008DESCRIPTION
9 Remove a pending input_to from the interactive <player> object.
10 If the optional <fun> is not given, the most recently added input_to
11 is removed.
MG Mud User88f12472016-06-24 23:31:02 +020012
Zesstra715ec202025-07-09 22:18:31 +020013 If the optional <fun> is given, the efun tries to find and remove the
14 most recently added input_to matching the <fun> argument:
15 - <fun> is a string: the input_to functionname has to match
16 - <fun> is an object: the object the input_to function is bound to
17 has to match
18 - <fun> is a closure: the input_to closure has to match.
19 - <ob> and <fun> are given: both the object and the functionname
20 have to match
MG Mud User88f12472016-06-24 23:31:02 +020021
Zesstra715ec202025-07-09 22:18:31 +020022 Return 1 on success, or 0 on failure (no input_to found, object is
23 not interactive or has no input_to pending).
MG Mud User88f12472016-06-24 23:31:02 +020024
Zesstra715ec202025-07-09 22:18:31 +020025EXAMPLES
26 Remove all pending input_to from the current user, if any.
27 while (remove_input_to(this_interactive())) ;
MG Mud User88f12472016-06-24 23:31:02 +020028
Zesstra715ec202025-07-09 22:18:31 +020029HISTORY
30 Introduced in LDMud 3.2.9 / 3.3.119.
MG Mud User88f12472016-06-24 23:31:02 +020031
Zesstra715ec202025-07-09 22:18:31 +020032SEE ALSO
33 input_to(E), find_input_to(E), input_to_info(E), query_input_pending(E)