Lists the characters shipped with the package. Pass an id to the character argument of mascot(), or to the
other listings, such as mascot_moods().
Arguments
- ...
Must be empty. Forces the arguments after it to be named.
- family
NULL(the default) for every character, or a familyidfrommascot_families()to list only its members.
Value
A data frame with the character columns id (the value you pass to
character), name (the display name), description and family (the
family id); the logical columns is_default (TRUE only for the
character mascot() uses when you name none) and built_in (TRUE for
characters shipped with the package); lifecycle ("stable" or
"experimental" for every character that ships with mascot); and
palettes (comma-separated palette ids, for reading only; its exact shape
is not promised, so use mascot_palettes() for ids you rely on).
A base data frame. Columns may be added at the end in later versions; existing columns keep their
names and types.
Details
Stable built-ins keep their id, name, five shared moods, gesture names, colour-role names and palette names in every release; their drawing, motion and exact palette colours may be polished. Experimental built-ins may change in any way, and none is removed without a warning one release earlier. The character file format and authoring functions are experimental too.
See also
mascot_character(), mascot_families()
Other mascot helpers:
mascot_action(),
mascot_anchors(),
mascot_bubble(),
mascot_character(),
mascot_check_character(),
mascot_colour_roles(),
mascot_families(),
mascot_gesture(),
mascot_gestures(),
mascot_mood(),
mascot_moods(),
mascot_motion_settings(),
mascot_palettes(),
mascot_placement(),
mascot_popup_menu(),
mascot_preview(),
mascot_read_character(),
mascot_size(),
mascot_status(),
mascot_theme()
Experimental characters
Experimental Knurl and Neer.
Examples
mascot_characters()
#> id name
#> 1 tessa Tessa
#> 2 sela Sela
#> 3 knurl Knurl
#> 4 neer Neer
#> description
#> 1 A calm teal hexagonal maker with a silver ring, a bow and a chest badge that shows her mood.
#> 2 A reassuring lilac Hexonian with time blocks; suits scheduling and resource planning.
#> 3 A single-wheeled repair bot with a clamp arm and screen visor; suits job queues and diagnostics.
#> 4 A blue wave crest with a scallop clip.
#> family is_default built_in lifecycle
#> 1 hexonians TRUE TRUE stable
#> 2 hexonians FALSE TRUE stable
#> 3 visorfolk FALSE TRUE experimental
#> 4 elementals FALSE TRUE experimental
#> palettes
#> 1 night_teal, sea_green, forest, spring, peach, coral_navy, desert_coral, rose_soft, lilac_soft, mist_navy
#> 2 lilac_violet, orchid, coral_navy, azure, peach_ink, lilac_soft, mist_navy, desert_clay, forest, apricot_navy, blush_plum, lilac_dusk, sea_green
#> 3 original, orbit, carbon, cobalt_droid, crimson
#> 4 original, lagoon, glacier, coral_reef, night_bay, monsoon
mascot_characters(family = "hexonians")
#> id name
#> 1 tessa Tessa
#> 2 sela Sela
#> description
#> 1 A calm teal hexagonal maker with a silver ring, a bow and a chest badge that shows her mood.
#> 2 A reassuring lilac Hexonian with time blocks; suits scheduling and resource planning.
#> family is_default built_in lifecycle
#> 1 hexonians TRUE TRUE stable
#> 2 hexonians FALSE TRUE stable
#> palettes
#> 1 night_teal, sea_green, forest, spring, peach, coral_navy, desert_coral, rose_soft, lilac_soft, mist_navy
#> 2 lilac_violet, orchid, coral_navy, azure, peach_ink, lilac_soft, mist_navy, desert_clay, forest, apricot_navy, blush_plum, lilac_dusk, sea_green