Worldswitcher
=============

The Worldswitcher include contains all kinds of functions to control the built-in RS world switcher.


WorldScreen
~~~~~~~~~~~~

.. code-block:: pascal

    function Worldscreen: boolean;

Returns true if the Worldswitcher screen is open

.. note::

  by Icefire908

Example:

.. code-block:: pascal


OpenWorldScreen
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function: OpenWorldScreen: Boolean;

Opens the Worldswitcher screen. Returns true if it is succesfully opened.

.. note::

    by Bionicle1800

Example:

.. code-block::pascal


UpdateWorlds
~~~~~~~~~~~~

.. code-block:: pascal

    procedure UpdateWorlds;

Parses the worlds page into Worlds.ini

.. note::

    by mixster

Example:

.. code-block::pascal


LoadWorldArrays
~~~~~~~~~~~~~~~

.. code-block:: pascal

    procedure LoadWorldArrays;

Loads the world array into Worldarray from Worlds.ini

..note::

    by Narcle; Edits by Nava2;

Example:

.. code-block:: pascal


WS_CurrentWorld
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function WS_CurrentWorld(var World: Integer): Boolean;

Results true if the current world is members,returns world number. World returns -1 if failed. Only works at world screen.

..note::

    by Icefire908

Example:

.. code-block:: pascal


FindWorld
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function FindWorld(W: integer): Boolean;

Scrolls to area and returns true if world was found.

..note::

    by Narcle fixed by Shuttleu

Example:

.. code-block:: pascal


GetWorldInfo
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function GetWorldInfo(World: Integer; var WorldRec: TWorld): Boolean;

Records World info into TWorld record, also Results true if world was found.

..note::

    by Narcle

Example:

.. code-block:: pascal


SelectWorld
~~~~~~~~~~~~~~~

.. code-block:: pascal

    Function SelectWorld(W: Integer): Boolean;

Switches to the specified world. Returns true if successful.

..note::

    by Narcle & ZephyrsFury

Example:

.. code-block:: pascal


RandomWorld
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function RandomWorld(Members, PvP: Boolean): Integer;

Returns a random world by paramaters.

..note::

    by Narcle & mixster

Example:

.. code-block:: pascal


ChangeWorld
~~~~~~~~~~~~~~~

.. code-block:: pascal

    function ChangeWorld(W: Integer): Boolean;

Changes to world W. Returns True if successful.

..note::

    by Nava2

Example:

.. code-block:: pascal


OrderWorlds
~~~~~~~~~~~~~~~

.. code-block:: pascal

    Procedure OrderWorlds(by: string; Descending: boolean);

Orders worlds by 'by' in order 'Descending', Check function for valid params of 'by', Descending = true means the left button

..note::

    by NaumanAkhlaQ

Example:

.. code-block:: pascal


ChooseWorldBy
~~~~~~~~~~~~~~~

.. code-block:: pascal

    Function ChooseWorldBy(SettingsNames:TStringArray; SettingsDescending: array of boolean; Members, PVP: boolean): boolean;

Chooses a world by SettingsNames , ordered by SettingsDescending, Takes into account Members and PVP, Check OrderWorlds for valid params for SettingsNames

..note::

    by Rasta Magician

Example:

.. code-block:: pascal