Class Profile

constructor

• new Profile(opt?): Profiles.Profile

• Parameters

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

    • Optionalbrightness?: number

    • Optionalcolorway?:
          | "custom"
          | "unknown"
          | "onyxBlack"
          | "hematiteGrey"
          | "midnightGalaxy"
          | "auroraSky"
          | "clear"
          | "whiteAurora"

    • OptionalcreationDate?: Date

    • Optionaldescription?: string

    • OptionaldieType?:
          | "unknown"
          | "d4"
          | "d6"
          | "d8"
          | "d10"
          | "d00"
          | "d12"
          | "d20"
          | "d6pipped"
          | "d6fudge"

    • OptionallastModified?: Date

    • Optionalname?: string

    • Optionalrules?: Profiles.Rule[]

    • Optionaluuid?: string

  Returns Profiles.Profile

brightness

colorway

creationDate

description

dieType

lastModified

rules

collectAnimations

• collectAnimations(): Profiles.Animation[]

• Returns Profiles.Animation[]

duplicate

• duplicate(uuid?): Profiles.Profile

• Parameters

  • Optionaluuid: string

  Returns Profiles.Profile

getRemoteAction

• getRemoteAction(actionId): undefined | ActionRunOnDevice

• Parameters

  • actionId: number

  Returns undefined | ActionRunOnDevice

hasActionOfType

• hasActionOfType(type): boolean

• Parameters

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

  Returns boolean

toProfile

• toProfile(editSet, set): Profile

• Parameters

  • editSet: ProfileDataSet
  • set: DataSet

  Returns Profile