Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
 PREV   NEXT FRAMES    NO FRAMES    

Serialized Form

Package com.tootsville

Class com.tootsville.Coupon extends SQLPeerDatum implements Serializable

serialVersionUID: -910537582879371680L

Serialized Fields

couponAmount

BigDecimal couponAmount
WRITEME: document this field (twheys@gmail.com, Nov 3, 2009) couponAmount (Coupon)

couponCode

String couponCode
WRITEME: document this field (twheys@gmail.com, Nov 3, 2009) couponCode (Coupon)

couponDescription

String couponDescription
WRITEME FIXME: getText

couponID

int couponID
The coupon's unique ID value

couponMinAmount

BigDecimal couponMinAmount
The minimum amount for the coupon to WTF? WRITEME

couponName

String couponName
The label for this coupon

endDate

Date endDate
The expiry date of this coupon.

startDate

Date startDate
The date at which this coupon becomes effective

usesPerCoupon

int usesPerCoupon
The number of times for which this coupon may be used

usesPerUser

int usesPerUser
The number of times for which one user may use this coupon

Class com.tootsville.IBCUtil extends SQLPeerDatum implements Serializable

serialVersionUID: 221377110802359630L

Serialized Fields

orderCode

String orderCode
WRITEME: document this field (twheys@gmail.com, Nov 3, 2009) orderCode (IBCUtil)

orderSource

String orderSource
Order Source must be one of the following values "avl, cncl, or rdmd"

orderStatus

String orderStatus
WRITEME

productCode

int productCode
WRITEME

redeemedByUserID

int redeemedByUserID
WRITEME

Class com.tootsville.Store extends SQLPeerDatum implements Serializable

serialVersionUID: -8503595537842839095L

Serialized Fields

id

int id
store's id

items

List<E> items
the set of all items found in the store

Package com.tootsville.npc

Class com.tootsville.npc.DinerDishWasher extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: 8711732839063374312L

Class com.tootsville.npc.Harmony extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: -1963742234389687039L

Serialized Fields

nextAppearance

long nextAppearance
WRITEME: Document this brpocock@star-hope.org

nextExit

long nextExit
WRITEME: Document this brpocock@star-hope.org

kidWalksUpHandler

ActionHandler kidWalksUpHandler
handler for kids walking onto her Tuffet

Class com.tootsville.npc.ShortOrderCook extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: 6712696516747032143L

Serialized Fields

foods

String[] foods
List of foods. Accessed by DinerDiner also. Names match emotes.

apronItem

int apronItem
The apron which has to be worn to be an employee.

Class com.tootsville.npc.Smudge extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: 7197433632861194562L

Serialized Fields

smudgeItems

List<E> smudgeItems
Room items, the things that get left behind when Smudge smudges up a place.

returningToOcean

boolean returningToOcean
WRITEME

fleeing

boolean fleeing
WRITEME

seenZap

long seenZap
WRITEME

seenShade

long seenShade
WRITEME

lastObservedPlayers

long lastObservedPlayers
WRITEME

hiPattern

Pattern hiPattern
WRITEME

tLastActionCheck

long tLastActionCheck
frequency to check for future actions

startRoom

String startRoom
WRITEME: Document this brpocock@star-hope.org

Class com.tootsville.npc.SoccerBall extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: 8593896744538972677L

Serialized Fields

BALL_RADIUS

int BALL_RADIUS
ball radius

Class com.tootsville.npc.Stu extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: -1198018618268919892L

Serialized Fields

lastCasualInvite

long lastCasualInvite
WRITEME: Document this brpocock@star-hope.org

Class com.tootsville.npc.Volleyball extends SoccerBall implements Serializable

serialVersionUID: 4901576938301015117L

Package com.tootsville.promo

Class com.tootsville.promo.PeanutCode extends SQLPeerDatum implements Serializable

serialVersionUID: -9157201241413515864L

Serialized Fields

issued

Timestamp issued

maxPeanuts

BigDecimal maxPeanuts

minPeanuts

BigDecimal minPeanuts

peanutCode

String peanutCode

redeemedByID

int redeemedByID

redeemedOn

Timestamp redeemedOn

serialID

int serialID

Class com.tootsville.promo.Promotion extends SQLPeerDatum implements Serializable

serialVersionUID: -8498015398061540649L

Serialized Fields

code

char[] code
4 letter tracking code for storing a referer for User.

description

String description
Description of this promotion.

link

String link
The link used for advertisement links. link is a relative link with the format: https://members.tootsville.com/l/{#link} Only provide the last part of the link.

promotionID

int promotionID
The ID of this promotion

redirect

String redirect
URL to where the tracking link redirects to.

type

Promotion.TrackingType type
The Tracking type for this promotion.

See Also:
Promotion.TrackingType
Package com.tootsville.quicksilver

Class com.tootsville.quicksilver.SimpleFilter extends SQLPeerDatum implements Serializable

serialVersionUID: -5688611554798265140L

Serialized Fields

id

int id
filter ID

title

String title
filter title

Package com.tootsville.sys.op

Class com.tootsville.sys.op.ModeratorJournal extends SQLPeerDatum implements Serializable

serialVersionUID: -2563726734882518619L

Serialized Fields

authorID

int authorID
Deprecated. 
User ID of the author

See Also:
User

entryText

String entryText
Deprecated. 
Text entered into the entry

id

int id
Deprecated. 
ID of the journal entry

references

HashMap<K,V> references
Deprecated. 
Refences to users made in the shift journal. This is accomplished by entering an "@username" into the entry.

stamp

Timestamp stamp
Deprecated. 
Timestamp of when the post was created.

Package com.tootsville.user

Class com.tootsville.user.Toot extends User implements Serializable

serialVersionUID: 5113003589233884081L

Serialized Fields

trailer

TootUserTrailer trailer
Trailer record for a Toot

Class com.tootsville.user.TootUserTrailer extends SimpleDataRecord<TootUserTrailer> implements Serializable

serialVersionUID: -5294630506765346172L

Serialized Fields

basic8Choice

int basic8Choice
The Toot from the Basic 8 that they originally chose.

tootTimeLeft

int tootTimeLeft
The number of hours remaining of this user's Toot Timer

tootTimeLeftMinutes

int tootTimeLeftMinutes
The number of minutes (beyond the hour) remaining of this user's Toot Timer

tootTimerDay

boolean tootTimerDay
If true, the user's Toot Timer will refill every day CV TootUserTrailer.tootTimerMonth

tootTimeRefill

int tootTimeRefill
The number of hours which are added to the Toot Timer on each refill.

tootTimerMonth

boolean tootTimerMonth
If true, the user's Toot Timer will refill every month. CV TootUserTrailer.tootTimerDay

id

int id
user ID

Package net.authorize.admc

Class net.authorize.admc.AppendableException extends Exception implements Serializable

serialVersionUID: 1118698211607092030L

Serialized Fields

appendages

List<E> appendages
Package net.authorize.admc.authnet

Class net.authorize.admc.authnet.AuthNetException extends AppendableException implements Serializable

serialVersionUID: -1511655475719179950L

Package org.starhope.appius.except

Class org.starhope.appius.except.AlreadyExistsException extends Exception implements Serializable

serialVersionUID: -751452585358243489L

Serialized Fields

reason

String reason
reason for the exception

Class org.starhope.appius.except.AlreadyLoadedException extends Exception implements Serializable

serialVersionUID: 6056918068724660283L

Serialized Fields

newID

long newID
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) newID (AlreadyLoadedException)

oldID

long oldID
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) oldID (AlreadyLoadedException)

Class org.starhope.appius.except.AlreadyUsedException extends Exception implements Serializable

serialVersionUID: 1464192624700398564L

Serialized Fields

reason

String reason
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) reason (AlreadyUsedException)

when

Date when
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) when (AlreadyUsedException)

Class org.starhope.appius.except.ChildSecurityException extends Exception implements Serializable

serialVersionUID: -751452585358243489L

Serialized Fields

myReason

String myReason
Reason for exception

Class org.starhope.appius.except.CredentialExpiredException extends Exception implements Serializable

serialVersionUID: -585676019199823239L

