| MG Mud User | 88f1247 | 2016-06-24 23:31:02 +0200 | [diff] [blame^] | 1 | |
| 2 | Dokumentation fuer das Std-Seil: /obj/seil.c |
| 3 | |
| 4 | Abhaengigkeiten: /sys/thing/seil.h |
| 5 | |
| 6 | Das Standard-Seil ermoeglichst das Festbinden und Loesen eines Seiles an |
| 7 | Objecten und Raeumen. Es kann im ganzen Morgengrauen verwendet werden. |
| 8 | |
| 9 | in den Objecten, die festgebunden werden, wird die Propertie P_TIED gesetzt. |
| 10 | Sie enthaelt ein Mappng der Form: |
| 11 | |
| 12 | ([ |
| 13 | |
| 14 | objectid: ([ "player" : playerid, "time" : timestamp ]) |
| 15 | |
| 16 | ]) |
| 17 | |
| 18 | Wenn ein Object festgebunden wird, so wird die Funktion tie() in dem Object |
| 19 | aufgerufen. Die Funktion muss in dem Object vorhanden sein. Liefert die |
| 20 | Funktion 1 zurueck, darf man ein Seil daran binden. |
| 21 | |
| 22 | Aus der Funktion heraus kann im Seil in der Propertie P_TIE_USER ausgelesen |
| 23 | werden, welche User die Aktion ausgeloest hat. |
| 24 | (Diese Daten werden aus Kompatibilitaetsgruenden nicht an die Fkt. direkt |
| 25 | uebergeben.) |
| 26 | |
| 27 | Wird ein Seil wieder losgebunden, so wird die Funktion |
| 28 | untie() |
| 29 | in dem Object aufgerufen. |
| 30 | |
| 31 | Damit ein Seil in einem Raum festgebunden werden kann, muss der Raum eine |
| 32 | id() bekommen - wie ein normales Object. |
| 33 | |
| 34 | In den Funktionen tie() und untie() kann jeweils ueberprueft werden, ob ein |
| 35 | Spieler ein Seil benutzen darf oder nicht. Liefern die Funktionen 0 zurueck, |
| 36 | so wird die Benutzung des Seiles verweigert. |
| 37 | |
| 38 | Die Funktion seil->query_tied_to_ob() liefert das Object zurueck, an welches |
| 39 | ein Seil gebunden ist oder 0; |
| 40 | |
| 41 | Bei der Benutzung eines Seiles im Raum wird zur Beschreibung die Funktion |
| 42 | name() aufgerufen. Es kann also P_NAME gesetzt werden oder direkt name() im |
| 43 | Raum ueberschrieben werden. |
| 44 | |
| 45 | Seile koennen ueber NPC's/Raeume und Zauber gesteuert werden: |
| 46 | |
| 47 | varargs int binde_seil(string ziel, string msg) |
| 48 | |
| 49 | Ziel beschreibt das Object oder Raum, wo es festgebunden werden soll |
| 50 | msg ist die Ausgabe. Wird msg nicht gesetzt, so wird eine |
| 51 | Standard-Ausgabe ausgegeben. |
| 52 | |
| 53 | varargs int loese_seil(string msg) |
| 54 | Das Seil wird geloest - es wird dabei die msg in den Raum |
| 55 | ausgegeben. Ist msg nicht definiert, wird eine Standardausgabe |
| 56 | erzeugt. |
| 57 | |
| 58 | |
| 59 | Beide Funktionen werden wir von enem Spieler behandelt - es werden tie() und |
| 60 | untie() in den festgebundenen Objecten ausgewertet. |
| 61 | |
| 62 | Eine weitere Propertie ist P_TIE_AUTO. |
| 63 | Dieser Wert steht per Default auf 1 und erlaubt damit eine automatische |
| 64 | Benutzung des Seiles ueber die Funktionen binde_seil() und loese_seil(). |
| 65 | Ist diese Propertie auf 0, so koennen nur Spieler das Seil benutzen. |
| 66 | |
| 67 | |
| 68 | Letzte Änderung: 25.6. Gando |