wyvern.kernel.player
Class Punishments

java.lang.Object
  wyvern.kernel.player.Punishments

public final class Punishments

extends java.lang.Object

Handles doling out various punishments to players. This class doesn't provide any commands, but it provides methods for invoking punishments in a uniform way.

Version:

1.0, May 27, 2003

Author:

Steve Yegge

Method Summary

static void

silencePlayer(Player p, int minutes, java.lang.String who, java.lang.String reason) Silences a player for a given amount of time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

silencePlayer

public static void silencePlayer(Player p,
                                 int minutes,
                                 java.lang.String who,
                                 java.lang.String reason)

Silences a player for a given amount of time. This method sets the following properties on the player:

• "silenced" (boolean) - checked by the Shouting code
• "silenced-by" (string) - the wizard who silenced them, or the automated mechanism if applicable (e.g. "warnings")
• "silenced-until" (int) - the player's age, in seconds, at which point the player will no longer be silenced.
• "silenced-msg" (string) - the reason the player was silenced

Silencing is cumulative - if you call this method multiple times, the number of minutes for each call is added to the player's total sentence.

Parameters:

p - the player to silence (must be online)

minutes - the amount of time to silence the player, in minutes.

who - who's doing the silencing (pass "game driver" if it's happening automatically, e.g. for a punishment, or null if you don't want the player to know who silenced them).

reason - the reason the player is being silenced. This message is displayed to the player being silenced. If the "who" parameter is non-null, then the player is told they've been silenced by (who) for reason: (reason). If the "who" parameter is null, the player is told they've been silenced for reason: (reason).