Serialized Form

Package org.starhope.appius.except

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

serialVersionUID: -751452585358243489L

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

serialVersionUID: 6056918068724660283L

Serialized Fields

newID

long newID

TODO: document this field (brpocock, Nov 5, 2009) newID (AlreadyLoadedException)

oldID

long oldID

TODO: document this field (brpocock, Nov 5, 2009) oldID (AlreadyLoadedException)

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

serialVersionUID: 1L

Serialized Fields

reason

String reason

TODO: document this field (brpocock, Nov 5, 2009) reason (AlreadyUsedException)

when

Date when

TODO: document this field (brpocock, Nov 5, 2009) when (AlreadyUsedException)

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

serialVersionUID: 3437973344124958820L

Serialized Fields

complaint

String complaint

TODO: document this field (brpocock, Nov 5, 2009) complaint (DataException)

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

serialVersionUID: 4022968581619547737L

Serialized Fields

message

String message

TODO: document this field (brpocock, Nov 5, 2009) message (ForbiddenUserException)

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

serialVersionUID: 1847882813339365932L

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

serialVersionUID: -6462517287925538686L

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

serialVersionUID: 1L

Serialized Fields

msg

String msg

TODO: document this field (brpocock, Nov 5, 2009) msg (NotFoundException)

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

serialVersionUID: 5807522909889820110L

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

serialVersionUID: -2189758661731450124L

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.GameEvent extends SQLPeerDatum implements Serializable

serialVersionUID: -6751701646654524655L

Serialized Fields

endingSolo

boolean endingSolo

Shitty recursion guard endingSolo (GameEvent)

freezeTag

boolean freezeTag

freeze game actions

gameCode

char gameCode

the one-char identifier for this game

gameState

GameStateFlag gameState

the current game state (mode)

playerEvents

ConcurrentHashMap<K,V> playerEvents

the events in the global events table for each player, used for recording scores

players

ConcurrentSkipListSet<E> players

the players (in any room)

rooms

ConcurrentSkipListSet<E> rooms

The rooms which this GameEvent controls

scores

ConcurrentHashMap<K,V> scores

the current scores for all players

scoreWatchRooms

ConcurrentSkipListSet<E> scoreWatchRooms

The rooms which this GameEvent will report the score to (in addition to GameEvent.rooms) scoreWatchRooms (GameEvent)

timer

long timer

The game (countdown/play time) timer

zone

Zone zone

The zone zone (GameEvent)

Class org.starhope.appius.game.LaserTagGame extends GameEvent implements Serializable

serialVersionUID: 9135761790789751729L

Class org.starhope.appius.game.Room extends SQLPeerDatum implements Serializable

serialVersionUID: 777843822192305721L

Serialized Fields

filename

String filename

The base name of the room's SWF file. This is going to be in a given resource folder for rooms.

gameEvent

GameEvent gameEvent

The Game Event in this room, or (usually) null

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 this.

moniker

String moniker

The moniker / unique identifier for this room.

movieTime

int movieTime

in seconds

movieURL

String movieURL

TODO: document this field (brpocock, Nov 13, 2009) movieURL (Room)

music

String music

The background music for the room

myID

int myID

TODO: document this field (brpocock, Nov 13, 2009) myID (Room)

nowPlaying

String nowPlaying

TODO: document this field (brpocock, Nov 13, 2009) nowPlaying (Room)

observers

ConcurrentSkipListSet<E> observers

Non-Users who are present to pay attention to things happening in the room

overlay

String overlay

The SWF file to be displayed as a weather overlay.

roomIndex

int roomIndex

WRITEME: document this field (brpocock, Jan 14, 2010) roomIndex (Room)

roomVariables

ConcurrentHashMap<K,V> roomVariables

WRITEME

sky

String sky

The SWF file to be displayed as a sky background.

skyVisible

boolean skyVisible

Whether the sky is visible in this room.

title

String title

WRITEME

userList

ConcurrentSkipListSet<E> userList

The list of user ID's of all users in this room. Using user ID's instead of user objects saves from having fallow references.

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

serialVersionUID: -2338918747157284836L

Serialized Fields

myName

String myName

The name of this zone

myServer

String myServer

The hostname of the server on which this Zone is running

myServerPort

int myServerPort

The port number of the server on which this Zone is running

nextDynamicRoomNumber

int nextDynamicRoomNumber

The room numbers for dynamic rooms begin here

roomsByID

ConcurrentHashMap<K,V> roomsByID

All rooms in the Zone: sorted by ID.

See Also:

Zone.roomsByMoniker

roomsByMoniker

ConcurrentHashMap<K,V> roomsByMoniker

All rooms in the Zone: sorted by moniker.

See Also:

Zone.roomsByID

serverReady

boolean serverReady

A flag set once the server has indicated that it's ready to go, to avoid issues with events firing off too soon (e.g. NPC's)

usersInZone

ConcurrentSkipListSet<E> usersInZone

the set of user ID's of all users in the Zone. We don't keep User objects here because we were once having instantiation failures; it would probably be more efficient to do so, but XXX

Package org.starhope.appius.game.npc

Class org.starhope.appius.game.npc.AppiusNPCManager extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

lastTimestamp

long lastTimestamp

TODO: document this field (brpocock, Nov 17, 2009) lastTimestamp (AppiusNPCManager)

Class org.starhope.appius.game.npc.NPCInterface extends Object implements Serializable

Package org.starhope.appius.mb

Class org.starhope.appius.mb.Currency extends SQLPeerEnum 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

Class org.starhope.appius.mb.Enrolment extends SQLPeerDatum 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

long renewDays

WRITEME

renewMonths

int renewMonths

WRITEME

title

String title

WRITEME

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

Person user

WRITEME

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

serialVersionUID: 8046742159122084295L

