Login
=====

The Login include contains all Login related functions


RSReady
~~~~~~~

.. code-block:: pascal

    function RSReady: Boolean;

Returns true if we are ready to auto (on loginscreen or logged in).
Useful for waiting until RS has fully loaded.

.. note::

    by ZephyrsFury

Example:

.. code-block:: pascal



Login_SetAudio
~~~~~~~~~~~~~~

.. code-block:: pascal

    procedure Login_SetAudio(Volume, SFX, Area: Integer; SMSetting: (Stereo, Mono, NoChange) );

Sets audio options through the login screen.
Use: Enter the desired Setting for the desired Option. Make option 0 for no change.
EG. Login_SetAudio(1, 5, 2, NoChange);

1   2   3   4   5
<-o---o---o---o---o->
Volume, SFX, Area:

.. note::

    by ZephyrsFury, fixed by Markus

Example:

.. code-block:: pascal



Login_SetGraphics
~~~~~~~~~~~~~~~~~

.. code-block:: pascal

    procedure Login_SetGraphics(Brightness: Integer);

Sets graphic options in the login screen.

.. note::

    by ZephyrsFury Fixed by TRiLeZ, Markus

Example:

.. code-block:: pascal



SetAudioOff
~~~~~~~~~~~

.. code-block:: pascal

    procedure SetAudioOff;

Sets the Audio to off (1 for each bar). Works logged in and out.

.. note::

    by ZephyrsFury

Example:

.. code-block:: pascal



SetAutoingDefaults
~~~~~~~~~~~~~~~~~~

.. code-block:: pascal

    procedure SetAutoingDefaults;

 Sets the graphic options for best SRL compatibility. Works both logged in and out.

.. note::

    by ZephyrsFury

Example:

.. code-block:: pascal



LobbyScreen
~~~~~~~~~~~

.. code-block:: pascal

    function LobbyScreen: Boolean;

Returns true if we are at the Lobby Screen

.. note::

    by IceFire908 & Bionicle1800

Example:

.. code-block:: pascal



ExitToLobby
~~~~~~~~~~~

.. code-block:: pascal

    function ExitToLobby: Boolean;

Exits to the Lobby (for breaks?)

.. note::

    by Starblaster100, Raymond, IceFire908, & Tarajunky

Example:

.. code-block:: pascal



LeaveLobby
~~~~~~~~~~

.. code-block:: pascal

    function LeaveLobby: Boolean;

Logs you out from lobby screen.

.. note::

    by IceFire908

Example:

.. code-block:: pascal



Logout
~~~~~~

.. code-block:: pascal

    function Logout: Boolean;

Logs you all the way out from ingame.

.. note::

    by Starblaster100, Raymond, IceFire908, & Tarajunky

Example:

.. code-block:: pascal



LoginPlayerToLob
~~~~~~~~~~~~~~~~

.. code-block:: pascal

    function LoginPlayerToLob: Boolean;

Like LoginPlayer but only to the lobbyscreen.

.. note::

    by The SRL Team

Example:

.. code-block:: pascal



LoginPlayer
~~~~~~~~~~~

.. code-block:: pascal

    procedure LoginPlayer;

Logs in the Player[CurrentPlayer]. Detects most Client Login Errors

.. note::

    by The SRL Team

Example:

.. code-block:: pascal



NextPlayerIndex
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function NextPlayerIndex: Integer;

Returns the player number of the next active player.

.. note::

    by Dankness, Ron, Raymond & ZephyrsFury

Example:

.. code-block:: pascal



RandomPlayerIndex
~~~~~~~~~~~~~~~~~

.. code-block:: pascal

    function RandomPlayerIndex: Integer;

Returns the Player number of a random active player.

.. note::

    by Dankness, Ron, Raymond & ZephyrsFury

Example:

.. code-block:: pascal



SwitchToPlayer
~~~~~~~~~~~~~~

.. code-block:: pascal

    function SwitchToPlayer(PlayerNo: Integer; Active: Boolean): Boolean;

Switches to a specific player, setting the current player's
  activity to True or False.

.. note::

    by Dankness, Ron, Raymond & ZephyrsFury

Example:

.. code-block:: pascal



NextPlayer
~~~~~~~~~~

.. code-block:: pascal

    procedure NextPlayer(Active: Boolean);

Logs in the next player that isn't inactive.
Boolean: True - Current player is ok. False - Current player is false.

.. note::

    by ZephyrsFury

Example:

.. code-block:: pascal



RandomNextPlayer
~~~~~~~~~~~~~~~~

.. code-block:: pascal

    procedure RandomNextPlayer(Active: Boolean);

Logs in a random player that isn't inactive.
Boolean: True - Current player is ok. False - Current player is false.

.. note::

    by ZephyrsFury

Example:

.. code-block:: pascal



CheckUserNicks
~~~~~~~~~~~~~~

.. code-block:: pascal

    procedure CheckUserNicks;

Checks if all nicks are set correct.

.. note::

    by Sumilion, Raymond, and Nava2

Example:

.. code-block:: pascal