Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20240419-122957 (ChatServer: 20240419-122957)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    ToplistRankChangeEvent

    ToplistRankChangeEvent Klasse

    Modul: Toplist

    ToplistRankChangeEvents erhalten EventListener die bei einer Toplist mit der Methode addRankChangeListener erzeugt wurden, nachdem sich der Rang für einen User geändert hat.

    Das ToplistRankChangeEvent enthält alle wichtigen Daten, um auf die Änderung zu reagieren und den überholten Usern eine Nachricht zu senden.

    Methoden

    getNewRank

    () Number

    Liefert den neuen Toplisten-Rang, des Users.

    Rückgabewert:

    Number:

    Beispiel:

    var newRank = toplistRankChangeEvent.getNewRank(); // i.e.: 78

    getNewValue

    () Number

    Liefert den neuen Wert.

    Rückgabewert:

    Number:

    Beispiel:

    var newValue = toplistRankChangeEvent.getNewValue(); // i.e.: 100

    getOldRank

    () Number

    Liefert den Toplisten-Rang, den der User vor der Änderung hatte.

    Rückgabewert:

    Number:

    -1, falls der Nutzer vorher keinen Rang hatte.

    Beispiel:

    var oldRank = toplistRankChangeEvent.getOldRank(); // i.e.: 100

    getOldValue

    () Number

    Liefert den Wert, der vor der Änderung gespeichert war.

    Rückgabewert:

    Number:

    Beispiel:

    var oldValue = toplistRankChangeEvent.getOldValue(); // i.e.: 3

    getToplist

    () Toplist

    Liefert die zugehörige Toplist.

    Rückgabewert:

    Toplist:

    Beispiel:

    var toplist = toplistRankChangeEvent.getToplist();

    getUser

    () User

    Liefert den User für den das Event ausgelöst wurde.

    Rückgabewert:

    User:

    Beispiel:

    var user = toplistRankChangeEvent.getUser(); // i.e.: User:Brems

    getUsersOvertook

    () User[]

    Liefert die User, die bei dieser Änderung überholt worden sind.

    Achtung: Wenn mehr als 10 User überholt wurden, so liefert die Methode die besten 10 überholten User.

    Rückgabewert:

    User[]:

    Beispiel:

    var usersOvertook = toplistRankChangeEvent.getUsersOvertook(); // i.e.: [ User:Plex, User:Holgi ]