Documentation
    Preparing search index...
    • React Hook that updates when the given PixelInfoNotifier's prop changes.

      Type Parameters

      • T extends
            | "systemId"
            | "pixelId"
            | "name"
            | "ledCount"
            | "colorway"
            | "dieType"
            | "firmwareDate"
            | "rssi"
            | "batteryLevel"
            | "isCharging"
            | "rollState"
            | "currentFace"
            | "currentFaceIndex"

      Parameters

      • pixelInfo:
            | PixelInfoNotifier<
                PixelInfoNotifierMutableProps,
                Readonly<
                    {
                        batteryLevel: number;
                        colorway: | "unknown"
                        | "onyxBlack"
                        | "hematiteGrey"
                        | "midnightGalaxy"
                        | "auroraSky"
                        | "clear"
                        | "whiteAurora"
                        | "electricGalaxy"
                        | "custom";
                        currentFace: number;
                        currentFaceIndex: number;
                        dieType: | "unknown"
                        | "d4"
                        | "d6"
                        | "d8"
                        | "d10"
                        | "d00"
                        | "d12"
                        | "d20"
                        | "d6pipped"
                        | "d6fudge";
                        firmwareDate: Date;
                        isCharging: boolean;
                        ledCount: number;
                        name: string;
                        pixelId: number;
                        rollState: | "unknown"
                        | "rolled"
                        | "handling"
                        | "rolling"
                        | "crooked"
                        | "onFace";
                        rssi: number;
                        systemId: string;
                    },
                >,
            >
            | undefined

        The PixelInfoNotifier for which to watch the prop.

      • prop: T

        The prop to watch.

      Returns PixelInfoNotifierMutableProps[T] | undefined

      The current value of the given prop on the given PixelInfoNotifier.