wyvern.lib.commands
Class WarnCommand

java.lang.Object
  wyvern.kernel.properties.PList
      wyvern.kernel.commands.SimpleHandler
          wyvern.lib.commands.WarnCommand

All Implemented Interfaces:

BuiltInCommand, Command, PropertyList

public class WarnCommand

extends SimpleHandler

A simple player-warning system. Allows players to issue warnings to other players.

Version:

1.0, May 26, 2003

Author:

Steve Yegge

Field Summary

static int

THRESHOLD Each time a player's lifetime warning level (stored in an int "warnings" property) passes a multiple of this threshold value, they get a new punishment.

Fields inherited from class wyvern.kernel.commands.SimpleHandler

delay_

Fields inherited from class wyvern.kernel.properties.PList

readOnly_

Fields inherited from interface wyvern.lib.PropertyList

PROPERTY_PACKAGE

Method Summary

void	addCommands(java.util.Map commands, CommandList list) Adds our commands.
static WarnCommand	getImpl()
boolean	handleEvent(CommandEvent event) Implements the "warn" commands.
static void	main(java.lang.String[] args) Tests the regex matching.
static void	punishOnline(Player warnee, int old_points, int new_points) Dishes out a punishment, if the warned player has crossed a warning threshold.

Methods inherited from class wyvern.kernel.commands.SimpleHandler

createEvent, execute, knowsCommand

Methods inherited from class wyvern.kernel.properties.PList

addProperty, addTransientProperty, adjustDoubleProperty, adjustIntProperty, adjustLongProperty, adjustTransientDoubleProperty, adjustTransientIntProperty, adjustTransientLongProperty, countLocalProperties, debugProperties, dismantlePropertyList, getDoubleProperty, getInheritedProperty, getInteger, getIntProperty, getLocalProperties, getLocalProperty, getLongProperty, getParent, getPersistentDoubleProperty, getPersistentIntProperty, getPersistentLocalProperties, getPersistentLongProperty, getPersistentProperty, getProfilingInfo, getProperties, getProperties, getPropertiesIncludingTransients, getPropertiesIncludingTransients, getProperty, getSerializableProperties, getSerializableProperty, getStringProperty, getTransientDoubleProperty, getTransientIntProperty, getTransientLongProperty, getTransientProperties, getTransientProperty, hasLocalProperty, hasPersistentProperty, hasProperty, hasTransientProperty, inheritProperty, isReadOnly, isRemoved, isTransientlyRemoved, printLocalProperties, printProperties, printProperties, printTransientProperties, removeProperty, removeTransientProperty, setDoubleProperty, setIntProperty, setLongProperty, setParent, setProperty, setReadOnly, setTransientDoubleProperty, setTransientIntProperty, setTransientLongProperty, setTransientProperty, toString, toString, transientlyRemoveProperty

Methods inherited from class java.lang.Object

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

Field Detail

THRESHOLD

public static final int THRESHOLD

Each time a player's lifetime warning level (stored in an int "warnings" property) passes a multiple of this threshold value, they get a new punishment.

See Also:

Constant Field Values

Method Detail

getImpl

public static WarnCommand getImpl()

addCommands

public void addCommands(java.util.Map commands,
                        CommandList list)

Adds our commands.

Specified by:

addCommands in interface BuiltInCommand

Specified by:

addCommands in class SimpleHandler

Parameters:

commands - a Map whose keys are the command verbs, and whose values are references to the SimpleHandler instance that wants to handle the command.

list - the Player, Monster, Vehicle or other CommandList implementation for which addCommands() is being called.

handleEvent

public boolean handleEvent(CommandEvent event)

Implements the "warn" commands.

Specified by:

handleEvent in class SimpleHandler

Parameters:

event - a CommandEvent with various fields filled in: the agent performing the command, the command verb and arguments, the delay for the command, and success/failure messages.

Returns:

true if the event was completed successfully; false if it couldn't be executed for some reason. It's important to return the right value, since the appropriate post-hook will be run depending on whether the command succeeded or failed.

punishOnline

public static void punishOnline(Player warnee,
                                int old_points,
                                int new_points)

Dishes out a punishment, if the warned player has crossed a warning threshold.

Parameters:

warnee - the player being warned (must be online)

old_points - the player's previous "warnings" count

new_points - the player's new "warnings" count

main

public static void main(java.lang.String[] args)

Tests the regex matching.