Skip to contents

Lists a character's colour roles (the parts you can colour) with their own colours, or with a named palette applied. Roles are written in snake case in R. A role can follow other roles, its leaders, listed in priority order. A colour you supply for a role always wins; otherwise the role follows the first leader that has been given a colour. If no leader has one, the role keeps its original colour.

Usage

mascot_colour_roles(character = "tessa", ..., palette = NULL)

Arguments

character

A character, defaulting to "tessa": an id string or a mascot_character() helper. NULL is not accepted.

...

Must be empty. Forces the arguments after it to be named.

palette

A palette id from mascot_palettes(), or NULL (the default) for the character's own colours. Roles that follow others take their colours from the palette's leaders.

Value

A data frame with character columns role, colour, follows (comma-separated leaders), shade (same, lighter or darker), description (what the role colours) and brand (the brand slots the role fills, primary and secondary, comma-separated). Roles without a follow rule have NA in follows and shade; roles that fill no brand slot have NA in brand. A base data frame. Columns may be added at the end in later versions; existing columns keep their names and types.

Examples

mascot_colour_roles()
#>                role  colour          follows   shade
#> 1           outline #14221B             <NA>    <NA>
#> 2           feature #14221B             <NA>    <NA>
#> 3         eye_white #FFFDF4             <NA>    <NA>
#> 4             shine #FFFDF4             <NA>    <NA>
#> 5             teeth #FFFDF4             <NA>    <NA>
#> 6            eyelid #079C9B             body    same
#> 7            tongue #F078C1            blush    same
#> 8              body #079C9B             <NA>    <NA>
#> 9    body_highlight #6FC6C5             body lighter
#> 10              rim #CCDFE1             <NA>    <NA>
#> 11             limb #CCDFE1        rim, body    same
#> 12           sleeve #047166 body_shade, body    same
#> 13            blush #F078C1             <NA>    <NA>
#> 14     blush_strong #F078C1            blush    same
#> 15        accessory #DD89BA             <NA>    <NA>
#> 16 accessory_detail #9F6386        accessory  darker
#> 17          sparkle #E8F1F2              rim lighter
#> 18  sparkle_outline #14221B          outline    same
#> 19            sweat #9BD8FF             <NA>    <NA>
#> 20           shadow #000000             <NA>    <NA>
#> 21   outline_second #FFFDF4             <NA>    <NA>
#> 22             hand #FFFDF4             <NA>    <NA>
#> 23       body_shade #047166             <NA>    <NA>
#> 24        rim_light #E8F1F2              rim lighter
#> 25        rim_shade #9FAEB0              rim  darker
#> 26             hair #1A3A3D             <NA>    <NA>
#> 27       hair_shade #0F2427             <NA>    <NA>
#> 28       hair_light #536B6E             hair lighter
#> 29  accessory_light #F0CAE0        accessory lighter
#> 30            badge #155A5C             <NA>    <NA>
#> 31       badge_icon #8BEDFF             <NA>    <NA>
#> 32             iris #048B7D             <NA>    <NA>
#> 33        iris_tint #43A89E             iris lighter
#>                                      description     brand
#> 1        Ink outline of the body, hair and badge      <NA>
#> 2                          Eyes, brows and mouth      <NA>
#> 3                                      Eye white      <NA>
#> 4                                          Shine      <NA>
#> 5                                          Teeth      <NA>
#> 6                                         Eyelid      <NA>
#> 7                                         Tongue      <NA>
#> 8                     Face colour of the hexagon   primary
#> 9                                 Body highlight      <NA>
#> 10  Ring inside the hexagon, feet and badge edge secondary
#> 11                                          Feet      <NA>
#> 12                                          Arms      <NA>
#> 13                                        Cheeks      <NA>
#> 14                                  Blush strong      <NA>
#> 15                                           Bow      <NA>
#> 16                                      Bow ties      <NA>
#> 17                                       Sparkle      <NA>
#> 18                               Sparkle outline      <NA>
#> 19                                         Sweat      <NA>
#> 20                                        Shadow      <NA>
#> 21                 Pale line outside the outline      <NA>
#> 22                                         Hands      <NA>
#> 23     Darker corner of the hexagon and the arms      <NA>
#> 24         Light end of the ring and its shimmer      <NA>
#> 25                          Dark end of the ring      <NA>
#> 26                               Hair, light end      <NA>
#> 27            Hair, dark end and the hair behind      <NA>
#> 28                                  Hair strands      <NA>
#> 29                              Bow, light parts      <NA>
#> 30                             Chest badge plate      <NA>
#> 31 Icon on the chest badge, which shows the mood      <NA>
#> 32                              Iris of the eyes      <NA>
#> 33           Facet on the lower left of the face      <NA>
mascot_colour_roles("tessa", palette = "coral_navy")
#>                role  colour          follows   shade
#> 1           outline #181828             <NA>    <NA>
#> 2           feature #181828             <NA>    <NA>
#> 3         eye_white #FFFDF4             <NA>    <NA>
#> 4             shine #FFFDF4             <NA>    <NA>
#> 5             teeth #FFFDF4             <NA>    <NA>
#> 6            eyelid #FFE5D9             body    same
#> 7            tongue #2A9D8F            blush    same
#> 8              body #FFE5D9             <NA>    <NA>
#> 9    body_highlight #FFFFFF             body lighter
#> 10              rim #FF6B6B             <NA>    <NA>
#> 11             limb #FF6B6B        rim, body    same
#> 12           sleeve #DBC5BB body_shade, body    same
#> 13            blush #2A9D8F             <NA>    <NA>
#> 14     blush_strong #2A9D8F            blush    same
#> 15        accessory #2A9D8F             <NA>    <NA>
#> 16 accessory_detail #243F3B        accessory  darker
#> 17          sparkle #FF9898              rim lighter
#> 18  sparkle_outline #181828          outline    same
#> 19            sweat #9BD8FF             <NA>    <NA>
#> 20           shadow #000000             <NA>    <NA>
#> 21   outline_second #FFFDF4             <NA>    <NA>
#> 22             hand #FFFDF4             <NA>    <NA>
#> 23       body_shade #DBC5BB             <NA>    <NA>
#> 24        rim_light #FF9898              rim lighter
#> 25        rim_shade #EB2121              rim  darker
#> 26             hair #1D3557             <NA>    <NA>
#> 27       hair_shade #1D3557             <NA>    <NA>
#> 28       hair_light #556A89             hair lighter
#> 29  accessory_light #4BD0C0        accessory lighter
#> 30            badge #1D3557             <NA>    <NA>
#> 31       badge_icon #FFB703             <NA>    <NA>
#> 32             iris #2A9D8F             <NA>    <NA>
#> 33        iris_tint #8B9897             iris lighter
#>                                      description     brand
#> 1        Ink outline of the body, hair and badge      <NA>
#> 2                          Eyes, brows and mouth      <NA>
#> 3                                      Eye white      <NA>
#> 4                                          Shine      <NA>
#> 5                                          Teeth      <NA>
#> 6                                         Eyelid      <NA>
#> 7                                         Tongue      <NA>
#> 8                     Face colour of the hexagon   primary
#> 9                                 Body highlight      <NA>
#> 10  Ring inside the hexagon, feet and badge edge secondary
#> 11                                          Feet      <NA>
#> 12                                          Arms      <NA>
#> 13                                        Cheeks      <NA>
#> 14                                  Blush strong      <NA>
#> 15                                           Bow      <NA>
#> 16                                      Bow ties      <NA>
#> 17                                       Sparkle      <NA>
#> 18                               Sparkle outline      <NA>
#> 19                                         Sweat      <NA>
#> 20                                        Shadow      <NA>
#> 21                 Pale line outside the outline      <NA>
#> 22                                         Hands      <NA>
#> 23     Darker corner of the hexagon and the arms      <NA>
#> 24         Light end of the ring and its shimmer      <NA>
#> 25                          Dark end of the ring      <NA>
#> 26                               Hair, light end      <NA>
#> 27            Hair, dark end and the hair behind      <NA>
#> 28                                  Hair strands      <NA>
#> 29                              Bow, light parts      <NA>
#> 30                             Chest badge plate      <NA>
#> 31 Icon on the chest badge, which shows the mood      <NA>
#> 32                              Iris of the eyes      <NA>
#> 33           Facet on the lower left of the face      <NA>