Skip to contents

The helper behind the character argument of mascot(). Tessa and Sela are stable built-in characters; Knurl and Neer are experimental.

Usage

mascot_character(id = "tessa")

Arguments

id

A non-empty string naming a known character, or checked mascot_character_data from mascot_read_character() or mascot_check_character(). Defaults to "tessa"; NULL is not accepted. A checked object is used as passed and is not stored anywhere; pass it each time you choose that character.

Value

A mascot_character helper carrying the character's identity and, for a custom character, its checked drawing data. The returned object's fields are internal; pass the object on rather than reading its fields.

Details

Tessa and Sela are stable: their ids, names, five shared moods, gesture names, colour-role names and palette names stay the same in every release. Their drawings, motion and exact palette colours may be polished. Knurl and Neer are experimental: any part may change, and neither will be removed without a warning one release earlier. The character file format and character authoring functions are experimental too.

Experimental characters

Experimental Knurl and Neer.

Examples

mascot_character()
#> mascot_character("tessa")
mascot_character("tessa")
#> mascot_character("tessa")
path <- system.file("examples", "characters", "study_bot.json", package = "mascot")
mascot_character(mascot_read_character(path))
#> <mascot_character: study_bot (checked custom character)>