minecraft_manager/docs/source/models.rst

.. include:: common.rst

..  _models:

MCM Models
==========


User
----

.. note::
   This is not specific to MCM. This model cannot be queried. |br|
   It is only here because it can be used to filter other models that use it as a foreign key.

Fields can be found on the official Django docs_.

.. _docs: https://docs.djangoproject.com/en/2.0/ref/contrib/auth/#user-model

----

User Settings
-------------

.. note::
    When querying, there is no space. It is UserSettings.

Results
~~~~~~~

    ``10`` - 10

    ``25`` - 25

    ``50`` - 50

    ``100`` - 100

    ``-1`` - All

Themes
~~~~~~

    ``DE`` - Default

    ``DA`` - Dark

    ``SO`` - Solar

    ``SL`` - Slate

Timezones
~~~~~~~~~

    :download:`Any timezone in this list. <_static/timezones.txt>`

``auth_user`` - User_

``default_results`` - Results_

``default_theme`` - Themes_

``default_timezone`` - Timezones_

``search_player_ip`` - Boolean

``show_timestamp_chat`` - Boolean

``last_ip`` - Text

----

Application
-----------

``username`` - Text

``age`` - Integer

``player_type`` - Test

``ever_banned`` - Boolean

``ever_banned_explanation`` - Text

``reference`` - Text

``read_rules`` - Text

``accepted`` - Boolean (can be null as well)

``date`` - DateTime

----

Player
------

``auth_user`` - User_

``uuid`` - Text

``username`` - Text

``application`` - Application_

``first_seen`` - DateTime

``last_seen`` - DateTime

----

Ticket
------

Priority
~~~~~~~~

    ``L`` - Low

    ``M`` - Medium

    ``H`` - High

Worlds
~~~~~~

    ``O`` - Overworld

    ``N`` - The Nether

    ``E`` - The End

``player`` - Player_

``message`` - Text

``priority`` - Priority_

``staff`` - User_

``resolved`` - Boolean

``world`` - Worlds_

``x`` - Text (in Integer format)

``y`` - Text (in Integer format)

``z`` - Text (in Integer format)

``date`` - DateTime

----

Ticket Note
-----------


``author`` - User_

``ticket`` - Ticket_

``message`` - Text

``last_update`` - DateTime

``date`` - DateTime

----

Note
----

Importance
~~~~~~~~~~

    ``L`` - Low

    ``M`` - Medium

    ``H`` - High

``player`` - Player_

``message`` - Text

``importance`` - Importance_

``staff`` - User_

``date`` - DateTime

----

IP
--

``player`` - Player_

``ip`` - Text

----

Alert
-----

``user`` - User_

``message`` - Text

``seen`` - Boolean

``date`` - DateTime

----