Gitiles
Code Review Sign In
gerrit.morgengrauen.info / mudlib-public / ea699e2f3eeb7deaedabaf285bf0724567bd36f5 / . / doc / sphinx / lfun / RemoveExtraLook.rst
blob: ed2c04b0f93b7479611bb0f3c6362c07465858b0 [file] [log] [blame]
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]1RemoveExtraLook()
2=================
3
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]4FUNKTION
5--------
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]6
Bugfix0c843462017-05-30 18:46:12 +0200[diff] [blame]7int RemoveExtraLook(string key);
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]8
9DEFINIERT IN
10------------
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]11 /std/living/description.c
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]12
13ARGUMENTE
14---------
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]15 - string key:
16 Schluessel, unter dem der Extralook registriert wurde ODER
17 Objektname des registrierenden Objektes
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]18
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]19BESCHREIBUNG
20------------
21 Der Extralook erscheint in der Langbeschreibung des Lebewesens.
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]22
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]23 Eintraege koennen mit dieser Funktion (vorzeitig) wieder entfernt
24 werden. Dazu wird entweder der selbst festgelegte Schluessel oder
25 der implizite Schluessel `object_name()` des setzenden Objekts
26 benoetigt.
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]27
28BEMERKUNGEN
29-----------
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]30 Beim Entfernen mit dieser Funktion wird die "Endemeldung" des entfernten
31 Eintrages nicht ausgegeben.
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]32
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]33RUECKGABEWERTE
34--------------
35 Siehe auch /sys/living/description.h fuer Konstanten.
36
37 - 1, falls der Eintrag erfolgreich entfernt wurde.
38 - < 0 sonst.
39
40 - -1: keinen (gueltigen) <key> uebergeben.
41 - -2: kein Eintrag fuer <key> gefunden.
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]42
43BEISPIELE
44---------
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]45
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]46.. code-block:: pike
47
48 // (1) Loeschen ueber expliziten Key
49 living->AddExtraLook(
50 "@WER1 wird von einer Horde Daemonen verfolgt.",
51 1800, "ennox_daemonenhordenverfolgerlook");
52
53 // Nun kann der Eintrag auch wieder entfernt werden:
54 living->RemoveExtraLook("ennox_daemonenhordenverfolgerlook");
55
56.. code-block:: pike
57
58 // (2) Loeschen ueber impliziten Objektnamen-Schluessel
59 living->AddExtraLook("Eine Sonnenblume ragt aus dem Ohr.")
60 // das ist nur aus dem gleichen Objekt heraus moeglich:
61 living->RemoveExtraLook(0);
62
63.. code-block:: pike
64
65 // (3) Loeschen ueber impliziten Objektnamen-Schluessel
66 string implizite_id = object_name(this_object());
67 living->AddExtraLook("Eine Sonnenblume ragt aus dem Ohr.")
68 // diese ID kann man natuerlich durch die Gegend schicken
69 living->RemoveExtraLook(implizite_id);
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]70
71SIEHE AUCH
72----------
Zesstra18626972017-01-31 10:38:27 +0100[diff] [blame]73
Christian Georg Beckerea699e22017-06-16 23:48:17 +0200[diff] [blame^]74 Verwandt:
75 :doc:`AddExtraLook`, :doc:`../props/P_INTERNAL_EXTRA_LOOK`
76 Sonstiges:
77 :doc:`../sefun/replace_personal`, :doc:`../sefun/break_string`
78 Fuer Spielerobjekte:
79 :doc:`../props/P_EXTRA_LOOK`
80
8115. Jun 2017 Gloinson