-------
Fish Warden API documentation:
    I intend to make every effort to keep the API compatible between versions
    I will make specific notes in the changelogs if there is ever a potential code-breaking change

    Functions will be shown in a pseudocode similar to c-style prototypes, to easily distinguish the param and return types

    All function names will be preceded by "FiWaAPI_" to try to prevent polluting the global namespace too much.

    You should NEVER directly override the global versions of these functions, however feel free to do so locally in your addon

    You may want to consider adding Fish Warden as a dependency to your addon if you rely on these functions existing

    Throughout this document, Fish Warden is refered to as "enabled" or "disabled" by means of its own settings.
    To distinguish from when the addon is enabled/disabled from loading, I will use the term "installed."
-------


++++-----------------------------------------++++
    boolean FiWaAPI_IsFishWardenEnabled(void)
====-----------------------------------------====

    This function is to check if Fish Warden is currently enabled.

    returns: true when Fish Warden is running and enabled
             false when Fish Warden is not yet running (before PLAYER_LOGIN) or disabled

    usage: The easiest way to incorporate it in your code (in my opinion) is to make a local reference to it like such:
           local IsFishWardenEnabled = FiWaAPI_IsFishWardenEnabled or function() return false; end

           The purpose of the "or ..return false.." is so your local version will be defined even if Fish Warden isn't installed

====-----------------------------------------====


++++---------------------------------------------------++++
    boolean FiWaAPI_EnableFishWarden([boolean enabled])
====---------------------------------------------------====

    This function enables or disables Fish Warden

    param enabled: true to enable Fish Warden, false to disable Fish Warden, nil to toggle Fish Warden

    returns: true if successful, otherwise false

    usage: This function can not be called before or during the PLAYER_LOGIN event

====---------------------------------------------------====


++++-------------------------------------++++
    boolean FiWaAPI_IsAutoReleasing(void)
====-------------------------------------====

    This function is to check if Fish Warden is currently set to "auto release unwanted fish."

    returns: true when "auto release unwanted fish" is enabled (even if Fish Warden is disabled)
             false otherwise or if called before or during the PLAYER_LOGIN event

====-------------------------------------====


++++-------------------------------------------------++++
    void FiWaAPI_EnableAutoReleasing(boolean enabled)
====-------------------------------------------------====

    This function enables or disables the "auto release unwanted fish." option.

    param enabled: true to enable the "auto release unwanted fish." option
                   otherwise disables it

    returns: true if successful, otherwise false

    usage: This function can not be called before or during the PLAYER_LOGIN event

====-------------------------------------------------====

