Home Reference Source

src/utils/CharacterConstants.js

/**
 * Defines constants describing the posture and expression of characters.
 * Used to style components.
 */

/**
 * Enum defining the posture of the character
 * @enum {number}
 * @property {number} NONE - Normal length
 * @property {number} STANDING - Short length
 * @property {number} SITTING - Full length
 * @property {number} LAYING - Full length
 */
const CharacterPosture = Object.freeze({
    NONE: 1,
    STANDING: 2,
    SITTING: 3,
    LAYING: 4,
});

/**
 * Enum defining the expression and function of the avatar of the helper.
 * _HELP: the avatar has a question mark on his clothes
 * _WARNING: the avatar has an exclamation mark on his clothes
 * @property {number} SATISFIED_HELP - Satisfied expression (help)
 * @property {number} HAPPY_HELP - Happy expression (help)
 * @property {number} THUMBUP_HELP - Thump up (help)
 * @property {number} CURIOUS_HELP - Curious expression (help)
 * @property {number} SITTING_HELP - Sitting (help)
 * @property {number} RESTING_HELP - Laying (help)
 * @property {number} DOUBT_WARNING - Doubtful expression (warning)
 * @property {number} THUMP_UP - Thumb up
 */
const CharacterExpression = Object.freeze({
    SATISFIED_HELP: 1,
    HAPPY_HELP: 2,
    THUMBUP_HELP: 3,
    CURIOUS_HELP: 4,
    SITTING_HELP: 5,
    RESTING_HELP: 6,
    DOUBT_WARNING: 7,
    THUMP_UP: 8,
});

export {CharacterPosture, CharacterExpression};