Serialized Fields

address

String address

WRITEME

address2

String address2

WRITEME

addressType

String addressType

WRITEME

city

String city

WRITEME

country

String country

WRITEME

database_id

int database_id

WRITEME

externallyValidated

boolean externallyValidated

WRITEME

latitude

BigDecimal latitude

WRITEME

locality

String locality

WRITEME

longitude

BigDecimal longitude

WRITEME

mail

String mail

WRITEME

phone

String phone

WRITEME

postalCode

String postalCode

WRITEME

province

String province

WRITEME

title

String title

WRITEME

user

Person user

WRITEME

validatedByDomain

String validatedByDomain

WRITEME

validatedOn

Date validatedOn

WRITEME

zipPlus4

String zipPlus4

WRITEME

Class org.starhope.appius.mb.UserEnrolment extends SQLPeerDatum 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.pay.util

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

serialVersionUID: 6281463386314458042L

Serialized Fields

message

String message

TODO: document this field (brpocock, Nov 20, 2009) message (RetryPaymentException)

p

Payment p

TODO: document this field (brpocock, Nov 20, 2009) p (RetryPaymentException)

retry

Date retry

TODO: document this field (brpocock, Nov 20, 2009) retry (RetryPaymentException)

title

String title

TODO: document this field (brpocock, Nov 20, 2009) title (RetryPaymentException)

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

serialVersionUID: -6011680212811283881L

Serialized Fields

credentialType

CredentialType credentialType

TODO: document this field (brpocock, Nov 20, 2009) credentialType (UnsupportedCredentialException)

gateway

Class<T> gateway

TODO: document this field (brpocock, Nov 20, 2009) gateway (UnsupportedCredentialException)

message

String message

TODO: document this field (brpocock, Nov 20, 2009) message (UnsupportedCredentialException)

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

serialVersionUID: -7609777648104051706L

Serialized Fields

message

String message

TODO: document this field (brpocock, Nov 20, 2009) message (UnsupportedCurrencyException)

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

instance ID

Package org.starhope.appius.sys.op

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

serialVersionUID: -3010893618678442775L

Serialized Fields

id

int id

TODO: document this field (brpocock, 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, Dec 11, 2009) blue (Colour)

green

short green

WRITEME: document this field (brpocock, Dec 11, 2009) green (Colour)

red

short red

WRITEME: document this field (brpocock, Dec 11, 2009) red (Colour)

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

serialVersionUID: -2261276745008584124L

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

serialVersionUID: 8514877584411321981L

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

serialVersionUID: -7582592792547852890L

Package org.starhope.appius.user

Class org.starhope.appius.user.AvatarClass extends SQLPeerEnum implements Serializable

serialVersionUID: -5006183249551211836L

Class org.starhope.appius.user.Parent extends Person implements Serializable

serialVersionUID: -793284706598303053L

Serialized Fields

parentID

int parentID

Database ID value

Class org.starhope.appius.user.Person extends SQLPeerDatum implements Serializable

serialVersionUID: 5635026067346684335L

Serialized Fields

canContact

boolean canContact

If true, we can contact this user. Note that we usually mail parents of kids, not the kids themselves.

dialect

String dialect

The national dialect of the language Person.language which the user speaks.

forgotPasswordAnswer

String forgotPasswordAnswer

Given answer to forgotten password question.

forgotPasswordQuestion

String forgotPasswordQuestion

The user's question to answer if they forget their password.

givenName

String givenName

The user's given name. Optional. Just for use in membership screens to identify the user (especially to his/her parent)

language

String language

The user's preferred human language for communications. Currently must be "en" (English). Use ISO codes.

mail

String mail

The user's eMail address. Optional for kids (need their parent's, though); mandatory for teens or adults.

mailConfirmed

Date mailConfirmed

The timestamp of the confirmation of the user's (or parent's) eMail.

mailConfirmSent

Date mailConfirmSent

TODO: document this field (brpocock, Nov 5, 2009) mailConfirmSent (Person)

password

String password

The user (or parent)'s unencrypted (plain text) password. Alice and Bill would be so, so sad.

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

serialVersionUID: 4146069318927248889L

Serialized Fields

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

baseColor

Colour baseColor

The base colour of the avatar

birthDate

Date birthDate

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

buddyList

UserList buddyList

The list of buddies for this user. Instantiated on the fly by the getter methods, if needed, to save on overhead.

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

emailPlusDate

Date emailPlusDate

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

extraColor

Colour extraColor

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

facing

String facing

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

haveInventory

boolean haveInventory

Has the user's inventory been loaded?

ignoreList

UserList ignoreList

The list of users whom this user is ignoring.

inventory

HashSet<E> inventory

All types of inventory in a single set.

isActive

boolean isActive

If true, the account is active (not canceled nor banned)

isBanned

boolean isBanned

If true, the account is banned (not active nor canceled)

isCanceled

boolean isCanceled

If true, the account is canceled (not active nor banned)

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.

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.

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.

nameApprovedAt

Timestamp nameApprovedAt

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

nameApprovedByUserID

long 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.

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"

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.

rooms

HashSet<E> rooms

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).

staffLevel

int staffLevel

The level of staff authority possessed by this user.

targetX

double targetX

The destination ordinate toward which the user is currently moving. (May be identical to User.x)

targetY

double targetY

The destination mantissa toward which the user is currently moving. (May be identical to User.y)

travelRate

double travelRate

The rate of movement (in pixels per millisecond) of this user.

travelStartTime

long travelStartTime

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

userID

int userID

The user's numeric ID, for database purposes.

userVariables

ConcurrentHashMap<K,V> userVariables

Arbitrary user variables which can be set or retrieved by the front-end

x

double x

The user's origination ordinate

y

double y

The user's origination abcessa

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