Anzeigen:
Modul: Toplist

Eine Instanz einer Toplist repräsentiert eine eigene Topliste für einen bestimmten userPersistenceNumberKey.

Methoden

addLabelChangeListener

(
  • listener
)

Legt einen Change-Listener an, der jedes mal aufgerufen wird, wenn ein User einen neuen Anzeigenamen erhält.

Parameter:

Beispiel:

toplist.addLabelChangeListener(function(toplistLabelChangeEvent) {

    var user = toplistLabelChangeEvent.getUser();
    var newLabel = toplistLabelChangeEvent.getNewLabel();

    var bot = KnuddelsServer.getDefaultBotUser();

    bot.sendPublicMessage('°20BB°' + user + ' hat den neuen Rang _' + newLabel + '_ erreicht.');
});

addRankChangeListener

(
  • listener
)

Legt einen Change-Listener an, der jedes mal aufgerufen wird, wenn ein sich der Rang User eines Nutzers ändert.

Parameter:

Beispiel:

toplist.addRankChangeListener(function(toplistRankChangeEvent) {

    var user = toplistRankChangeEvent.getUser();

    if (toplistRankChangeEvent.getNewValue() > 1000)
    {
        var usersOvertook = toplistRankChangeEvent.getUsersOvertook();

        for (var i = 0; i < usersOvertook.length; i++)
        {
            var userOvertooked = usersOvertook[i];

            userOvertooked.sendPostMessage('Überholt', user + ' hat dich gerade überholt...');
        }
    }
});

getChatCommand

(
  • [user|userId]
)
String

Liefert den Befehl, der im Chat eingegeben werden kann, um diese Topliste zu öffnen. Wird ein User oder eine userId übergeben, so öffnet sich die Topliste mit diesem Nutzer im Fokus.

Parameter:

Rückgabewert:

getDisplayName

() String

Liefert den Anzeigenamen der Topliste.

Rückgabewert:

String:

Anzeigename der Topliste

getLabel

(
  • user|userId
)
String

Liefert den Anzeigenamen für den übergebenen User oder eine userId.

Parameter:

Rückgabewert:

String:

Anzeigename

getUserPersistenceNumberKey

() String

Liefert den userPersistenceNumberKey mit dem die Topliste erzeugt wurde.

Rückgabewert:

String:

userPersistenceNumberKey mit dem die Topliste erzeugt wurde

removeLabelChangeListener

(
  • listener
)

Löscht einen LabelChangeListener, der mit addLabelChangeListener erzeugt wurde.

Parameter:

Beispiel:

var labelChangeListener = function(toplistLabelChangeEvent) {  ...  }

toplist.addLabelChangeListener(labelChangeListener);

toplist.removeLabelChangeListener(labelChangeListener);

removeRankChangeListener

(
  • listener
)

Löscht einen RankChangeListener, der mit addRankChangeListener erzeugt wurde.

Parameter:

Beispiel:

var rankChangeListener = function(toplistRankChangeEvent) {  ...  }

toplist.addRankChangeListener(rankChangeListener);

toplist.removeRankChangeListener(rankChangeListener);