Class Profile

constructor

• new Profile(
      opt?: {
          brightness?: number;
          colorway?:
              | "custom"
              | "unknown"
              | "onyxBlack"
              | "hematiteGrey"
              | "midnightGalaxy"
              | "auroraSky"
              | "clear"
              | "whiteAurora"
              | "electricGalaxy";
          creationDate?: Date;
          description?: string;
          dieType?: | "unknown"
          | "d4"
          | "d6"
          | "d8"
          | "d10"
          | "d00"
          | "d12"
          | "d20"
          | "d6pipped"
          | "d6fudge";
          lastModified?: Date;
          name?: string;
          rules?: Profiles.Rule[];
          uuid?: string;
      },
  ): Profiles.Profile

  Parameters

  • Optionalopt: {
        brightness?: number;
        colorway?:
            | "custom"
            | "unknown"
            | "onyxBlack"
            | "hematiteGrey"
            | "midnightGalaxy"
            | "auroraSky"
            | "clear"
            | "whiteAurora"
            | "electricGalaxy";
        creationDate?: Date;
        description?: string;
        dieType?: | "unknown"
        | "d4"
        | "d6"
        | "d8"
        | "d10"
        | "d00"
        | "d12"
        | "d20"
        | "d6pipped"
        | "d6fudge";
        lastModified?: Date;
        name?: string;
        rules?: Profiles.Rule[];
        uuid?: string;
    }

  Returns Profiles.Profile

brightness

colorway

creationDate

description

dieType

lastModified

rules

collectAnimations

• collectAnimations(): Profiles.Animation[]

  Returns Profiles.Animation[]

duplicate

• duplicate(uuid?: string): Profiles.Profile

  Parameters

  • Optionaluuid: string

  Returns Profiles.Profile

getRemoteAction

• getRemoteAction(actionId: number): ActionRunOnDevice | undefined

  Parameters

  • actionId: number

  Returns ActionRunOnDevice | undefined

hasActionOfType

• hasActionOfType(
      type:
          | "none"
          | "playAnimation"
          | "playAudioClip"
          | "makeWebRequest"
          | "speakText",
  ): boolean

  Parameters

  • type: "none" | "playAnimation" | "playAudioClip" | "makeWebRequest" | "speakText"

  Returns boolean

toProfile

• toProfile(editSet: ProfileDataSet, set: DataSet): Profile

  Parameters

  • editSet: ProfileDataSet
  • set: DataSet

  Returns Profile