Modul: Dice

Eine Instanz von DiceConfiguration repräsentiert eindeutig eine Konfiguration zum würfeln. Wurde gewürfelt, so können die Konfigurationen verglichen werden, um zu prüfen, ob exakt die Würfel gewürfelt wurden, die gewürfelt werden sollten.

Methoden

equals

(
  • diceConfiguration
)
Boolean

Vergleicht, ob zwei Konfigurationen inhaltlich identisch sind

Parameter:

Rückgabewert:

Beispiel:

const wantedDiceConfiguration = DiceConfigurationFactory.fromString('10w2');

this.onUserDiced = function(diceEvent)
{
    var user = diceEvent.getUser();
    
    var diceResult = diceEvent.getDiceResult();
    var configuration = diceResult.getDiceConfiguration();
    
    if (!configuration.equals(wantedDiceConfiguration)) 
    {
        var diceLink = '°>' + wantedDiceConfiguration + '|"<°';
    
        user.sendPrivateMessage('Du hast nicht mit den richtigen Würfeln gewürfelt: ' + diceLink);
    }
};

getChatCommand

() String

Verfügbar ab Version AppServer 82248

Liefert den Befehl, der im Chat eingegeben werden kann, um einen Wurf auszuführen, der zur DiceConfiguration passt.

Neu ab 07.12.2021: Dem Link wird die App-UID angehängt, wodurch er in allen Channels funktioniert und der Wurf genau und nur dieser App per Methode onUserDiced mitgeteilt wird.

Rückgabewert:

Beispiel:

var chatCommand = diceConfiguration.getChatCommand(); // z.B.: /dice 10w2

getDices

() Dice[]

Liefert ein Array mit den Würfeln, mit denen gewürfelt wurde.

Rückgabewert:

Beispiel:

var dices = diceConfiguration.getDices(); // z.B.: [ Dice, Dice, Dice ]

isUsingOpenThrow

() Boolean

Informiert, ob es sich um einen offenen Würfelwurf handelt. Offene Würfelwürfe sind speziell. Falls die Augenzahl des Würfels die Maximalsumme zeigt, so wird noch einmal gewürfelt und die neue Zahl dazu addiert, solange bis der Würfel nicht mehr die Maximalsumme zeigt.

Beispiel: /diceo 1w4 -> 4 -> 4 -> 3 = 11

Rückgabewert:

Beispiel:

var openThrow = diceConfiguration.isUsingOpenThrow(); // z.B.: false

isUsingPrivateThrow

() Boolean

Informiert darüber, ob die Würfel privat geworfen worden sind. Würfelwürfe zählen als privat, wenn am Ende des Würfelbefehls ein Ausrufezeichen steht. Beispiel: /dice 10w2!

Rückgabewert:

Beispiel:

var privateThrow = diceConfiguration.isUsingPrivateThrow(); // z.B.: false

toString

() String

Verfügbar ab Version AppServer 108781

Liefert eine textuelle Darstellung der Würfel-Konfiguration.

Rückgabewert:

String:

z.B. "5W5 + W6"

Beispiel:

        this.onUserDiced = function(diceEvent) {
            var diceConfiguration = diceEvent.getDiceResult().getDiceConfiguration();
            diceEvent.getUser().sendPrivateMessage('onUserDiced: ' + diceConfiguration);
            // toString() wird bei String-Verkettung automatisch aufgerufen
        };