Grundscriptsammlung: Unterschied zwischen den Versionen

Aus WKwiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: <!-- /\ -->)
 
K (Typo)
 
(8 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
<!-- /\ -->
__FORCETOC__
<!-- {| align="center" style="background: #FFD39B; border: 2px solid #FF7F24; padding: .2em; margin-bottom: 3px; width: 100%;"
| <span style="font-size: 22px;"><center>Die aktuell hochgeladene Grundscriptsammlung ist<br />'''fehlerhaft'''.</center></span>
|} -->
{| align="center" style="background: #D1E5D3; border: 2px solid #80B786; padding: .2em; margin-bottom: 3px; width: 100%;"
| <span style="font-size: 22px;"><center>Die aktuell hochgeladene Grundscriptsammlung ist<br />'''fehlerfrei'''.</center></span>
|}
Die Grundscriptsammlung ist eine Sammlung von Funktionen, die von [[Liste von Scripts für den Chat#Fußnoten|vielen anderen Scripts]] benötigt wird. Der Grund für diese Sammlung ist, dass bisher immer mehrere Versionen von einem Script benötigt wurden, abhängig davon, welche Scripts bereits in der Ankündigung vorhanden waren.
 
== Einbinden ==
Die Grundscriptsammlung ist auf jedem Chatserver unter <tt>[http://server3.webkicks.de/grundscripts.js http://serverX.webkicks.de/grundscripts.js]</tt> erreichbar. Eingebunden wird sie folgendermaßen:
<code>
<script type="text/javascript" src="/grundscripts.js"></script>
</code>
 
== Dokumentation ==
<!-- Mhmm... umformulieren -->
Im Nachfolgenden werden die Funktionen / vordefinierten Variabeln dokumentiert.
 
== Funktionen ==
 
=== strip_tags ===
:'''Erwartet''':
:#Einen String, der von HTML-Tags gesäubert werden soll.
:'''Rückgabe''':
::Der von HTML gesäuberte Text.
 
=== efIsLoad ===
:'''Rückgabe''':
::<tt>true</tt>, wenn der Eingabeframe geladen ist.
 
=== sendeText ===
:'''Erwartet''':
:#Der Text, der gesendet werden soll
:#''Der User, der den Text absenden soll (optional).''
:'''Anmerkungen''':
::Wenn der 2. Parameter weggelassen wird, senden alle User den Text, die diesen Befehl sehen können. <!-- Umformulieren -->
 
=== setCookie ===
:'''Erwartet''':
:#Den Namen des Cookies.
:#Den Wert des Cookies.
:#''Das Cookie-Ablaufdatum als [http://de.selfhtml.org/javascript/objekte/date.htm Date-Objekt] (optional).''
:'''Anmerkungen''':
::Das Cookie ist nur im aktuellen Chat verfügbar.
 
=== getCookie ===
:'''Erwartet''':
:#Den Namen des Cookies.
:'''Rückgabe''':
::Den Wert des Cookies (String).
 
=== lineData ===
:'''Erwartet''':
:#Eine Chatzeile ([http://de.selfhtml.org/javascript/objekte/node.htm Node-Objekt]).
:'''Rückgabe''':
::Ein Array mit folgenden Elementen (in dieser Reihenfolge):
::*Zeilentyp (Integer).
::*Uhrzeit, z. B. 16:26 (String).
::*Nick des Zeilenautors.
::*Der Zeilentext.
:'''Anmerkungen''':
::Das erste Array-Element enthält einen Integer, der einem Zeilentyp entspricht. Folgende Typen werden erkannt:
::*'''0''': Normale Chatzeile.
::*'''1''': Eine /me-Aktion oder ein selbsterstellter SE-Befehl.
::*'''2''': Eine spezielle Chatzeile nach dem Schema <tt>(UHRZEIT) USER TEXT</tt>, z. B. /wuerfel.
<!-- ... -->
 
=== getStatus ===
 
:Diese Funktion wird von der Grundscriptsammlung rekursiv aufgerufen, bis der Eingabeframe geladen ist. Die Variable <tt>[[#myStatus|myStatus]]</tt> wird durch diese Funktion definiert.
 
=== getMyNick ===
:Diese Funktion wird von der Grundscriptsammlung rekursiv aufgerufen, bis der Eingabeframe geladen ist. Die Variable <tt>[[#myNick|myNick]]</tt> wird durch diese Funktion definiert.
 
== Variablen ==
 
=== chatData ===
:Ein Array, das den Chatserver und den Chatnamen enthält.
 
=== stati ===
:Ein Array, das die Namen das verschiedenen Systemränge enthält (Gast, User, Moderator, Administrator).
 
=== myStatus ===
:Ein Integer, der den Systemrang darstellt.
:Diese Variable wird durch <tt>[[#getStatus|getStatus()]]</tt> definiert.
:*'''0''': Gast
:*'''1''': User
:*'''2''': Moderator
:*'''3''': Administrator
:In Kombination mit <tt>[[#stati|stati]]</tt> (<tt>stati[myStatus]</tt>) wird dem User der eigene Rang angezeigt.
:'''ACHTUNG''': Diese Variable ist auf Grund des rekursiven Aufrufs von <tt>[[#getStatus|getStatus()]]</tt> vielleicht nicht sofort verfügbar.
 
=== myNick ===
:Diese Variable enthält den eigenen Nick ohne HTML-Tags mit Groß-/Kleinschreibung.
:Diese Variable wird durch <tt>[[#getMyNick|getMyNick()]]</tt> definiert.
:'''ACHTUNG''': Diese Variable ist auf Grund des rekursiven Aufrufs von <tt>[[#getMyNick|getMyNick()]]</tt> vielleicht nicht sofort verfügbar.

Aktuelle Version vom 30. Oktober 2007, 11:29 Uhr

Die aktuell hochgeladene Grundscriptsammlung ist
fehlerfrei.

Die Grundscriptsammlung ist eine Sammlung von Funktionen, die von vielen anderen Scripts benötigt wird. Der Grund für diese Sammlung ist, dass bisher immer mehrere Versionen von einem Script benötigt wurden, abhängig davon, welche Scripts bereits in der Ankündigung vorhanden waren.

Einbinden

Die Grundscriptsammlung ist auf jedem Chatserver unter http://serverX.webkicks.de/grundscripts.js erreichbar. Eingebunden wird sie folgendermaßen: 

<script type="text/javascript" src="/grundscripts.js"></script>

Dokumentation

Im Nachfolgenden werden die Funktionen / vordefinierten Variabeln dokumentiert.

Funktionen

strip_tags

Erwartet:
  1. Einen String, der von HTML-Tags gesäubert werden soll.
Rückgabe:
Der von HTML gesäuberte Text.

efIsLoad

Rückgabe:
true, wenn der Eingabeframe geladen ist.

sendeText

Erwartet:
  1. Der Text, der gesendet werden soll
  2. Der User, der den Text absenden soll (optional).
Anmerkungen:
Wenn der 2. Parameter weggelassen wird, senden alle User den Text, die diesen Befehl sehen können.

setCookie

Erwartet:
  1. Den Namen des Cookies.
  2. Den Wert des Cookies.
  3. Das Cookie-Ablaufdatum als Date-Objekt (optional).
Anmerkungen:
Das Cookie ist nur im aktuellen Chat verfügbar.

getCookie

Erwartet:
  1. Den Namen des Cookies.
Rückgabe:
Den Wert des Cookies (String).

lineData

Erwartet:
  1. Eine Chatzeile (Node-Objekt).
Rückgabe:
Ein Array mit folgenden Elementen (in dieser Reihenfolge):
  • Zeilentyp (Integer).
  • Uhrzeit, z. B. 16:26 (String).
  • Nick des Zeilenautors.
  • Der Zeilentext.
Anmerkungen:
Das erste Array-Element enthält einen Integer, der einem Zeilentyp entspricht. Folgende Typen werden erkannt:
  • 0: Normale Chatzeile.
  • 1: Eine /me-Aktion oder ein selbsterstellter SE-Befehl.
  • 2: Eine spezielle Chatzeile nach dem Schema (UHRZEIT) USER TEXT, z. B. /wuerfel.

getStatus

Diese Funktion wird von der Grundscriptsammlung rekursiv aufgerufen, bis der Eingabeframe geladen ist. Die Variable myStatus wird durch diese Funktion definiert.

getMyNick

Diese Funktion wird von der Grundscriptsammlung rekursiv aufgerufen, bis der Eingabeframe geladen ist. Die Variable myNick wird durch diese Funktion definiert.

Variablen

chatData

Ein Array, das den Chatserver und den Chatnamen enthält.

stati

Ein Array, das die Namen das verschiedenen Systemränge enthält (Gast, User, Moderator, Administrator).

myStatus

Ein Integer, der den Systemrang darstellt.
Diese Variable wird durch getStatus() definiert.
  • 0: Gast
  • 1: User
  • 2: Moderator
  • 3: Administrator
In Kombination mit stati (stati[myStatus]) wird dem User der eigene Rang angezeigt.
ACHTUNG: Diese Variable ist auf Grund des rekursiven Aufrufs von getStatus() vielleicht nicht sofort verfügbar.

myNick

Diese Variable enthält den eigenen Nick ohne HTML-Tags mit Groß-/Kleinschreibung.
Diese Variable wird durch getMyNick() definiert.
ACHTUNG: Diese Variable ist auf Grund des rekursiven Aufrufs von getMyNick() vielleicht nicht sofort verfügbar.
Abgerufen von „http://wiki.webkicks.de/index.php?title=Grundscriptsammlung&oldid=2748“