org.elkoserver.server.context.test

Class Die

java.lang.Object

org.elkoserver.server.context.Mod

org.elkoserver.server.context.test.Die

All Implemented Interfaces:

Cloneable, DispatchTarget, Encodable, ItemMod

public class Die
extends Mod
implements ItemMod

Mod to enable an item to function as a die.

Constructor Summary

Constructors

Constructor and Description
Die(int sides) JSON-driven constructor.

Method Summary

Methods

Modifier and Type	Method and Description
JSONLiteral	encode(EncodeControl control) Encode this mod for transmission or persistence.
void	roll(User from) Message handler for the 'roll' message.

Methods inherited from class org.elkoserver.server.context.Mod

attachTo, clone, context, ensureHolding, ensureInContext, ensureReachable, ensureSameContext, ensureSameUser, holder, isEphemeral, markAsChanged, markAsEphemeral, object

Methods inherited from class java.lang.Object

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

Constructor Detail

Die

@JSONMethod(value="sides")
public Die(int sides)

JSON-driven constructor.

Method Detail

encode

public JSONLiteral encode(EncodeControl control)

Encode this mod for transmission or persistence.

Specified by:

encode in interface Encodable

Parameters:

control - Encode control determining what flavor of encoding should be done.

Returns:

a JSON literal representing this mod.

roll

@JSONMethod
public void roll(User from)
          throws MessageHandlerException

Message handler for the 'roll' message. This message requests a die roll. recv: { to:REF, op:"roll" } send: { to:REF, op:"roll", from:REF, value:int }

Parameters:

from - The user requesting the census.

Throws:

MessageHandlerException - if 'from' is not in the same context as this mod, or if this mod is attached to a user and 'from' is not that user.