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