Class PixelInfoNotifier<MutableProps, Type>Abstract

constructor

• new PixelInfoNotifier<MutableProps, Type>(): PixelInfoNotifier<MutableProps, Type>

• Type Parameters

  • MutableProps extends PixelInfoNotifierMutableProps = PixelInfoNotifierMutableProps

  • Type extends PixelInfo = PixelInfo

  Returns PixelInfoNotifier<MutableProps, Type>

Static MutablePropsList

Abstract batteryLevel

• get batteryLevel(): number

• The Pixel battery level (percentage).

  Returns number

Abstract colorway

• get colorway(): "custom" | "clear" | "unknown" | "onyxBlack" | "hematiteGrey" | "midnightGalaxy" | "auroraSky"

• The Pixel color.

  Returns "custom" | "clear" | "unknown" | "onyxBlack" | "hematiteGrey" | "midnightGalaxy" | "auroraSky"

Abstract currentFace

• get currentFace(): number

• The value of the die face that is currently facing up.

  Returns number

  Remarks

  • This value is always an integer number.
  • D10 returns values ranging from 0 to 9 included.
  • D00 returns 0, 10, 20, ..., 90.
  • Fudge die returns +1, 0 and -1.

Abstract currentFaceIndex

• get currentFaceIndex(): number

• The 0-based index of the die face that is currently facing up.

  Returns number

  Remarks

  Indices are continuous and follow the numerical order of the die faces values.

  Example

  A D20 die will have face indices ranging from 0 to 19.
  Index 0 corresponds to face 1 and index 19 to face 20.
  
  D10 and D00 share the same face indices but have different face values.
  Index 0 corresponds to face 0 of both dice types.
  Index 9 corresponds to face 9 for a D10 and to face 90 for a D00.
  
  The fudge die returns the following indices:
  - O and 5 for the "+" face .
  - 1 and 4 for the "-" face.
  - 2 and 3 for the "blank" face.
  Copy

Abstract dieType

• get dieType(): "unknown" | "d4" | "d6" | "d8" | "d10" | "d00" | "d12" | "d20" | "d6pipped" | "d6fudge"

• The Pixel die type.

  Returns "unknown" | "d4" | "d6" | "d8" | "d10" | "d00" | "d12" | "d20" | "d6pipped" | "d6fudge"

Abstract firmwareDate

• get firmwareDate(): Date

• The Pixel firmware build date.

  Returns Date

Abstract isCharging

• get isCharging(): boolean

• Whether the Pixel battery is charging or not. Set to 'true' if fully charged but still on charger.

  Returns boolean

Abstract ledCount

• get ledCount(): number

• The number of LEDs of the Pixel.

  Returns number

Abstract name

• get name(): string

• The Pixels die name.

  Returns string

Abstract pixelId

• get pixelId(): number

• The unique Pixel id of the device.

  Returns number

Abstract rollState

• get rollState(): "unknown" | "handling" | "rolling" | "crooked" | "onFace"

• The Pixel roll state.

  Returns "unknown" | "handling" | "rolling" | "crooked" | "onFace"

Abstract rssi

• get rssi(): number

• The last RSSI value measured by the Pixel.

  Returns number

Abstract systemId

• get systemId(): string

• The unique id assigned by the system to the Pixel Bluetooth peripheral.

  Returns string

addPropertyListener

• addPropertyListener<K>(propertyName, listener): void

• Adds the given listener function for the specified property.

  Type Parameters

  • K extends string

  Parameters

  • propertyName: K

    The name of the property.

  • listener: EventReceiver<Type>

    The callback function.

  Returns void

removePropertyListener

• removePropertyListener<K>(propertyName, listener): void

• Removes the given listener function for the specified property.

  Type Parameters

  • K extends string

  Parameters

  • propertyName: K

    The name of the property.

  • listener: EventReceiver<Type>

    The callback function to unregister.

  Returns void