Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20210901-201954 (ChatServer: 20210901-201954)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    Color

    Color Klasse

    Modul: Core

    Klasse, mit der serverseitige Farbobjekte erstellt werden können.

    Methoden

    asHexString

    () String

    Liefert die Farbe als Hex zurück: #RRGGBB oder #RRGGBBAA (wenn alpha != 255).

    Rückgabewert:

    String:

    Beispiel:

    var hex1 = Color.fromRGBA(0, 0, 255).asHexString(); // '#0000FF'
var hex2 = Color.fromRGBA(0, 255, 0, 255).asHexString(); // '#00FF00' alpha = 255 ist Standard
var hex3 = Color.fromRGBA(255, 0, 0, 128).asHexString(); // '#FF000080'

    asNumber

    () Number

    Liefert die numerische Repräsentation der Farbe zurück.

    Rückgabewert:

    Number:

    Beispiel:

    var color = Color.fromRGBA(0, 10, 20, 50);
color.asNumber();

    fromHexString

    (
    • value
    )
    Color static

    Erzeugt ein serverseitiges Color-Objekt aus der Hex-Repräsentation einer Farbe. Folgende Formate werden (mit und ohne '#') erkannt:

    • #RRGGBB - z.B. #FF0000 = rot (deckend)
    • #RRGGBBAA - z.B. #FF000080 = rot (50% transparent)
    • #RGB - dabei werden die Ziffern jeweils verdoppelt: '#123' == '#112233'
    • #RGBA - wie bei #RGB
    Wird ein ungültiger Wert übergeben, so gibt die Methode null zurück.

    Parameter:

    • value String

      Hex-Darstellung einer Farbe

    Rückgabewert:

    Color:

    Beispiel:

    var color1 = Color.fromHexString('000'); // schwarz
var color2 = Color.fromHexString('#000'); // schwarz
var color3 = Color.fromHexString('#0F08'); // grün (ca. 50%)
var color4 = Color.fromHexString('#FFFFFF'); // weiß
var color5 = Color.fromHexString('#0000FF40'); // blau (ca. 25%)
var color6 = Color.fromHexString('HALLO'); // null

    fromNumber

    (
    • value
    )
    Color static

    Erzeugt ein serverseitiges Color-Objekt aus der numerischen Repräsentation einer Farbe.

    Parameter:

    • value Number

      Zahl aus der die Farbe berechnet werden soll

    Rückgabewert:

    Color:

    Beispiel:

    var color = Color.fromNumber(1578521);

    fromRGB

    (
    • red
    • green
    • blue
    )
    Color static

    Erzeugt ein serverseitiges Color-Objekt mit RGB-Werten. Als Alpha-Wert wird automatisch 255 genutzt.

    Parameter:

    • red Number

      Rotwert (Ganzzahl zwischen 0 und 255)

    • green Number

      (Ganzzahl zwischen 0 und 255)

    • blue Number

      (Ganzzahl zwischen 0 und 255)

    Rückgabewert:

    Color:

    Beispiel:

    var color = Color.fromRGB(0, 200, 80);

    fromRGBA

    (
    • red
    • green
    • blue
    • alpha
    )
    Color static

    Erzeugt ein serverseitiges Color-Objekt mit RGBA-Werten.

    Parameter:

    • red Number

      Rotwert (Ganzzahl zwischen 0 und 255)

    • green Number

      (Ganzzahl zwischen 0 und 255)

    • blue Number

      (Ganzzahl zwischen 0 und 255)

    • alpha Number

      (Ganzzahl zwischen 0 und 255)

    Rückgabewert:

    Color:

    Beispiel:

    var color = Color.fromRGBA(0, 200, 80, 255);

    getAlpha

    () Number

    Liefert den Alpha-Wert der Farbe als Zahl zwischen 0 und 255. 255 ist deckend. 0 ist komplett transparent.

    Rückgabewert:

    Number:

    Beispiel:

    var color = Color.fromRGBA(0, 10, 20, 50);
var alpha = color.getAlpha(); // 50

    getBlue

    () Number

    Liefert den Blau-Anteil der Farbe als Zahl zwischen 0 und 255.

    Rückgabewert:

    Number:

    Beispiel:

    var color = Color.fromRGBA(0, 10, 20, 50);
var blue = color.getBlue(); // 20

    getGreen

    () Number

    Liefert den Grün-Anteil der Farbe als Zahl zwischen 0 und 255.

    Rückgabewert:

    Number:

    Beispiel:

    var color = Color.fromRGBA(0, 10, 20, 50);
var green = color.getGreen(); // 10

    getRed

    () Number

    Liefert den Rot-Anteil der Farbe als Zahl zwischen 0 und 255.

    Rückgabewert:

    Number:

    Beispiel:

    var color = Color.fromRGBA(0, 10, 20, 50);
var red = color.getRed(); // 0

    toKCode

    () String

    Liefert die Farbe als KCode zurück.

    Rückgabewert:

    String:

    Beispiel:

    var color = Color.fromRGBA(0, 10, 20, 50);
color.toKCode(); // '°[0,10,20,50]°'