Class org.starhope.appius.except.DataException extends Exception implements Serializable

serialVersionUID: 3437973344124958820L

Serialized Fields

complaint

String complaint
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) complaint (DataException)

Class org.starhope.appius.except.ForbiddenUserException extends Exception implements Serializable

serialVersionUID: 4022968581619547737L

Serialized Fields

message

String message
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) message (ForbiddenUserException)

Class org.starhope.appius.except.GameLogicException extends Exception implements Serializable

serialVersionUID: 1847882813339365932L

Serialized Fields

myObj

Object myObj
WRITEME

myOther

Object myOther
WRITEME

myString

String myString
WRITEME

Class org.starhope.appius.except.NonSufficientFundsException extends Exception implements Serializable

serialVersionUID: -6462517287925538686L

Serialized Fields

lack

BigDecimal lack
the amount of money lacking

Class org.starhope.appius.except.NotFoundException extends Exception implements Serializable

serialVersionUID: 1L

Serialized Fields

msg

String msg
WRITEME: document this field (brpocock@star-hope.org, Nov 5, 2009) msg (NotFoundException)

Class org.starhope.appius.except.NotImplementedException extends Exception implements Serializable

serialVersionUID: 5807522909889820110L

Class org.starhope.appius.except.NotReadyException extends Exception implements Serializable

serialVersionUID: 1L

Class org.starhope.appius.except.ParameterException extends Exception implements Serializable

serialVersionUID: 6973758282644073298L

Serialized Fields

reason

String reason
WRITEME

Class org.starhope.appius.except.PrivilegeRequiredException extends Exception implements Serializable

serialVersionUID: -2189758661731450124L

Serialized Fields

requiredCap

SecurityCapability requiredCap
WRITEME

requiredLevel

int requiredLevel
WRITEME

message

String message
WRITEME

Class org.starhope.appius.except.SerialDataException extends RuntimeException implements Serializable

serialVersionUID: 5151664588572493321L

Serialized Fields

reasonCode

String reasonCode
The reason that the serial data is naughty reasonCode (SerialDataException)

Class org.starhope.appius.except.UserDeadException extends Exception implements Serializable

serialVersionUID: 666L

Package org.starhope.appius.game

Class org.starhope.appius.game.AvatarDecoration extends Object implements Serializable

serialVersionUID: -2121950898686468645L

Serialized Fields

filename

String filename

position

org.starhope.appius.geometry.Coord3D position

Class org.starhope.appius.game.DamageArea extends SimpleDataEnum<DamageArea> implements Serializable

serialVersionUID: -5733684885557722767L

Class org.starhope.appius.game.DamageTypeRanks extends Object implements Serializable

serialVersionUID: 4593720566596804907L

Serialized Fields

scores

Map<K,V> scores
The actual scores. Zeroes are not saved.

Class org.starhope.appius.game.Room extends SimpleDataRecord<Room> implements Serializable

serialVersionUID: 777843822192305721L

Serialized Fields

vehicleStyle

VehicleStyle vehicleStyle
Type of vehicle permissions to apply

gameEvents

HashSet<E> gameEvents
GameEvents attached to this room

homeOwner

AbstractUser homeOwner

The owner of a room; usually null for public rooms, or non-null for users' houses.

The special room variable homeOwner reflects

iAmInLimbo

boolean iAmInLimbo
Determine whether this room is a limbo room

See Also:
discussion of Limbo on Room.isLimbo ()

id

int id
WRITEME: Document this brpocock@star-hope.org

lastLagComputed

long lastLagComputed
The time at which the local lag was last recomputed

listeners

Collection<E> listeners
WRITEME: Document this brpocock@star-hope.org

localLagMax

long localLagMax
The local average lag

moniker

String moniker
The moniker / unique identifier for this room.

myID

int myID
The unique ID number for this room (room number)

observers

ConcurrentSkipListSet<E> observers
Non-Users who are present to pay attention to things happening in the room

obstacles

Map<K,V> obstacles
Individual obstacle spaces

owners

Collection<E> owners
OWners of a room are permitted to alter it (to a degree).

roomIndex

int roomIndex
When the room is a part of an user's house, which room index number is it?

roomVariables

ConcurrentHashMap<K,V> roomVariables
The set of variables set upon the room

skyVisible

boolean skyVisible
Whether the sky is visible in this room.

sounds

Collection<E> sounds
WRITEME: Document this brpocock@star-hope.org

subjectToWeather

boolean subjectToWeather
Whether this room is subject to weather (e.g. rain)

TODO: save to database

title

String title
The user-visible title of this room

userLimit

int userLimit
WRITEME

userList

ConcurrentSkipListSet<E> userList
The list of all users in this room. These should maybe be weak references or something fancy, in future.

volume

org.starhope.appius.geometry.Volume3D volume
WRITEME: Document this brpocock@star-hope.org

walkableSpace

GeneralPath walkableSpace
the area in which a player could walk

walkSpaces

Map<K,V> walkSpaces
Individual walkable spaces

world

String world
WRITEME

worldCoords

org.starhope.appius.geometry.Coord3D worldCoords
WRITEME

zone

Zone zone
The zone in which this room exists

places

Set<E> places
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.game.SimpleDataEnum extends SimpleDataRecord<T extends SimpleDataEnum<?>> implements Serializable

serialVersionUID: -3794637927217760102L

Serialized Fields

id

int id
The value of this enumerated name

name

String name
The name of this enumeration value

Class org.starhope.appius.game.VehicleStyle extends Object implements Serializable

Serialized Fields

permitWheeled

boolean permitWheeled
Whether wheeled or dragged (e.g. ski) vehicles are permitted.

permitMounts

boolean permitMounts
Whether mounted vehicles (e.g. horses) are permitted

permitFloating

boolean permitFloating
Whether floating (in the sense of flying) vehicles are permitted

limitToDriveSpace

boolean limitToDriveSpace
Limit vehicles to the driveable space defined as $drive

Package org.starhope.appius.game.inventory

Class org.starhope.appius.game.inventory.GenericItemReference extends SimpleDataRecord<GenericItemReference> implements Serializable

serialVersionUID: 1330548723192564366L

Serialized Fields

canTrade

boolean canTrade
Whether this item can be traded, dropped, or given away. If this is false, then the item is stuck forever in inventory (barring NPC actions or similar) once it has been lodged there.

currency

Currency currency
the currency units for the price

description

String description
user-visible description

itemID

int itemID
unique database ID

itemType

InventoryItemType itemType
the general class or slot of items to which this belongs. Used principally for equipping items into particular slots and displaying inventory listings.

price

BigDecimal price
price in currency units

rarity

RarityRating rarity
how rare is this item when items are randomly given out

title

String title
user-visible title

healthType

HealthType healthType
Health interpretation is determined by this enumeration type.

equipType

EquipType equipType

Whether this item is an equippable item which traps a specific class of events is indicated by this field.

effectsTypeID

int effectsTypeID
The ID of the ItemEffectsType to determine the ItemEffects for this item.

equipSlot

char equipSlot
The effects slot for this item. See discussion at GenericItemReference.setEquipSlot(char)

Class org.starhope.appius.game.inventory.Inventory extends SimpleDataRecordSet<InventoryItem,Inventory> implements Serializable

serialVersionUID: 3303661907168440573L

Serialized Fields

items

ConcurrentSkipListSet<E> items
The internal cache of the user's inventory is kept in this set

owner

AbstractUser owner
The user whose inventory is represented by this object

Class org.starhope.appius.game.inventory.InventoryItem extends SimpleDataRecord<InventoryItem> implements Serializable

serialVersionUID: -7833931788040090009L

Serialized Fields

active

boolean active
if true, the item is equipped/active

colours

List<E> colours
The colours that define the appearance of this item. XXX: only single-colour items are supported in Tootsville™ right now.

facing

String facing
WRITEME: Document this brpocock@star-hope.org

health

BigDecimal health
The health of the item

itemID

int itemID
the item ID

owner

AbstractUser owner
user owning this item

roomNumber

int roomNumber
room number (of all rooms owned by the given owner)

slotNumber

int slotNumber
The slot/series in which this occurs in the player's inventory

