jurpe.world
Class Location

java.lang.Object
  extended by jurpe.world.Location
All Implemented Interfaces:
java.io.Serializable

public class Location
extends java.lang.Object
implements java.io.Serializable

Describes a location.

See Also:
Serialized Form

Constructor Summary
Location(LocationType loc)
          Constructor
 
Method Summary
 java.awt.Color getColor()
          Get default color of location
 java.lang.String getDescription()
          Get message to display when Avatar is on this location
 java.lang.String getEnterMessage()
          Get message to display when Avatar enter this location
 LocationType getType()
          Get type of location.
 void initLocation()
          Init any location
 boolean isSpecial()
          True if location is special.
 void setColor(java.awt.Color col)
          Set color of this location
 void setMessage(java.lang.String message)
          Set the message of this location
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Location

public Location(LocationType loc)
Constructor

Parameters:
loc - LocationType A kind of location (ie: Inn, Shop, House...)
Method Detail

initLocation

public void initLocation()
Init any location


isSpecial

public boolean isSpecial()
True if location is special. A special location is a location where some event can be fired. Ie: an inn is a special location because you can enter an inn and display the inn panel.

Returns:
boolean

getColor

public java.awt.Color getColor()
Get default color of location

Returns:
Color

setColor

public void setColor(java.awt.Color col)
Set color of this location

Parameters:
col - Color

getType

public LocationType getType()
Get type of location.

Returns:
LocationType Type of location
See Also:
LocationType

setMessage

public void setMessage(java.lang.String message)
Set the message of this location

Parameters:
message - Message when user select this location

getEnterMessage

public java.lang.String getEnterMessage()
Get message to display when Avatar enter this location

Returns:
String message to display when Avatar enter this location

getDescription

public java.lang.String getDescription()
Get message to display when Avatar is on this location

Returns:
String

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
String

Jurpe - Java Universal Role Playing Engine - http://jurpe.sourceforge.net