DefaultArrestWarrant

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.planet_ink.coffee_mud.Common
Class DefaultArrestWarrant

java.lang.Object
  com.planet_ink.coffee_mud.Common.DefaultArrestWarrant

All Implemented Interfaces:: CMCommon, LegalWarrant, CMObject, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DefaultArrestWarrant
extends java.lang.Object
implements LegalWarrant
extends java.lang.Object
implements LegalWarrant

Constructor Summary
`DefaultArrestWarrant()`

Method Summary
`void`	`addPunishmentParm(int code, java.lang.String parm)` If applicable, sets any parameters associated with a particular bitmask on the punishment.
`MOB`	`arrestingOfficer()` If the criminal has been identified by an otherwise unoccupied officer, this will be that officer.
`int`	`compareTo(CMObject o)`
`CMObject`	`copyOf()` Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
`java.lang.String`	`crime()` The crime name
`MOB`	`criminal()` The actual player/mob criminal accused of the crime.
`long`	`getIgnoreUntilTime()` Returns the real time in ms when the warrant can no longer be ignored
`long`	`getLastStateChangeTime()` Returns the real time in ms when the state last changed.
`java.lang.String`	`getPunishmentParm(int code)` If applicable, returns any parameters associated with a particular bitmask on the punishment.
`java.lang.String`	`ID()` The CoffeeMud Java Class ID shared by all instances of this object.
`void`	`initializeClass()` Called ONCE after all objects are loaded, but before the map is read in during initialization.
`Room`	`jail()` Returns the room into which this criminal will be jailed.
`int`	`jailTime()` If applicable, returns the number of ticks the punishment calls for the criminal to remain in jail.
`long`	`lastOffense()` Returns the last time, in miliseconds since 1970, the criminal has committed this crime.
`java.lang.String`	`name()` The displayable name of this object.
`CMObject`	`newInstance()` Returns a new instance of this class.
`int`	`offenses()` Returns the number of times this criminal has done this crime.
`int`	`punishment()` Gets the full punishment code for the crime
`Room`	`releaseRoom()` Returns the room into which this criminal will be released after jail.
`void`	`setArrestingOfficer(Area legalArea, MOB mob)` If the criminal has been identified by an otherwise unoccupied officer, this will set that officer.
`void`	`setCrime(java.lang.String newcrime)` Sets the crime name
`void`	`setCriminal(MOB mob)` Sets the actual player/mob criminal accused of the crime.
`void`	`setIgnoreUntilTime(long time)` Sets the real time in ms when the warrant can no longer be ignored
`void`	`setJail(Room R)` Sets the room into which this criminal will be jailed.
`void`	`setJailTime(int time)` If applicable, sets the number of ticks the punishment calls for the criminal to remain in jail.
`void`	`setLastOffense(long last)` Sets the last time, in miliseconds since 1970, the criminal has committed this crime.
`void`	`setOffenses(int num)` Sets the number of times this criminal has done this crime.
`void`	`setPunishment(int code)` Sets the full punishment code for the crime
`void`	`setReleaseRoom(Room R)` Sets the room into which this criminal will be released after jail.
`void`	`setState(int newstate)` Sets the current state of adjudication.
`void`	`setTravelAttemptTime(long time)` Sets the time, in milis since 1970, that a trip to the judge or to the jail was started.
`void`	`setVictim(MOB mob)` If applicable, sets the victim of the crime (or null)
`void`	`setWarnMsg(java.lang.String msg)` Sets the warning message given to the criminal by the officer.
`void`	`setWitness(MOB mob)` If applicable, sets the witness of the crime (or null)
`int`	`state()` Returns the current state of adjudication.
`long`	`travelAttemptTime()` Returns the time, in milis since 1970, that a trip to the judge or to the jail was started.
`MOB`	`victim()` If applicable, the victim of the crime (or null)
`java.lang.String`	`warnMsg()` Returns the warning message given to the criminal by the officer.
`MOB`	`witness()` If applicable, gets the witness of the crime (or null)

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DefaultArrestWarrant

public DefaultArrestWarrant()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:: ID in interface CMObject

Returns:: the name of this class

name

public java.lang.String name()

Description copied from interface: CMObject

The displayable name of this object. May be modified by phyStats() object. Is derived from the Name().

Specified by:: name in interface CMObject

Returns:: the modified final name of this object on the map.
See Also:: Environmental.Name()

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:: newInstance in interface CMObject

Returns:: a new instance of this class

compareTo

public int compareTo(CMObject o)

Specified by:: compareTo in interface java.lang.Comparable<CMObject>

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:: initializeClass in interface CMObject

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:: copyOf in interface CMObject

Returns:: a clone of this object