Difference between revisions of "Raffle.php"

From Bebot Wiki 2
Jump to navigationJump to search
 
Line 8: Line 8:
 
<pre>
 
<pre>
 
^Command  ^ Keyword  ^Argument(s)  ^Description                          ^Tell      ^Guild    ^Priv      ^
 
^Command  ^ Keyword  ^Argument(s)  ^Description                          ^Tell      ^Guild    ^Priv      ^
|!raffle | start  | <input>      | Starts a raffle for <input>.         | Leader    | Disabled  | Leader    |
+
|!raffle | start  | <item(s)>      | Starts a raffle for <item(s)>.     | Leader    | Disabled  | Leader    |
|!raffle | start  | <num> <input> | Same with <num> winners.              | Leader    | Disabled  |Leader    |
 
 
|!raffle | cancel  |              | Cancels active raffle. No winner.    | Leader    | Disabled  |Leader    |
 
|!raffle | cancel  |              | Cancels active raffle. No winner.    | Leader    | Disabled  |Leader    |
 
|!raffle | join    |              | Join the active raffle.              | Guest    | Disabled  | Guest    |
 
|!raffle | join    |              | Join the active raffle.              | Guest    | Disabled  | Guest    |
 
|!raffle | leave  |              | Leave the active raffle.              |Guest      |Disabled  |Guest      |
 
|!raffle | leave  |              | Leave the active raffle.              |Guest      |Disabled  |Guest      |
 
</pre>
 
</pre>
 +
 +
Note a raffle gives winning order. If there's only 1 item, only the 1st winner wins.
 +
But if more items, the first winner chooses among items, then the 2nd chooses among leftovers, etc, until no item or winner left.
  
 
===== Module settings =====
 
===== Module settings =====
 
<pre>
 
<pre>
^Setting      ^Default  ^Description                                             ^
+
^Setting      ^Default  ^Description
|Duration    |60      |Duration (in seconds) of raffles.                   |
+
|Duration    |60      |Duration (in seconds) of raffles.
 
</pre>
 
</pre>

Latest revision as of 20:14, 17 August 2021

Raffle Module User Reference

Description

Improved Raffle module that supports multiple winners when raffling identical items and logging via the UserHistory_RAID.php module.

Commands provided
^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
|!raffle | start   | <item(s)>       | Starts a raffle for <item(s)>.      | Leader    | Disabled  | Leader    |
|!raffle | cancel  |               | Cancels active raffle. No winner.     | Leader    | Disabled  |Leader     |
|!raffle | join    |               | Join the active raffle.               | Guest     | Disabled  | Guest     |
|!raffle | leave   |               | Leave the active raffle.              |Guest      |Disabled   |Guest      |

Note a raffle gives winning order. If there's only 1 item, only the 1st winner wins. But if more items, the first winner chooses among items, then the 2nd chooses among leftovers, etc, until no item or winner left.

Module settings
^Setting       ^Default   ^Description
|Duration     |60       |Duration (in seconds) of raffles.