Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...
    interface UserData {
        _id: string | null;
        _stats: DocumentStats;
        avatar: string | null;
        character: string;
        color: string;
        flags: DocumentFlags;
        hotbar: object;
        name: string;
        password: string;
        passwordSalt: string;
        permissions: object;
        pronouns: string;
        role: number;
    }
    Index

    Properties

    _id: string | null

    The _id which uniquely identifies this User document.

    An object of creation and access information

    avatar: string | null

    The user's avatar image.

    character: string

    A linked Actor document that is this user's impersonated character.

    color: string

    A color to represent this user.

    An object of optional key/value flags

    hotbar: object

    A mapping of hotbar slot number to Macro id for the user.

    name: string

    The user's name.

    password: string

    The user's password. Available only on the Server side for security.

    passwordSalt: string

    The user's password salt. Available only on the Server side for security.

    permissions: object

    The user's individual permission configuration, see CONST.USER_PERMISSIONS.

    pronouns: string

    The user's personal pronouns.

    role: number

    The user's role, see CONST.USER_ROLES.