type

InventoryItemType type
WRITEME

x

double x
WRITEME: Document this brpocock@star-hope.org

y

double y
WRITEME: Document this brpocock@star-hope.org

z

double z
WRITEME: Document this brpocock@star-hope.org

effects

ItemEffects effects
See Also:
InventoryItem.getItemEffects()

Class org.starhope.appius.game.inventory.InventoryItemType extends SimpleDataRecord<InventoryItemType> implements Serializable

serialVersionUID: 8514877584411321981L

Serialized Fields

conflicts

Set<E> conflicts
Types that conflict (can't be equipped at the same time)

hasValences

boolean hasValences
Boolean: whether to observe valence levels (or not)

id

int id
Unique ID

name

String name
Unique name

valences

Set<E> valences
Valence levels. See InventoryItemType.getValences() for discussion.

Class org.starhope.appius.game.inventory.ItemEffectsType extends SimpleDataRecord<ItemEffectsType> implements Serializable

serialVersionUID: 493203430706748669L

Serialized Fields

fxLib

WeakHashMap<K,V> fxLib
Caché of instantiated item effects for various items, set up such that they should expire when the items are unloaded from core by virtue of their weak references.

id

int id
The database ID for this effects type

klass

String klass
The class name for this type of effects

Class org.starhope.appius.game.inventory.RarityRating extends SimpleDataRecord<RarityRating> implements Serializable

serialVersionUID: -483347188430410551L

Serialized Fields

description

String description
WRITEME: Document this brpocock@star-hope.org

id

int id
WRITEME: Document this brpocock@star-hope.org

value

String value
WRITEME

Package org.starhope.appius.game.inventory.collections

Class org.starhope.appius.game.inventory.collections.ItemCollection extends SimpleDataRecord<ItemCollection> implements Serializable

serialVersionUID: 5869990447794687083L

Serialized Fields

set

List<E> set
Internal implementation pass-through collection

title

String title
Unique name of the collection

collectionID

int collectionID
Unique ID of the collection

onCompleteEvent

EventType onCompleteEvent
event fired when the user completes the collection

onBreakEvent

EventType onBreakEvent
event fired when a previously-complete collection is broken

Class org.starhope.appius.game.inventory.collections.UserItemCollection extends SimpleDataRecord<UserItemCollection> implements Serializable

serialVersionUID: -2212742414142718801L

Serialized Fields

items

Set<E> items
the items that this user has collected which are a part of this set

owner

AbstractUser owner
the owner of this collection

title

String title
the title of this set

rewardEvent

EventType rewardEvent
WRITEME: Document this brpocock@star-hope.org

Package org.starhope.appius.game.npc

Class org.starhope.appius.game.npc.Ejecta extends GeneralUser implements Serializable

serialVersionUID: 2420951494623865426L

Serialized Fields

myAction

String myAction
The action currently being played for the Ejecta

myAvatar

AvatarClass myAvatar
The avatar class for the Ejecta

myFacing

String myFacing
The avatar's facing direction

myPosition

org.starhope.appius.geometry.Coord3D myPosition
The Ejecta's position

myRoom

Room myRoom
The Ejecta's room

myTarget

org.starhope.appius.geometry.Coord3D myTarget
The Ejecta's destination coördinates

myTravelRate

double myTravelRate
The Ejecta's rate of travel

myTravelStart

long myTravelStart
The Ejecta's travel start time

myUserID

int myUserID
The Ejecta's user ID

myStartT

long myStartT
See Also:
AbstractUser.getStartT()

locationLock

ReentrantLock locationLock
Locking semaphore for location

See Also:
AbstractUser.getLocationForUpdate(), AbstractUser.unlockLocation()

Class org.starhope.appius.game.npc.Particle extends Ejecta implements Serializable

serialVersionUID: 6734832968465418853L

Class org.starhope.appius.game.npc.Projectile extends Ejecta implements Serializable

serialVersionUID: -601773981170045064L

Serialized Fields

hitEffect

DamageHitHandler hitEffect
WRITEME brpocock@star-hope.org

missEffect

DamageMissHandler missEffect
WRITEME

myShooter

AbstractUser myShooter
Who fired this shot

myHitParticle

AvatarClass myHitParticle
WRITEME: Document this brpocock@star-hope.org

myMissParticle

AvatarClass myMissParticle
WRITEME: Document this brpocock@star-hope.org

myWatcher

Projectile.ProjectileWatcher myWatcher
WRITEME: Document this brpocock@star-hope.org

attacker

AbstractUser attacker
WRITEME: Document this brpocock@star-hope.org

startLocation

org.starhope.appius.geometry.Coord3D startLocation
WRITEME: Document this brpocock@star-hope.org

myDamage

DamageTypeRanks myDamage
WRITEME

Class org.starhope.appius.game.npc.QuestItemExchanger extends AbstractNonPlayerCharacter implements Serializable

serialVersionUID: 7867396818890658736L

Serialized Fields

speechReactions

Map<K,V> speechReactions
WRITEME

itemReactions

Map<K,V> itemReactions
WRITEME

itemExchanges

Map<K,V> itemExchanges
WRITEME

itemFollowUps

Map<K,V> itemFollowUps
WRITEME

Package org.starhope.appius.mb

Class org.starhope.appius.mb.Currency extends SimpleDataRecord<Currency> implements Serializable

serialVersionUID: -6340388141547546058L

Serialized Fields

code

String code
The ISO-4217 currency code (three letters); "USD" is U.S. Dollar, and "EUR" is the Euro.

symbol

String symbol
The display character sequence. For US Dollars, it's " US $ "; for Euros, it's just the Euro sign

title

String title
Title

Class org.starhope.appius.mb.Enrolment extends SimpleDataRecord<Enrolment> implements Serializable

serialVersionUID: 7040272239205566945L

Serialized Fields

autoRenew

boolean autoRenew
WRITEME

available

boolean available
WRITEME

id

int id
WRITEME

price

BigDecimal price
WRITEME

productCode

String productCode
WRITEME

renewDays

int renewDays
WRITEME

renewMonths

int renewMonths
WRITEME

title

String title
WRITEME

autoRenewAsk

boolean autoRenewAsk
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.mb.MBField_CreditCardNumber extends org.starhope.appius.mb.fields.MBField<BigInteger> implements Serializable

serialVersionUID: -3138602965539288979L

Class org.starhope.appius.mb.MBField_NumericString extends org.starhope.appius.mb.fields.MBField_String implements Serializable

serialVersionUID: 5101722040449014704L

Serialized Fields

minDigits

int minDigits
WRITEME: Document this brpocock@star-hope.org

maxDigits

int maxDigits
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.mb.MBSession extends Object implements Serializable

serialVersionUID: -6635727759761934756L

Serialized Fields

address1

org.starhope.appius.mb.fields.MBField_String address1
Street address (first line)

address2

org.starhope.appius.mb.fields.MBField_String address2
Street address (second line)

buyerFamilyName

org.starhope.appius.mb.fields.MBField_String buyerFamilyName
Buyer's family name / surname

buyerGivenName

org.starhope.appius.mb.fields.MBField_String buyerGivenName
Buyer's given name

canContact

org.starhope.appius.mb.fields.MBField_Boolean canContact
Permission to contact the user

characterClass

org.starhope.appius.mb.fields.MBField_DataRecord<T extends DataRecord> characterClass
WRITEME: Document this brpocock@star-hope.org

child

org.starhope.appius.mb.fields.MBField_Child child
The child currently selected by a parent

city

org.starhope.appius.mb.fields.MBField_String city
City/town/village/&c

country

org.starhope.appius.mb.fields.MBField_String country
country

creditCardCode

MBField_NumericString creditCardCode
Credit-Card confirmation code, aka CVC, CCV, and a million other names. The confirmation code off the back of the card.

creditCardExpiry

org.starhope.appius.mb.fields.MBField_Calendar creditCardExpiry
expiry date (month and year only are significant)

creditCardNumber

MBField_CreditCardNumber creditCardNumber
Credit-card number

creditCardType

org.starhope.appius.mb.fields.MBField_String creditCardType
Credit-card type string, “visa” or “mastercard”

mailAuth

org.starhope.appius.mb.fields.MBField_Mail mailAuth
Parent logins

dateOfBirth

org.starhope.appius.mb.fields.MBField_DateOfBirth dateOfBirth
New user registering, date of birth

enrolmentChosen

org.starhope.appius.mb.fields.MBField_DataRecord<T extends DataRecord> enrolmentChosen
Enrolment type chosen

errors

EnumMap<K extends Enum<K>,V> errors
WRITEME: Document this brpocock@star-hope.org

errorToasts

Set<E> errorToasts
Error message toasts

extraParams

Map<K,V> extraParams
extra params set for local use

forgotPasswordA

org.starhope.appius.mb.fields.MBField_String forgotPasswordA
Forgotten password recovery question's answer

forgotPasswordQ

org.starhope.appius.mb.fields.MBField_String forgotPasswordQ
Forgotten password recovery question

givenName

org.starhope.appius.mb.fields.MBField_String givenName
User's self-identified given name (optional)

goals

EnumSet<E extends Enum<E>> goals
Goals that the user is trying to acheive

loginAuth

org.starhope.appius.mb.fields.MBField_String loginAuth
Login, being entered for authentication purposes

loginRequested

org.starhope.appius.mb.fields.MBField_LoginRequest loginRequested
Login, being requested for new registration or rename

mailProvided

org.starhope.appius.mb.fields.MBField_Mail mailProvided
User's mail, maybe for registration, maybe for parent login

passwordAuth

org.starhope.appius.mb.fields.MBField_Password passwordAuth
Password, being provided for authentication purposes

passwordRequested

org.starhope.appius.mb.fields.MBField_Password passwordRequested
Password, being requested for new registration or password-change

payment

org.starhope.appius.mb.fields.MBField_Payment payment
Payment being constructed

phone

org.starhope.appius.mb.fields.MBField_String phone
phone number

postalCode

org.starhope.appius.mb.fields.MBField_String postalCode
postal code / ZIP code

prepaidCode

org.starhope.appius.mb.fields.MBField_String prepaidCode
Code from a prepaid card or promotion

province

org.starhope.appius.mb.fields.MBField_String province
State/province/locality/county/whatever

rulesAgree

org.starhope.appius.mb.fields.MBField_Boolean_True rulesAgree
Agree to some rules other than the T&C

sourceCookie

String sourceCookie
a cookie identifying the referral source for the user coming in

termsConditionsAgree

org.starhope.appius.mb.fields.MBField_Boolean_True termsConditionsAgree
User agreeing to terms and conditions

toasts

Map<K,V> toasts
Toasts

visitorAsParent

Parent visitorAsParent
the parent who is visiting the site (if one, see MBSession.visitorRole)

visitorAsUser

User visitorAsUser
the user who is visiting the site (if one, see MBSession.visitorAsUser)

visitorRole

VisitorRole visitorRole
whether the current visitor to the site is acting for themself, or is a parent

latestSource

String latestSource
The latest place from which the user accessed this session.

mySerial

int mySerial
Local session unique serial number for debugging tracing

lastPage

String lastPage
previous page viewed

latestPage

String latestPage
current page being viewed

Class org.starhope.appius.mb.Payment extends SQLPeerDatum implements Serializable

serialVersionUID: -1771086264450320549L

Serialized Fields

annotations

HashMap<K,V> annotations

The collection of additional annotations for record-keeping or other purposes. These are things not used by the system, but which are tracked in case they're useful for human review, auditing, etc.

Annotations are keyed off dotted domain sequences in the same general fashion as Java class names, etc.

closed

boolean closed
Once this is set, no further setting is accepted to any internal fields: the payment record is closed out completely.

expiryMonth

int expiryMonth
WRITEME

expiryYear

int expiryYear
The year in which the credit-card used to pay for this transaction will expire. Actual year value, 2009 = 2009.

order_code

String order_code
The order code is an unique string for this order among all orders placed through a specific source (payment gateway, generally)

order_source

String order_source
The order's source code is an identifier which maps to the payment gateway class, but is user-visible as a part of the total payment identifier (source, code, and sequence number)

paid

BigDecimal paid
The amount actually paid with this payment. This should generally be the same as the price (I can't think of a valid counter-example!)

payer

String payer
The identification of the payer

paymentFor

String paymentFor
WRITEME

paymentGateway

PaymentGatewayReal paymentGateway
Through what payment gateway was this payment processed?

price

BigDecimal price
The price paid in this payment

resultReason

String resultReason
The reason for the failure (if it failed), or the authorization code for the success (if it succeeded)

sequence

int sequence
The sequence number indicates a series of payments that are related to the same event; this is (always, right now, but) typically a subscription recurring every month.

stamp

Timestamp stamp
The moment in time at which, per our accounting, this payment took place. Note that the user might see a different time on his or her wall clock or credit card statements, &c. There is a degree of ambiguity about when various people consider the transaction to have been completed. Per our purposes, this is that moment.

success

boolean success
Was the payment a success? We keep records of failed payments, too, so it's important to ask that question.

testMode

boolean testMode
Was this a test transaction, submitted by the system? It's possible. If this is true, we shouldn't give out anything because of it.

transactionCode

BigDecimal transactionCode
The transaction code returned by the payment gateway

userEnrolment

UserEnrolment userEnrolment
If this payment was made for an enrolment subscription (right now (TODO) they all are), then this stores the pointer to the UserEnrolment record in question.

verified

boolean verified
True, if the payment has been reconciled or verified.

Class org.starhope.appius.mb.PaymentGateway extends SQLPeerDatum implements Serializable

serialVersionUID: -3850242661914601113L

Serialized Fields

code

String code
WRITEME

implementation

PaymentGatewayReal implementation
WRITEME

implementor

String implementor
The class implementing the actual functionality, e.g. org.starhope.appius.pay.AuthorizeNetGateway

managementURL

String managementURL
WRITEME

title

String title
WRITEME

user

AbstractPerson user
WRITEME

Class org.starhope.appius.mb.UserAddress extends SQLPeerDatum implements Serializable

serialVersionUID: 8046742159122084295L

Serialized Fields

address

String address
Street address (or similar), line 1 (of 2)

See Also:
UserAddress.address2

address2

String address2
Street address (or similar), line 2 (of 2)

See Also:
UserAddress.address

addressType

String addressType
The type of location described; might be e.g. Billing, Home, Office.

city

String city
The city, town, village, &c. part of the address

country

String country
The 2-digit ISO country code

database_id

int database_id
The unique ID for storing this address into the database (if so stored)

latitude

BigDecimal latitude
if known, the latitude of the address

locality

String locality
the locality or other subdivisional indicia of the address

longitude

BigDecimal longitude
if known, the longitude of the address

mail

String mail
an eMail address

phone

String phone
a telephone number with local formatting as desired

postalCode

String postalCode
The postal or ZIP code. US ZIP codes must not have the ZIP+4 or 12-digit format in this variable.

province

String province
The state or province

title

String title
A user-selected title for convenience of user selection of an address from a collection

user

AbstractPerson user
The user affiliated with this address

validatedByDomain

String validatedByDomain
The Internet Domain Name of the service used for validation (e.g. "google.com" for Google Maps); null, if the address has not been validated

validatedOn

Date validatedOn
The date of validation, if this address has been externally validated; else, null

zipPlus4

String zipPlus4
WRITEME

Class org.starhope.appius.mb.UserEnrolment extends SimpleDataRecord<UserEnrolment> implements Serializable

serialVersionUID: 9064687357655345112L

Serialized Fields

authSubID

BigDecimal authSubID
Authorize.net subscription ID

begins

Date begins
start date

expires

Date expires
expiry date

id

int id
database ID

isActivated

boolean isActivated
Has this enrolment been activated already?

orderCode

String orderCode
order code

orderSource

String orderSource
order source

productID

int productID
Enrolment product ID

userID

int userID
The user who owns this enrolment

Package org.starhope.appius.messaging

Class org.starhope.appius.messaging.BadMailList extends SimpleDataRecordSet<BadMailRecord,BadMailList> implements Serializable

serialVersionUID: 4116058706799325467L

Class org.starhope.appius.messaging.BadMailRecord extends MailAddressRecord implements Serializable

serialVersionUID: 3068054604416278825L

Class org.starhope.appius.messaging.MailAddressRecord extends SimpleDataRecord<MailAddressRecord> implements Serializable

serialVersionUID: -9055209338618445113L

Serialized Fields

address

String address
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.messaging.MailMessage extends SQLPeerDatum implements Serializable

serialVersionUID: -1350270979016126771L

Serialized Fields

attachmentURL

String attachmentURL
URL of an attachment (XXX WHAT?)

body

String body
body of the message

flags

HashMap<K,V> flags
Flags set on this message, stored by key of the userID who created the flag and the value of the flag names. See MySQL table messageFlags.

fromID

int fromID
sender user ID

fromName

String fromName
sender name

id

int id
message unique ID

inReplyTo

int inReplyTo
If this message is in reply to another, then this is the message ID of the parent message.

isDeleted

boolean isDeleted
If true, the user (or a moderator) has deleted this message

isWallPost

boolean isWallPost
If true, this message is a Wall Post on TootsBook.

read

Timestamp read
WRITEME: document this field (brpocock@star-hope.org, Nov 19, 2009) read (MailMessage)

sent

Timestamp sent
WRITEME: document this field (brpocock@star-hope.org, Nov 19, 2009) sent (MailMessage)

subject

String subject
WRITEME: document this field (brpocock@star-hope.org, Nov 19, 2009) subject (MailMessage)

toID

int toID
WRITEME: document this field (brpocock@star-hope.org, Nov 19, 2009) toID (MailMessage)

toName

String toName
The name of the message's recipient.

Package org.starhope.appius.pay

Class org.starhope.appius.pay.AuthorizeNetGateway extends PaymentGateway implements Serializable

serialVersionUID: 2097382055172793482L

Serialized Fields

address

UserAddress address
Buyer's postal address for CC billing

buyerCompany

String buyerCompany
Company name for buyer

buyerFamilyName

String buyerFamilyName
Buyer's surname

buyerGivenName

String buyerGivenName
Buyer's given name

Package org.starhope.appius.pay.util

Class org.starhope.appius.pay.util.RetryPaymentException extends Exception implements Serializable

serialVersionUID: 6281463386314458042L

Serialized Fields

message

String message
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) message (RetryPaymentException)

p

Payment p
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) p (RetryPaymentException)

