Knuddels User Apps - API Dokumentation

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

    • Knuddels
    User App Entwicklung
    API Dokumentation
    DiceConfigurationFactory

    DiceConfigurationFactory Klasse

    Modul: Dice

    Eine Instanz einer DiceConfigurationFactory kann zur Unterstützung genutzt werden, um eine DiceConfiguration zu erzeugen.

    Methoden

    addDice

    (
    • dice
    )

    Fügt der Konfiguration einen Würfel hinzu.

    Parameter:

    • dice Dice

      Würfel, der hinzugefügt werden soll.

    Beispiel:

    var diceConfigurationFactory = new DiceConfigurationFactory();

var dice = new Dice(10, 500);

diceConfigurationFactory.addDice(dice);

    computeCurrentDiceCount

    () Number

    Liefert die Anzahl der Würfel, die zur Konfiguration gehören.

    Rückgabewert:

    Number:

    Beispiel:

    var diceConfigurationFactory = new DiceConfigurationFactory();

var dice = new Dice(10, 500);

diceConfigurationFactory.addDice(dice);

diceConfigurationFactory.computeCurrentDiceCount(); // 10

    fromString

    (
    • diceConfigurationString
    )
    DiceConfiguration static

    Erzeugt eine Würfelkonfiguration.

    Parameter:

    • diceConfigurationString String

      Zeichenkette, wie sie zum normalen Würfeln im Chat benutzt wird.

    Rückgabewert:

    DiceConfiguration:

    Beispiel:

    var diceConfiguration = DiceConfigurationFactory.fromString('1w4 + 10w2');

    getDiceConfiguration

    () DiceConfiguration

    Liefert die erzeugte Würfelkonfiguration.

    Rückgabewert:

    DiceConfiguration:

    Beispiel:

    var diceConfigurationFactory = new DiceConfigurationFactory();

var dice = new Dice(10, 500);

diceConfigurationFactory.addDice(dice);

var diceConfiguration = diceConfigurationFactory.getDiceConfiguration();

    setShouldUsePrivateThrow

    (
    • shouldUsePrivateThrow
    )

    Setzt die Information, ob der Würfelwurf privat stattfinden soll.

    Parameter:

    Beispiel:

    var diceConfigurationFactory = new DiceConfigurationFactory();

var dice = new Dice(10, 500);

diceConfigurationFactory.addDice(dice);

diceConfigurationFactory.setShouldUsePrivateThrow(true);

    setUseOpenThrow

    (
    • shouldUseOpenThrow
    )

    Setzt die Information, ob ein offener Wurf oder ein normaler Wurf stattfinden soll. 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

    Parameter:

    Beispiel:

    var diceConfigurationFactory = new DiceConfigurationFactory();

var dice = new Dice(10, 500);

diceConfigurationFactory.addDice(dice);

diceConfigurationFactory.setUseOpenThrow(true);

    setUseOpenThrows

    (
    • shouldUseOpenThrow
    )
    Veraltet

    Veraltet: nun verfügbar via <code>diceConfigurationFactory.setUseOpenThrow()</code>

    Setzt die Information, ob ein offener Wurf oder ein normaler Wurf stattfinden soll. 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

    Parameter:

    Beispiel:

    var diceConfigurationFactory = new DiceConfigurationFactory();

var dice = new Dice(10, 500);

diceConfigurationFactory.addDice(dice);

diceConfigurationFactory.setUseOpenThrow(true);