RequestActionColor

 bool RequestActionColor (int $VariablenID, int $Farbwert) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Die Funktion führt die Aktion der Variable mit der ID VariablenID mit der Farbe Farbwert (Format 0xRRGGBB) aus. Sie verhält sich wie RequestAction, wandelt Farbwert vorher aber in das Format der Variable um – genau wie SetValueColor:

• Integer-Variablen: Der Aktion wird Farbwert unverändert übergeben.
• String-Variablen mit der Darstellung Farbe: Der Aktion wird das JSON-Objekt entsprechend dem Parameter ENCODING der Darstellung übergeben (RGB, CMYK, HSV, HSL oder xy, siehe Konstanten COLOR_ENCODING_*; die Felder sind bei SetValueColor beschrieben).

Ausgeführt wird die eigene Aktion der Variable (z.B. ein über IPS_SetVariableCustomAction gesetztes Aktionsskript), andernfalls die Standardaktion, üblicherweise die der übergeordneten Instanz. Im Aktionsskript steht $_IPS['SENDER'] = "Action" zur Verfügung, $_IPS['VALUE'] enthält den umgewandelten Wert. Im Gegensatz zu SetValueColor wird also das Gerät geschaltet; ob und wann der Wert der Variable aktualisiert wird, entscheidet die Aktion.

Die Umwandlung erfolgt vor dem Ausführen der Aktion: Verwendet eine String-Variable nicht die Darstellung Farbe, schlägt die Funktion mit "Variable does not use presentation Color" fehl. Bei einer unbekannten Kodierung schlägt sie mit "Invalid Color Encoding" fehl, ohne die Aktion auszuführen; bei Variablen vom Typ Boolean oder Float mit "Invalid Variable Type". Besitzt die Variable weder eine eigene noch eine Standardaktion, schlägt sie mit "No valid action available" fehl.

Beispiel

// Lampe auf Grün schalten
RequestActionColor(12345, 0x00FF00);