retry

Date retry
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) retry (RetryPaymentException)

title

String title
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) title (RetryPaymentException)

Class org.starhope.appius.pay.util.UnsupportedCredentialException extends Exception implements Serializable

serialVersionUID: -6011680212811283881L

Serialized Fields

credentialType

CredentialType credentialType
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) credentialType (UnsupportedCredentialException)

gateway

Class<T> gateway
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) gateway (UnsupportedCredentialException)

message

String message
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) message (UnsupportedCredentialException)

Class org.starhope.appius.pay.util.UnsupportedCurrencyException extends Exception implements Serializable

serialVersionUID: -7609777648104051706L

Serialized Fields

message

String message
WRITEME: document this field (brpocock@star-hope.org, Nov 20, 2009) message (UnsupportedCurrencyException)

Package org.starhope.appius.physica

Class org.starhope.appius.physica.TriangulationApplet extends Object implements Serializable

Package org.starhope.appius.sql

Class org.starhope.appius.sql.SQLPeerDatum extends Object implements Serializable

serialVersionUID: -653828477429404181L

Class org.starhope.appius.sql.SQLPeerEnum extends SQLPeerDatum implements Serializable

serialVersionUID: 8901251122444872319L

Serialized Fields

instance

int instance
Deprecated. 
instance ID

