RamState

Represents a state used in a status, like “CHK” (To be checked), “OK” (ok), “TODO”, etc.

Inherits: RamObject

Static Methods

Method Arguments Description
fromDict
RamState
dict or object: stateDict Builds a RamState from a dict or object like the one returned by the RamDaemonInterface

Methods

Method Arguments Description
constructor string: stateName,
string: stateShortName,
float: completionRatio=0,
list of int: color=[67, 67, 67]
completionRatio
integer
The ratio of completion of this state in the range [0, 100].
color
array of integers
The color for this state, [R, G, B] in the range [0, 255].

API Dev notes

Note

These section is for the development of the API only; you should not need these when developping your add-on using the API.

(Im)mutable data

The data returned by the methods can be either mutable or immutable.

Method Type of the returned data
completionRatio Immutable
color Immutable

META