Gitiles
Code Review Sign In
gerrit.morgengrauen.info / mudlib-public / 141c6ddde21a6a8faebef845844944880dafc146 / . / doc / lfun / CheckSpellFatigue
blob: ac9d3fe4f1067e4b89efe23e39472aa6d75d22ed [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]1
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]2CheckSpellFatigue()
3*******************
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]4
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]5
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]6FUNKTION
7========
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]8
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]9 public varargs int CheckSpellFatigue(string key)
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]10
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]11
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]12DEFINIERT IN
13============
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]14
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]15 /std/living/skills.c
16 /std/player/skills.c
17 /sys/living/skills.h
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]18
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]19
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]20ARGUMENTE
21=========
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]22
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]23 string key : Eindeutiger Name des Spruches, einer Gruppe von Spruechen
24 oder 0 fuer die globale Spruchermuedung.
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]25
Zesstra953f9972017-02-18 15:37:36 +0100[diff] [blame]26
27BESCHREIBUNG
28============
29
30 Diese Funktion dient zum Pruefen von individuellen Spruchermuedungen
31 (Spellfatigue, Spruchsperren).
32 Hiermit lassen sich unabhaengige Ermuedungen/Sperren fuer einzelne
33 Sprueche oder Gruppen von Spruechen gestalten.
34
35 Wird <key> nicht angegeben oder ist 0, wird die globale Spruchsperre
36 geprueft (identisch zu der Property P_NEXT_SPELL_TIME), anderenfalls
37 die unter <key> gespeicherte Spruchermuedung.
38 Prueft man einen Eintrag ohne Angabe von <key> ist das Ergebnis dieser
39 Funktion identisch zur Abfrage von P_NEXT_SPELL_TIME.
40
41
42RUeCKGABEWERT
43=============
44
45 0 Spruchermuedung existiert nicht oder ist abgelaufen.
46
47 >0 Spruchermuedung ist noch nicht abgelaufen, Rueckgabewert ist die
48 Zeit, bei der dieser Eintrag ablaeuft. Der Spruch darf _nicht_
49 ausgefuehrt werden.
50
51
52BEISPIELE
53=========
54
55 Ein Spell gehoert zu einer Gruppe von Spells mit dem Namen 'extrasuess'.
56 Er darf nur ausgefuehrt werden, wenn seit 5s kein anderer Spruch aus der
57 Gruppe ausgefuehrt wurde.
58 if (ob->CheckSpellFatigue("extrasuess") {
59 // alte Sperre noch nicht abgelaufen.
60 tell_object(ob, "Deine unendliche Schokotorte ist noch nicht wieder "
61 "nachgewachsen.\n");
62 return ... ;
63 }
64
65
66BEMERKUNGEN
67===========
68
69 Die genauen Zeitdauern koennen von Spielern beeinflusst werden, sie
70 unterliegen der jeweiligen Einstellung von 'spruchermuedung', d.h. koennen
71 auf volle 2s aufgerundet werden.
72 Auch wenn diese Funktion zum Verwalten von beliebigen Zeitsperren genutzt
73 werden koennen, beschraenkt euch bitte auf Spruchermuedungen und benutzt
74 ansonsten check_and_update_timed_key(). Falls ihr diesbzgl. weitere/andere
75 Wuensche habt, sprecht den/die Mudlib-EM an.
76
77
78SIEHE AUCH
79==========
80
81 SetSpellFatigue(L), DeleteSpellFatigue(L)
82 P_NEXT_SPELL_TIME
83 spruchermuedung
84
MG Mud User88f12472016-06-24 23:31:02 +0200[diff] [blame]8527.03.2010, Zesstra