Package org.starhope.appius.sys.admin

Class org.starhope.appius.sys.admin.CapabilityRecords extends SimpleDataRecord<CapabilityRecords> implements Serializable

serialVersionUID: 4868707855847066302L

Serialized Fields

caps

ConcurrentHashMap<K,V> caps
WRITEME

Class org.starhope.appius.sys.admin.Persephone2AppConfig extends SimpleDataRecord<Persephone2AppConfig> implements Serializable

serialVersionUID: 5282483341848226472L

Serialized Fields

id

int id
WRITEME

appiusAddress

InetAddress appiusAddress
WRITEME

appiusPort

int appiusPort
WRITEME

loginZone

String loginZone
WRITEME

suppressVITPopUp

boolean suppressVITPopUp
WRITEME

assetURI

String assetURI
WRITEME

loginBG

String loginBG
WRITEME

tootsBookURL

String tootsBookURL
WRITEME

helpURL

String helpURL
WRITEME

forgetURL

String forgetURL
WRITEME

newAccountURL

String newAccountURL
WRITEME

vitAccountURL

String vitAccountURL
WRITEME

vitAccountInfoURL

String vitAccountInfoURL
WRITEME

peanutCodeURL

String peanutCodeURL
WRITEME

shopURL

String shopURL
WRITEME

cookingURL

String cookingURL
WRITEME

statusReportURL

String statusReportURL
WRITEME

bugReportURL

String bugReportURL
WRITEME

launchDate

Date launchDate
WRITEME

fontLibURL

String fontLibURL
WRITEME

coreLibURL

String coreLibURL
WRITEME

mainURL

String mainURL
WRITEME

Class org.starhope.appius.sys.admin.SecurityCapability extends SQLPeerEnum implements Serializable

serialVersionUID: 4646472117944371702L

Class org.starhope.appius.sys.admin.TheServers extends SimpleDataRecordSet<ZoneServerRecord,TheServers> implements Serializable

serialVersionUID: 6096921012328355668L

Class org.starhope.appius.sys.admin.ZoneServerRecord extends SimpleDataRecord<ZoneServerRecord> implements Serializable

serialVersionUID: 3237801196555351020L

Serialized Fields

serverName

String serverName
WRITEME: Document this brpocock@star-hope.org

zoneName

String zoneName
WRITEME: Document this brpocock@star-hope.org

id

int id
WRITEME: Document this brpocock@star-hope.org

Package org.starhope.appius.sys.op

Class org.starhope.appius.sys.op.Filter extends SQLPeerDatum implements Serializable

serialVersionUID: -3010893618678442775L

Serialized Fields

id

int id
WRITEME: document this field (brpocock@star-hope.org, Nov 19, 2009) id (Filter)

patterns

Map<K,V> patterns
This binds the patterns to their FilterPattern records

title

String title
This is the (admin-visible, but not end-user-visible) title for this filter

Package org.starhope.appius.types

Class org.starhope.appius.types.Colour extends Object implements Serializable

serialVersionUID: 301064641249595141L

Serialized Fields

blue

short blue
WRITEME: document this field (brpocock@star-hope.org, Dec 11, 2009) blue (Colour)

green

short green
WRITEME: document this field (brpocock@star-hope.org, Dec 11, 2009) green (Colour)

red

short red
WRITEME: document this field (brpocock@star-hope.org, Dec 11, 2009) red (Colour)

Class org.starhope.appius.types.GameFlagValue extends SQLPeerEnum implements Serializable

serialVersionUID: -2261276745008584124L

Class org.starhope.appius.types.RoomBadge extends SQLPeerEnum implements Serializable

serialVersionUID: -7582592792547852890L

Package org.starhope.appius.user

Class org.starhope.appius.user.AbstractNonPlayerCharacter extends GeneralUser implements Serializable

serialVersionUID: -6400835991779285364L

Serialized Fields

kalendor

Kalendor kalendor
Just fetch the Kalendor once, and keep working with it, rather than fucking around with fetching it every time.

instanceID

int instanceID
WRITEME

lastActive

long lastActive
WRITEME: Document this brpocock@star-hope.org

buddyList

List<E> buddyList
WRITEME

ignoreList

List<E> ignoreList
WRITEME

casualSpeechQueue

Queue<E> casualSpeechQueue
a queue of arbitrary things that Harmony might say, if she gets bored.

lastSpoken

long lastSpoken
Time at which we last spoke

casualSpeechRate

long casualSpeechRate
the rate at which speech is emitted

