Anzeigen:
Modul: Knuddel

Eine Instanz von KnuddelAccount ermöglicht den Zugriff auf die freigegebenen Knuddel eines bestimmten User. Knuddel können abgezogen und addiert werden.

Methoden

getKnuddelAmount

() KnuddelAmount

Liefert den KnuddelAmount eines Users, über den die App gerade frei verfügen kann.

Rückgabewert:

Beispiel:

 var knuddelAccount = user.getKnuddelAccount();
 
 var knuddelAmount = knuddelAccount.getKnuddelAmount();

getKnuddelAmountUnused

() KnuddelAmount

Liefert den KnuddelAmount aus dem KnuddelAccount, der noch nicht von der App genutzt wurde. Beim Auszahlen dieser Knuddel aus dem KnuddelAccount an den User fallen keine Steuern an.

Rückgabewert:

Beispiel:

var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountUnused = knuddelAccount.getKnuddelAmountUnused();

getKnuddelAmountUsed

() KnuddelAmount

Liefert den KnuddelAmount aus dem KnuddelAccount, der bereits von der App genutzt wurde. Beim Auszahlen dieser Knuddel aus dem KnuddelAccount an den User fallen Steuern an.

Rückgabewert:

Beispiel:

var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountUsed = knuddelAccount.getKnuddelAmountUsed();

getTotalKnuddelAmountAppToUser

() KnuddelAmount

Liefert die Summe aller Transfers, die die App an diesen KnuddelAccount bzw. User überwiesen hat.

Rückgabewert:

Beispiel:

var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountAppToUser = knuddelAccount.getTotalKnuddelAmountAppToUser();

getTotalKnuddelAmountUserToApp

() KnuddelAmount

Liefert die Summe aller Transfers, die die App von diesem KnuddelAccount bzw. User abgebucht/erhalten hat.

Rückgabewert:

Beispiel:

var knuddelAccount = user.getKnuddelAccount();

var knuddelAmountUserToApp = knuddelAccount.getTotalKnuddelAmountUserToApp();

getUser

() User

Liefert den Nutzer, dem der KnuddelAccount gehört.

Rückgabewert:

User:

Beispiel:

var knuddelAccount = user.getKnuddelAccount();

var knuddelAccountUser = knuddelAccount.getUser();

hasEnough

(
  • knuddelAmount
)
Boolean

Liefert die Information, ob in diesem Moment genug Knuddel verfügbar sind.

Parameter:

Rückgabewert:

Beispiel:

var knuddelAccount = user.getKnuddelAccount();

var knuddelAmoundNeeded = new KnuddelAmount(10);

var hasEnough = knuddelAccount.hasEnough(knuddelAmoundNeeded);

use

(
  • knuddelAmount
  • displayReasonText
  • [parameters]
)

Versucht eine bestimmte Menge Knuddel zu verwenden. Dies ist nur möglich, wenn der User auf seinem KnuddelAccount genug Knuddel besitzt und online im Channel ist. Vom KnuddelAccount des Besitzer des Channel können Knuddel auch abgebucht werden, wenn dieser nicht im Channel online ist.

Ist das Event App.onBeforeKnuddelReceived implementiert, so wird diese direkt nach dem use aufgerufen, um zu entscheiden, ob die Knuddel angenommen werden sollen.



Hinweis: Knuddel an einen Nutzer senden kannst du mit der Methode transferKnuddel.

Parameter:

  • knuddelAmount KnuddelAmount
  • displayReasonText String

    für die Anzeige im /knuddelaccount-Kontoauszug.

  • [parameters] Object optional
    • [transferReason] String optional

      transferReason, intern für die App.

    • [onError] Function optional

      Callback, der aufgerufen wird, falls das Nutzen der Knuddel fehlschlägt.

    • [onSuccess] Function optional

      Callback, der aufgerufen wird, falls das Nutzen der Knuddel erfolgreich ist.

Beispiel:

var knuddelAmount = new KnuddelAmount(1);

var useOptions = {
    onError: function()
    {
        KnuddelsServer.getDefaultLogger().info('Knuddel abbuchen fehlgeschlagen.');
    },
    onSuccess: function()
    {
        KnuddelsServer.getDefaultLogger().info('Knuddel abbuchen erfolgreich.');
    }
}

knuddelAccount.use(knuddelAmount, 'Spiel starten', useOptions);