Knuddels User Apps - API Dokumentation

  • Dokumentation für Version 20210331-161748 (ChatServer: 20210331-161748)

    • Knuddels
    User App Entwicklung
    API Dokumentation
    Color

    Color Klasse

    Modul: Core

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

    Übersicht

    Methoden

    Methoden

    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();

    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.

    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]°'