Class org.starhope.appius.user.AvatarBodyFormat extends SimpleDataRecord<AvatarBodyFormat> implements Serializable

serialVersionUID: 3840223963034090764L

Serialized Fields

id

int id
Numeric ID of the body format

name

String name
Name of the body format

Class org.starhope.appius.user.AvatarClass extends SimpleDataRecord<AvatarClass> implements Serializable

serialVersionUID: -5006183249551211836L

Serialized Fields

bodyFormat

AvatarBodyFormat bodyFormat
The body format for costuming, &c.

canColor

boolean canColor
whether the avatar class can be colorised

collisionBounds

org.starhope.appius.geometry.PolygonPrimitive<T extends org.starhope.appius.geometry.PolygonPrimitive<?>> collisionBounds
the bounding space for collision detection

collisionBoundsString

String collisionBoundsString
string describing the bounding space for collision detection

defaultBaseColour

Colour defaultBaseColour
the default base colour for the avatar class

defaultExtraColour

Colour defaultExtraColour
the default extra/highlight/feature colour for the avatar class

defaultPattern

GenericItemReference defaultPattern
the default pattern/hairstyle type for the avatar class

defaultPatternColour

Colour defaultPatternColour
the default pattern/hair/additional colour for the avatar class

filename

String filename
avatar class filename

forFree

boolean forFree
A cache of whether each avatar class is available to free users

forPaid

boolean forPaid
A cache of whether each avatar class is available to paid users

height

double height
The height of this avatar type (barring scaling)

id

int id
unique ID

ident

String ident
string identifier

Class org.starhope.appius.user.GeneralUser extends Object implements Serializable

serialVersionUID: 6267186342664921052L

Serialized Fields

collisionBounds

org.starhope.appius.geometry.PolygonPrimitive<T extends org.starhope.appius.geometry.PolygonPrimitive<?>> collisionBounds
Collision boundaries for an unknown thing or other

currentAction

String currentAction
The action or movement currently being performed by the NPC. Usually “Walk” or “idle” but can be any verb understood by the client/avatar combination, e.g. “mosey”

facing

String facing
The direction in which the user is facing. Must be one of: N S E W NE NW SW SE

lastUserMovement

long lastUserMovement
the last time that the user intentionally started moving.

location

org.starhope.appius.geometry.Coord3D location
Current coördinates for the user (as of GeneralUser.travelStartTime)

locationLock

ReentrantLock locationLock
Locking semaphore for location

See Also:
AbstractUser.getLocationForUpdate(), AbstractUser.unlockLocation()

target

org.starhope.appius.geometry.Coord3D target
Destination coördinates towards which the user is currently moving; May be identical to GeneralUser.location

travelStartTime

long travelStartTime
The time at which the user started moving on their current movement vector. Measured in milliseconds since epoch.

userRecord

UserRecord userRecord
The user record backing this user

userVariables

ConcurrentHashMap<K,V> userVariables
Arbitrary user variables which can be set or retrieved by the front-end

pathFinder

PathFinder pathFinder
path controller

baseStats

Map<K,V> baseStats
The user's base stats

baseDefenses

DamageTypeRanks baseDefenses
Inherent basic defenses

Class org.starhope.appius.user.Parent extends SimpleDataRecord<Parent> implements Serializable

serialVersionUID: -793284706598303053L

Serialized Fields

canContact

boolean canContact
consent to receive contact

dialect

String dialect
dialect of language

forgotPasswordAnswer

String forgotPasswordAnswer
password recovery question's answer

forgotPasswordQuestion

String forgotPasswordQuestion
password recovery question

givenName

String givenName
parent's given name (if known)

id

int id
Database ID value

language

String language
language

mail

String mail
email address

mailConfirmed

Date mailConfirmed
the date that the eMail address was confirmed

mailConfirmSent

Date mailConfirmSent
the date that the confirmation mail was sent

password

String password
password

Class org.starhope.appius.user.Passport extends SimpleDataRecord<Passport> implements Serializable

serialVersionUID: -138554407026506110L

Serialized Fields

userID

int userID
The user ID of the owner of this passport

visitedRooms

Set<E> visitedRooms
the set of room monikers which the user has visited

Class org.starhope.appius.user.PathFinder extends Object implements Serializable

serialVersionUID: 171577900883858985L

Serialized Fields

user

AbstractUser user
who is lost?

timedEvent

long timedEvent
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.user.PersonRecord extends SimpleDataRecord<PersonRecord> implements Serializable

serialVersionUID: 1187888911664515622L

Class org.starhope.appius.user.SimpleUserListEntry extends SimpleDataRecord<SimpleUserListEntry> implements Serializable

serialVersionUID: -2698186565644948819L

Serialized Fields

isOnline

boolean isOnline
whether the user is online

login

String login
the user's login

myList

String myList
the list on which this entry occurs

myUser

String myUser
the user owning this list

zone

String zone
the zone in which the user is logged-in (if they are)

Class org.starhope.appius.user.StringRecord extends SimpleDataRecord<StringRecord> implements Serializable

serialVersionUID: -9038677613899529652L

Serialized Fields

myID

int myID
unique ID

myIdent

String myIdent
unique ID

values

Map<K,V> values
The collection of versions of this string in various languages

Class org.starhope.appius.user.StringSet extends SimpleDataRecordSet<StringRecord,StringSet> implements Serializable

serialVersionUID: -3646494586383185976L

Serialized Fields

myID

int myID
unique ID for this set of strings

myName

String myName
unique name for this set of strings

Class org.starhope.appius.user.User extends GeneralUser implements Serializable

serialVersionUID: 4146069318927248889L

Serialized Fields

gender

Gender gender
gender of the user

lastActive

Timestamp lastActive
the time at which the user last was logged on, or the current time (plus 5 seconds) if they're on now.

pathController

long pathController
Are we being controlled by a pathing routine? This should be the timer event for the next path-finding Kalendor Activity.

positioning

Semaphore positioning
Semaphore to lock down positioning updates by physics and such

roundTripLag

long roundTripLag
round-trip lag/latency to/from the client

usePathFinder

boolean usePathFinder
Deprecated. testing only
Temporary: use the testing path finder

Class org.starhope.appius.user.UserHouse extends SimpleDataRecord<UserHouse> implements Serializable

serialVersionUID: -3893501929561618415L

Serialized Fields

houseRooms

ConcurrentHashMap<K,V> houseRooms
The internal representation of the set of Rooms in the user's house

hasRooms

ConcurrentHashMap<K,V> hasRooms
Whether a room has been instantiated or not

houseTypeID

int houseTypeID
The view of the house from outside is hacked in like this for now XXX

lotID

int lotID
The type of lot for the outside is hacked in like this for now XXX

owner

AbstractUser owner
The owner of this house

Class org.starhope.appius.user.UserPreferenceRecord extends SimpleDataRecord<UserPreferenceRecord> implements Serializable

serialVersionUID: -448227682673826827L

Serialized Fields

myUserID

int myUserID
WRITEME: Document this brpocock@star-hope.org

prefs

Map<K,V> prefs
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.user.UserRecord extends SimpleDataRecord<UserRecord> implements Serializable

serialVersionUID: -4136192122359036981L

Serialized Fields

active

UserActiveState active
Whether the user account is OK (active), canceled, or banned

ageGroup

AgeBracket ageGroup
The age bracket to which this user belongs: currently kid (0-12), teen (13-17), or adult (18+). Computed from birth date periodically and cached.

approvedDate

Date approvedDate
The date on which the account was approved (by parent) or eMail was validated (by self). Either way, it's basically eMail validation, but just differs in who gets the mail. The date on which the account was approved (by parent) or eMail was validated (by self). Either way, it's basically eMail validation, but just differs in who gets the mail.

avatarClass

AvatarClass avatarClass
The type of avatar in play

baseColour

Colour baseColour
The base colour of the avatar

birthDate

Date birthDate
The user's date of birth. Required, COPPA.

canBetaTest

boolean canBetaTest
True if the user can sign in to a Beta server

canContact

boolean canContact
if true, the user has given his/her consent to receive marketing messages by eMail

canEnterChatZone

boolean canEnterChatZone
True if the user can enter a zone where people can chat freely. Lightning in Tootsville.

