ubuntu-bots/Random/README.rst

51 lines
1.1 KiB
ReStructuredText

.. _plugin-Random:
Documentation for the Random plugin for Supybot
===============================================
Purpose
-------
This plugin returns a random phrase or number out of a given
set of phrases or range of numbers.
Usage
-----
Return a random phrase or number out of a given
set of phrases or range of numbers.
.. _commands-Random:
Commands
--------
.. _command-random-random:
random <phrase1> <phrase2> ...<phraseN>
Picks a phrase at random. Use quotes to enclose multiple words in a phrase.
.. _command-random-randrange:
randrange <min> <max>
Picks a random number in range <min>-<max>
.. _command-random-seed:
seed [<number>]
Seeds the random number generator with the given <number>, which can either be an integer or a floating-point number.
When no argument is given, the random number generator is seeded with the current time.
.. _conf-Random:
Configuration
-------------
.. _conf-supybot.plugins.Random.public:
supybot.plugins.Random.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.