blob: 170e8b19dc54c3bc8048f3290d4cbefb5990096a [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001RegisterHelperNPC()
2FUNKTION:
3 public int RegisterHelperNPC(object npc, int flags);
4
5DEFINIERT IN:
6 /std/player/combat.c
7 /sys/living/combat.h
8
9ARGUMENTE:
10 object npc
11 Objekt des helfenden NPC, der angemeldet werden soll.
12
13 int flags
14 ver-oder-te Konstanten, die die Art des Helfer-NPC beschreiben (s.u.)
15
16BESCHREIBUNG:
17 Mit dieser Funktion wird ein einem Spieler helfender NPC im Spieler
18 angemeldet. Hierdurch kann spaeter herausgefunden werden, welche NPC
19 einem Spieler helfen und ggf. den von diesen verursachten Schaden im
20 Kampf dem Spieler zuzurechnen.
21
22 Die Flags sind eine der folgenden Konstanten oder eine beliebige durch
23 ver-oder-ung gebildete Kombination.
24
25 Momentan gibt es 2 Klassen von Helfer-NPC:
26 + GUILD_HELPER: der Helfer-NPC ist ein Gilden-NPC
27 + MISC_HELPER: der Helfer-NPC ist irgendein NPC, der nicht zu einer Gilde
28 gehoert.
29
30 Zusaetzlich zu den Klassen gibt es noch weitere Flags, die etwas ueber
31 den Helfer-NPC sagen:
32
33 + EXCLUSIVE_HELPER: dieser Helfer-NPC duldet keinen weiteren NPC der
34 gleichen Klasse.
35 + ACTIVE_HELPER: ist dieses Flag gesetzt, ist der NPC mehr als nur reiner
36 Schlagfaenger.
37
38 Wird EXCLUSIVE_HELPER gesetzt und es ist in der gleichen Klasse schon ein
39 NPC angemeldet, schlaegt die Registrierung fehl.
40 Ist in der gleichen Klasse bereits ein NPC mit EXCLUSIVE_HELPER
41 angemeldet, schlaegt die Registierung ebenfalls fehl, auch wenn der neue
42 NPC kein EXCLUSIVE_HELPER setzt.
43
44RUeCKGABEWERT:
45 1, wenn die Registrierung erfolgreich war.
46 0 sonst. In diesem Fall darf der NPC dem Spieler NICHT helfen, weder
47 passiv (Schlagfaenger), noch aktiv.
48
49BEMERKUNGEN:
50 Diese Funktion setzt bei der Erfolg die Property P_HELPER_NPC in <npc>
51 auf passende Werte.
52 Bitte auf gar keinen Fall die numerischen Werte der Konstanten fuer
53 <flags> nutzen, diese koennen sich jederzeit aendern.
54
55BEISPIELE:
56 1. Ein nicht-exklusiver Gilden-NPC, der dem Spieler folgt.
57 if (spieler->RegisterHelperNPC(this_object(), GUILD_HELPER) == 1) {
58 move(environment(spieler), M_GO);
59 spieler->AddPursuer(this_object());
60 // meldung ausgebene...
61 }
62
63 2a. Ein exklusiver Nicht-Gilden-NPC
64 if (spieler->RegisterHelperNPC(this_object(),
65 MISC_HELPER|EXCLUSIVE_HELPER) == 1) {
66 move(environment(spieler), M_GO);
67 }
68
69 2b. Ein nicht-exklusiver Nicht-Gilde-NPC, der nach 2a. kommt.
70 if (spieler->RegisterHelperNPC(this_object(), MISC_HELPER) == 1) {
71 // ... wenn der NPC aus 2a noch existiert, trifft dies hier nie zu.
72 }
73
74 3. Ein exklusiver NPC, der weitere Gilden- und sonstige NPC ausschliesst
75 (Solche Kombination bitte mit der Gilden-Balance abstimmen.)
76 if (spieler->RegisterHelperNPC(this_object(),
77 MISC_HELPER|GUILD_HELPER|EXCLUSIVE_HELPER) == 1) {
78 move(environment(spieler), M_GO);
79 }
80
81 4. Die Registrierung ohne Klasse schlaegt fehl, z.B.:
82 spieler->RegisterHelperNPC(this_object(), 0);
83 spieler->RegisterHelperNPC(this_object(), EXCLUSIVE_HELPER);
84
85SIEHE AUCH:
86 UnregisterHelperNPC()
87 P_HELPER_NPC