canEnterMenuZone

boolean canEnterMenuZone
True if the user can enter a zone where dialogue is chosen from menus. Hearts in Tootsville.

canTalk

boolean canTalk
True if the user is allowed to type chat.

chatBG

Colour chatBG
background colour for chat text

chatFG

Colour chatFG
foreground colour for chat text

dialect

String dialect
the dialect of the user's UserRecord.language in which s/he prefers to see messages

emailPlusDate

Date emailPlusDate
For kids, this is the date on which eMail Plus secondary eMail is sent out. This may be past or future.

extraColour

Colour extraColour
The extra colour of the avatar. For Master Toot (Amphibious) this is the nose/highlight colour

givenName

String givenName
the user's actual, given name

inv

Inventory inv
The user's inventory. Note that the inventory is not automatically instantiated at user construction; it is opportunistically loaded later.

isEphemeral

boolean isEphemeral
Whether or not changes to the class will be flushed. True: Do not flush False: Flush

kickedByUserID

int kickedByUserID
The user ID who kicked this user offline. (or -1)

kickedReasonCode

String kickedReasonCode
The reason that this user is kicked offline or banned.

kickedUntil

Timestamp kickedUntil
The date at which the user is no longer kicked offline. For banned users, this is Timestamp ( Long.MAX_LONG ), which means the universe should end first.

language

String language
the language in which the user prefers to receive messages

lastZoneName

String lastZoneName
the last zone on which the user had been logged on; or, their current zone, if we can see Smartfox from here.

login

String login
The user's current, active login name.

mail

String mail
the user's eMail address

mailConfirmed

Date mailConfirmed
the date on which the user's mail address was confirmed (or null, if it hasn't been)

mailConfirmSent

Date mailConfirmSent

the date that eMail confirmation was sent out

XXX: save in database

nameApprovedAt

Timestamp nameApprovedAt
The timestamp of Lifeguard approval of the user's name (or null, if it hasn't been approved yet)

nameApprovedByUserID

int nameApprovedByUserID
The user ID of the moderator who approved this user's name

nameRequestedAt

Timestamp nameRequestedAt
The time at which this user entered his/her request for a new name.

needsNaming

boolean needsNaming
If true, the user hasn't picked a name for this account (but it may have a system-assigned random one), so we need to nag them to pick a name.

notable

boolean notable
true, if this is a notable NPC/character

parentApprovedName

boolean parentApprovedName
Whether the user's parent has approved the name yet.

parentID

int parentID
Pointer to the parent of this user, if the user's age bracket is "kid"

passRecoveryA

String passRecoveryA
answer to the password recovery question

passRecoveryQ

String passRecoveryQ
password recovery question

password

String password
WRITEME

referer

String referer
The 1-4 character code representing the source of a referral which resulted in this user signing up. Referrer (referer) codes are assigned in the M&B web site to “brand” users for life based upon who caused them to sign up with the site.

registeredAt

Timestamp registeredAt
Time when the user originally registered

requestedName

String requestedName
The user name which the user has requested, but has not yet been approved.

serial

long serial
unique instance serial number

staffLevel

int staffLevel
The level of staff authority possessed by this user.

sysOpCapability

SecurityCapability sysOpCapability
The security capability to act like a system operator

travelRate

double travelRate
The rate of movement (in pixels per second) of this user.

userHouse

UserHouse userHouse
The set of rooms in this user's house (and yard). Special values: 0 is the first room (everyone gets it for free), and 1 is the yard (lot).

userID

int userID
The user's numeric ID, for database purposes.

Class org.starhope.appius.user.UserStat extends SimpleDataRecord<UserStat> implements Serializable

serialVersionUID: 984163546559085588L

Serialized Fields

name

String name
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.user.Wallet extends SimpleDataRecord<Wallet> implements Serializable

serialVersionUID: -6217318950360071843L

Serialized Fields

currency

Map<K,V> currency
amount of money in various forms

myOwner

UserRecord myOwner
The owner of the wallet

Package org.starhope.appius.user.events

Class org.starhope.appius.user.events.EventOutcomeRecord extends SimpleDataRecord<EventOutcomeRecord> implements Serializable

serialVersionUID: -7218044225900766801L

Serialized Fields

giveMedal

MedalType giveMedal
WRITEME: Document this brpocock@star-hope.org

id

int id
event outcome ID

maxRarity

RarityRating maxRarity
WRITEME: Document this brpocock@star-hope.org

maxReward

BigDecimal maxReward
WRITEME: Document this brpocock@star-hope.org

minRarity

RarityRating minRarity
WRITEME: Document this brpocock@star-hope.org

minReward

BigDecimal minReward
WRITEME: Document this brpocock@star-hope.org

permitDuplicateReward

boolean permitDuplicateReward
WRITEME: Document this brpocock@star-hope.org

retryDuplicateReward

boolean retryDuplicateReward
WRITEME: Document this brpocock@star-hope.org

rewardByPoints

boolean rewardByPoints
WRITEME: Document this brpocock@star-hope.org

rewardCollectionID

int rewardCollectionID
WRITEME: Document this brpocock@star-hope.org

rewardCurrency

Currency rewardCurrency
WRITEME: Document this brpocock@star-hope.org

rewardItemID

int rewardItemID
WRITEME: Document this brpocock@star-hope.org

rewardRatio

BigDecimal rewardRatio
WRITEME: Document this brpocock@star-hope.org

rewardRandom

boolean rewardRandom
WRITEME: Document this brpocock@star-hope.org

rewardMin

BigDecimal rewardMin
WRITEME: Document this brpocock@star-hope.org

rewardMax

BigDecimal rewardMax
WRITEME: Document this brpocock@star-hope.org

rewardItemType

RewardItemType rewardItemType
the type of method of selection of an item reward

Class org.starhope.appius.user.events.EventRecord extends SimpleDataRecord<EventRecord> implements Serializable

serialVersionUID: 7812621767536153282L

Serialized Fields

completionTimestamp

long completionTimestamp
WRITEME: Document this brpocock@star-hope.org

creationTimestamp

long creationTimestamp
WRITEME: Document this brpocock@star-hope.org

creatorID

int creatorID
WRITEME: Document this brpocock@star-hope.org

currencyAmountEarned

BigDecimal currencyAmountEarned
WRITEME: Document this brpocock@star-hope.org

currencyEarned

Currency currencyEarned
WRITEME: Document this brpocock@star-hope.org

earnedItemID

int earnedItemID
WRITEME

eventTypeID

int eventTypeID
WRITEME: Document this brpocock@star-hope.org

id

int id
WRITEME: Document this brpocock@star-hope.org

medals

Collection<E> medals
WRITEME

points

BigInteger points
WRITEME: Document this brpocock@star-hope.org

sendHighScore

boolean sendHighScore
Deprecated. unused, refer to EventType.hasHighScores()
Whether to send high scores when printing this event

Class org.starhope.appius.user.events.EventType extends SimpleDataRecord<EventType> implements Serializable

serialVersionUID: 3264040852839164213L

Serialized Fields

description

String description
the user-visible description of the event type

engine

String engine
the script engine for client-side processing of the event or minigame

filename

String filename
the filename for client-side processing of a minigame

frequencyLimit

long frequencyLimit
how frequently the event type can be conducted

frequencyPeriod

long frequencyPeriod
hot long before the EventType.frequencyLimit is reset

highScores

boolean highScores
Whether or not this event generates high scores

id

int id
the database ID of the event type

moniker

String moniker
the moniker of the event type

numberOfPlayers

int numberOfPlayers
the number of players for a minigame

outcome

EventOutcomeRecord outcome
outcomes of events

Class org.starhope.appius.user.events.MedalRecord extends SimpleDataRecord<MedalRecord> implements Serializable

serialVersionUID: 4705760172238133531L

Serialized Fields

id

int id
WRITEME: Document this brpocock@star-hope.org

name

String name
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.user.events.MedalType extends SQLPeerEnum implements Serializable

serialVersionUID: 1163836714942876254L

Package org.starhope.appius.user.notifications

Class org.starhope.appius.user.notifications.Notification extends SimpleDataRecord<Notification> implements Serializable

