.. _plugin:userstate:

=========
USERSTATE
=========
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

description
-----------
| 

 userstate is stored in jsondata/state/users/<username>. 



| 

commands
--------
| 


    :commands in this plugin: get .. set .. unset

| 

1) *get .. [handle_get]*

    :description:  arguments: [<searchtxt>] - get your userstate (complete dump or use <searchtxt> to filter). 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.core.userstate_get_command`.

    :examples:

    ::

        <user> ;get
        <output> state: place=heerhugowaard, shops=['bread', 'bread']


2) *set .. [handle_set]*

    :description:  arguments: <item> <value> - set a variable in your userstate. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.core.userstate_set_command`.

    :examples:

    ::

        <user> ;set place heerhugowaard
        <output> place set to heerhugowaard


3) *unset .. [handle_unset]*

    :description:  arguments: <item> - remove value from user state of your userstate. 

    :permissions: USER .. GUEST

    :code: :ref:`fbf.plugs.core.userstate_unset_command`.

    :examples:

    ::

        <user> ;unset TZ
        <output> no such item