blob: e24b6ac2e3cd6ebf1f9484ac55430ea70121c9a7 [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +01001remove_multiple()
2=================
3
4FUNKTION
5--------
6::
7
8 public varargs int remove_multiple(int limit, mixed fun);
9
10DEFINIERT IN
11------------
12::
13
14 /std/container/items.c
15
16ARGUMENTE
17---------
18::
19
20 limit: Anzahl gleicher Objekte, die verbleiben sollen.
21 fun: Funktionsname (string) oder Closure.
22
23BESCHREIBUNG
24------------
25::
26
27 Wird diese Funktion aufgerufen, werden alle gleichen Objekte
28 (standardmaessig definiert als gleicher Ladename, gleiche
29 Kurzbeschreibung und gleiche Langbeschreibung), deren Anzahl <limit>
30 ueberschreitet, entfernt.
31
32
33
34 Ausnahmen: Lebewesen und per AddItem() hinzugefuegte Objekte.
35
36 Mit dem Argument <fun> lassen sich die Kriterien fuer die "Gleichheit"
37 aendern.
38 Ist <fun> ein Funktionsname, wird diese Funktion an allen in Frage
39 kommenenden Objekten im Container gerufen.
40 Ist <fun> eine Closure, werden sie fuer jedes in Frage kommende Objekt
41 einmal gerufen und ihr das Objekt uebergeben.
42 Als 'gleich' werden alle Objekte betrachtet, fuer die <fun> den gleichen
43 Wert zurueckliefert.
44 Objekte, fuer die <fun> 0 zurueckliefert, werden ignoriert.
45
46BEMERKUNGEN
47-----------
48::
49
50 1) Raeume rufen remove_multiple(3) standardmaessig im reset(), jedoch
51 nur, wenn kein Spieler anwesend ist und mehr als 10 Objekte im Raum
52 sind.
53 2) remove_multipe(0) entfernt alle entfernbaren Objekte (s. Ausnahmen).
54
55BEISPIELE
56---------
57::
58
59 Ein Container enthaelt 5 Fackeln. Im reset() ruft man nun
60 remove_multiple(3) auf. Anschliessend sind noch 3 Fackeln uebrig.
61
62
63
64 Alle verbleibenden Objekte im Container sollen unterschiedliche Namen
65 haben:
66 remove_multiple(1, "name");
67
68 Ein Container soll nur ein Objekt behalten, welches groesser als 70 cm
69 ist:
70 int groessen_filter(object ob) {
71 if (ob->QueryProp(P_SIZE > 70)) return 1;
72 return 0; // damit das Objekt ignoriert wird.
73 // Alternativ koennte man statt 0 auch object_name(ob) zurueckliefern,
74 // dann sind diese Objekte alle unterschiedlich.
75 }
76 ...
77 remove_multiple(1, #'groessen_filter);
78
79SIEHE AUCH
80----------
81::
82
83 reset()
84
8531.01.2009, Zesstra
86