mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-23 11:09:23 +01:00

History

Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices This commit reverts `db7ef3f025` (though it keeps the year updates) After discussion with several people, it seems better to mention copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright explains the issue of using VCSs to track copyright. As `db7ef3f025` only replaced mentions of my name with 'The Limnoria Contributors', this commit only needs to undo that + add one person who contributed to setup.py.		2021-10-17 09:57:55 +02:00
..
local	Import Conditional from gribble repo	2011-02-20 11:13:57 +01:00
locales	Fix msgfmt warnings.	2020-03-26 22:10:28 +01:00
__init__.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02:00
config.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02:00
messages.pot	Squashed commit of the following:	2014-12-20 14:37:27 +01:00
plugin.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02:00
README.rst	all plugins: regenerate READMEs	2021-04-22 00:29:15 +02:00
test.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02:00

README.rst

Documentation for the Conditional plugin for Supybot

Purpose

Contains numerous conditional commands (such as 'if', 'and', and 'or'), which can be used on their own or with another plugin. Also provides logic operators for writing conditions.

Useful for bot scripting / nested commands.

Usage

This plugin provides logic operators and other commands that enable you to run commands only if a condition is true. Useful for nested commands and scripting.

Commands

cand <cond1> [<cond2> ... <condN>]: Returns true if all conditions supplied evaluate to true.

ceq <item1> <item2>: Does a string comparison on <item1> and <item2>. Returns true if they are equal.

cerror <testcommand>: Runs <testcommand> and returns true if it raises an error; false otherwise.

cif <condition> <ifcommand> <elsecommand>: Runs <ifcommand> if <condition> evaluates to true, runs <elsecommand> if it evaluates to false. Use other logical operators defined in this plugin and command nesting to your advantage here.

cor <cond1> [<cond2> ... <condN>]: Returns true if any one of conditions supplied evaluates to true.

cxor <cond1> [<cond2> ... <condN>]: Returns true if only one of conditions supplied evaluates to true.

ge <item1> <item2>: Does a string comparison on <item1> and <item2>. Returns true if <item1> is greater than or equal to <item2>.

gt <item1> <item2>: Does a string comparison on <item1> and <item2>. Returns true if <item1> is greater than <item2>.

le <item1> <item2>: Does a string comparison on <item1> and <item2>. Returns true if <item1> is less than or equal to <item2>.

lt <item1> <item2>: Does a string comparison on <item1> and <item2>. Returns true if <item1> is less than <item2>.

match [--case-insensitive] <item1> <item2>: Determines if <item1> is a substring of <item2>. Returns true if <item1> is contained in <item2>. Will only match case if --case-insensitive is not given.

nceq <item1> <item2>: Does a numeric comparison on <item1> and <item2>. Returns true if they are equal.

ne <item1> <item2>: Does a string comparison on <item1> and <item2>. Returns true if they are not equal.

nge <item1> <item2>: Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is greater than or equal to <item2>.

ngt <item1> <item2>: Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is greater than <item2>.

nle <item1> <item2>: Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is less than or equal to <item2>.

nlt <item1> <item2>: Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is less than <item2>.

nne <item1> <item2>: Does a numeric comparison on <item1> and <item2>. Returns true if they are not equal.

Configuration

supybot.plugins.Conditional.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.