KnuddelPot Klasse Feedback
Repräsentiert einen KnuddelPot. Ein KnuddelPot kann nur durch Factory-Methoden des KnuddelsServer erzeugt werden: createKnuddelPot.
Wird die App heruntergefahren, so werden alle KnuddelPots, die nicht gesealt sind automatisch refunded.
Übersicht
Methoden
addWinner Feedback
-
user
-
[weight]
Fügt einen Gewinner in die Liste der Gewinner hinzu. Der zweite Parameter ist die Gewichtung mit der ausgezahlt werden soll. Wird der Parameter weggelassen, so ist er automatisch 1.
Beispiel:
var participants = knuddelPot.getParticipants();
var winner = RandomOperations.getRandomObject(participants);
knuddelPot.addWinner(winner);
var reason = 'Das Spiel ist vorbei. ' + winner + ' ist als Sieger daraus hervorgegangen.'
knuddelPot.payout(reason);
getFeeMultiplier Feedback
() NumberLiefert den mit setFee gesetzten Multiplikator der Gebühr.
Rückgabewert:
Beispiel:
var feeMultiplier = knuddelPot.getFeeMultiplier(); // i.e.: 0.05
getFeeUser Feedback
() UserRückgabewert:
Beispiel:
var feeUser = knuddelPot.getFeeUser(); // i.e.: User:MyAppBot
getId Feedback
() NumberLiefert die id des KnuddelPot.
Rückgabewert:
id
Beispiel:
var potId = knuddelPot.getId(); // i.e.: 11
getKnuddelAmountPerParticipant Feedback
() KnuddelAmountLiefert den beim Kreieren des KnuddelPots festgelegten KnuddelAmount, den jeder Teilnehmer zahlen muss.
Rückgabewert:
Beispiel:
var knuddelAmount = knuddelPot.getKnuddelAmountPerParticipant();
getKnuddelAmountTotal Feedback
() KnuddelAmountLiefert den KnuddelAmount, der bisher insgesamt in den KnuddelPot eingezahlt wurde.
Rückgabewert:
Beispiel:
var getKnuddelAmountTotal = knuddelPot.getKnuddelAmountTotal();
getMaxFeeMultiplier Feedback
() NumberLiefert den höchsten Multiplikator, der gültig ist.
Rückgabewert:
Beispiel:
var maxFeeMultiplier = knuddelPot.getMaxFeeMultiplier(); // i.e. 0.25
var botUser = KnuddelsServer.getDefaultBotUser();
knuddelPot.setFee(botUser, maxFeeMultiplier);
getParticipants Feedback
() User[]Liefert die Liste der Teilnehmer, die bisher in den KnuddelPot eingezahlt haben.
Rückgabewert:
Beispiel:
var participants = knuddelPot.getParticipants();
participants.forEach(function(user)
{
participants.sendPrivateMessage('Das Spiel wurde gestartet.');
});
getState Feedback
() KnuddelPotStateLiefert den Status des KnuddelPot.
Rückgabewert:
state
Beispiel:
var state = knuddelPot.getState(); // i.e.: KnuddelPotState.Open
payout Feedback
-
[text]
Zahlt den KnuddelPot an die mit addWinner gesetzten Gewinner aus.
Parameter:
-
[text]
String optional
Beispiel:
var participants = knuddelPot.getParticipants();
var winner = RandomOperations.getRandomObject(participants);
knuddelPot.addWinner(winner);
var reason = 'Das Spiel ist vorbei. ' + winner + ' ist als Sieger daraus hervorgegangen.'
knuddelPot.payout(reason);
refund Feedback
-
[reason]
Bezahlt alle Einsätze an die Teilnehmer zurück und informiert mit dem übergeben Text über den Grund.
Parameter:
-
[reason]
String optional
Beispiel:
knuddelPot.refund('Die App fährt gleich für ein Update herunter.');
seal Feedback
()Versiegelt den KnuddelPot, sodass keine weiteren Einzahlungen vorgenommen werden können und Gewinne ausgeschüttet werden können.
Beispiel:
var state = knuddelPot.getState();
if (state == KnuddelPotState.Open)
{
knuddelPot.seal();
}
else
{
// Bereits versiegelt oder ausgezahlt...
}
setFee Feedback
-
feeUser
-
feeMultiplier
Setzt den BotUser, der den Anteil der Einzahlungen nach dem Spiel erhält und den Anteil, vom Gesamtpot, den er erhalten soll.
Parameter:
-
feeUser
BotUser -
feeMultiplier
Number- zwischen 0 und getMaxFeeMultiplier
Beispiel:
var bot = KnuddelsServer.getDefaultBotUser();
var fee = 0.1;
knuddelPot.setFee(bot, fee);