Skip to contents

Set how the mascot feels and looks. You can use this helper or a plain mood name in mascot() and update_mascot().

Usage

mascot_mood(name = "idle")

Arguments

name

A non-empty mood id: a lowercase letter followed by lowercase letters, digits or underscores. Defaults to "idle"; NULL is not accepted. See mascot_moods() for the available moods.

Value

A mascot_mood object. Its fields are internal; pass it on rather than reading them.

Details

This helper checks only the form of the id. mascot(), update_mascot() and mascot_preview() check whether the chosen character declares that mood. If it does not, their diagnostic lists that character's available moods.

Examples

mascot_mood()
#> mascot_mood()
mascot_mood("happy")
#> mascot_mood("happy")