serialVersionUID: 7431972694779670411L

Serialized Fields

id

int id
The ID of the notification

messageLabel

String messageLabel
The message catalog label for the notification message

messageParams

Map<K,V> messageParams
set of parameters to be substituted into the message obtained from LibMisc#getText messageLabel for %s parameters

readTime

long readTime
Time at which the notification was read/dispatched

recipient

AbstractUser recipient
The user to whom this notification was directed

sender

AbstractUser sender
The ID of the User that initiated this notification

sentTime

long sentTime
time at which the notification was sent

verbs

NotificationReplyVerbSet verbs
verbs that can be used to respond to this notification

Class org.starhope.appius.user.notifications.NotificationReplyVerb extends Object implements Serializable

serialVersionUID: 3396983348273834331L

Serialized Fields

labelKey

String labelKey
WRITEME: Document this brpocock@star-hope.org

payload

String payload
WRITEME: Document this brpocock@star-hope.org

verb

String verb
WRITEME: Document this brpocock@star-hope.org

Class org.starhope.appius.user.notifications.NotificationReplyVerbSet extends Object implements Serializable

serialVersionUID: -8785675032265591315L

Serialized Fields

n

Collection<E> n
Internal storage implementation

Class org.starhope.appius.user.notifications.NotificationSet extends SimpleDataRecordSet<Notification,NotificationSet> implements Serializable

serialVersionUID: 6189835520198516038L

Serialized Fields

myUserID

int myUserID
The user whose set of notifications this represents.

Package org.starhope.appius.util

Class org.starhope.appius.util.SimpleDataRecord extends Object implements Serializable

serialVersionUID: 3167537168141802669L

Serialized Fields

beenCached

boolean beenCached
Whether this object has been cached

beingLoaded

boolean beingLoaded
WRITEME: Document this brpocock@star-hope.org

timeLastChanged

long timeLastChanged
WRITEME

timeLastSaved

long timeLastSaved
WRITEME

Class org.starhope.appius.util.SimpleDataRecordSet extends SimpleDataRecord<SimpleDataRecordSet<DataRecordClass extends DataRecord,DataRecordSetClass extends SimpleDataRecordSet<DataRecordClass,DataRecordSetClass>>> implements Serializable

serialVersionUID: -6121300446693891188L

Serialized Fields

map

Map<K,V> map
The internal implementation of the set is a concurrent hash-map.

Package org.starhope.appius.via

Class org.starhope.appius.via.DoNotCrossTheRubicon extends Exception implements Serializable

serialVersionUID: 2065454244102939988L

Class org.starhope.appius.via.ViaCommunicationsException extends Exception implements Serializable

serialVersionUID: -3351392271775746317L

Package org.starhope.rahab.ui

Class org.starhope.rahab.ui.LoginUI extends JPanel implements Serializable

serialVersionUID: -4540386371686781482L

Serialized Fields

keyAction

KeyListener keyAction

logger

Logger logger

loginCallBack

LoginCallBack loginCallBack

passwordField

JPasswordField passwordField

serverField

JComboBox serverField

userNameField

JTextField userNameField

Class org.starhope.rahab.ui.RahabToolBar extends JToolBar implements Serializable

serialVersionUID: -7630497495393407243L

Class org.starhope.rahab.ui.ShiftJournalPane extends JPanel implements Serializable

serialVersionUID: 5012737603870817064L

Serialized Fields

shiftJournalEntryField

JTextArea shiftJournalEntryField

submitButton

JButton submitButton

Class org.starhope.rahab.ui.SpyHTMLWindow extends JPanel implements Serializable

serialVersionUID: 7041757436427487461L

Serialized Fields

output

JEditorPane output

Class org.starhope.rahab.ui.SpyMenuBar extends JMenuBar implements Serializable

serialVersionUID: 4213646383231430330L

Class org.starhope.rahab.ui.SpyUI extends JPanel implements Serializable

serialVersionUID: -6126668445890875030L

Serialized Fields

currentZone

String currentZone

dateFormatter

DateFormat dateFormatter
WRITEME: Document this field. twheys@gmail.com Jan 5, 2010

gameMailStyledDocument

StyledDocument gameMailStyledDocument

gameMailTextPane

JTextPane gameMailTextPane

history

Vector<E> history

historyTracker

int historyTracker

houseListRoot

DefaultMutableTreeNode houseListRoot

inputTextArea

JTextField inputTextArea

logger

Logger logger

messageCallBack

MessageCallBack messageCallBack

modListRoot

DefaultMutableTreeNode modListRoot

rightClickContext

RightClickContextMenu rightClickContext

roomList

JTree roomList

roomListRoot

DefaultMutableTreeNode roomListRoot

root

DefaultMutableTreeNode root

USER_LIST_MOUSE_LISTENER

MouseListener USER_LIST_MOUSE_LISTENER
WRITEME: Document this field. twheys@gmail.com Dec 31, 2009

userList

JList userList

userListVector

Vector<E> userListVector

zoneChatStyledDocument

StyledDocument zoneChatStyledDocument

zoneChatTextPane

JTextPane zoneChatTextPane

Class org.starhope.rahab.ui.ZonePromptUI extends JPanel implements Serializable

serialVersionUID: -2175431665170377593L

Serialized Fields

callBack

ZoneCallBack callBack
WRITEME

listNames

Vector<E> listNames
WRITEME

logger

Logger logger
WRITEME

zoneList

JList zoneList
WRITEME

Package org.starhope.rahab.ui.contextmenu

Class org.starhope.rahab.ui.contextmenu.BanUserAction extends RulesAction implements Serializable

serialVersionUID: 8729943067605304703L

Class org.starhope.rahab.ui.contextmenu.CopyNameAction extends AbstractAction implements Serializable

serialVersionUID: -1131387179594633180L

Serialized Fields

userOfInterest

String userOfInterest

Class org.starhope.rahab.ui.contextmenu.FingerAction extends AbstractAction implements Serializable

serialVersionUID: -1131387179594633180L

Serialized Fields

actionCallBack

MessageCallBack actionCallBack

userOfInterest

String userOfInterest

Class org.starhope.rahab.ui.contextmenu.GiveNutsAction extends AbstractAction implements Serializable

serialVersionUID: -1131387179594633180L

Serialized Fields

actionCallBack

MessageCallBack actionCallBack

userOfInterest

String userOfInterest

Class org.starhope.rahab.ui.contextmenu.GrantAction extends AbstractAction implements Serializable

serialVersionUID: -1131387179594633180L

Serialized Fields

actionCallBack

MessageCallBack actionCallBack

userOfInterest

String userOfInterest

Class org.starhope.rahab.ui.contextmenu.KickUserAction extends RulesAction implements Serializable

serialVersionUID: 8729943067605304703L

Class org.starhope.rahab.ui.contextmenu.ModMessageAction extends AbstractAction implements Serializable

serialVersionUID: -1131387179594633180L

Serialized Fields

actionCallBack

MessageCallBack actionCallBack

userOfInterest

String userOfInterest

Class org.starhope.rahab.ui.contextmenu.RulesAction extends AbstractAction implements Serializable

serialVersionUID: 8729943067605304703L

Serialized Fields

actionCallBack

MessageCallBack actionCallBack

userOfInterest

String userOfInterest

Class org.starhope.rahab.ui.contextmenu.ScottyUserAction extends AbstractAction implements Serializable

serialVersionUID: 8729943067605304703L

Class org.starhope.rahab.ui.contextmenu.WarnUserAction extends RulesAction implements Serializable

serialVersionUID: 8729943067605304703L

Package org.starhope.vergil.logic

Class org.starhope.vergil.logic.EventNotHandledException extends Exception implements Serializable

serialVersionUID: -8642131375785162122L

Class org.starhope.vergil.logic.EventNotPlannedException extends Exception implements Serializable

serialVersionUID: -347074297312131609L

Package org.starhope.vergil.net

Class org.starhope.vergil.net.ServerDisconnectedException extends UserDeadException implements Serializable

serialVersionUID: 8832010432870221759L

Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
 PREV   NEXT FRAMES    NO FRAMES