jade.core.World Class Reference

Inheritance diagram for jade.core.World:

Public Member Functions
	World (int width, int height)
void	playertick ()
void	tick ()
int	width ()
int	height ()
List< Class<?extends Actor > >	getDrawOrder ()
List< Class<?extends Actor > >	getActOrder ()
void	addActor (Actor actor, int x, int y)
final void	addActor (Actor actor, Coordinate coord)
final void	addActor (Actor actor, Dice dice)
final void	addActor (Actor actor)
void	removeActor (Actor actor)
void	removeExpired ()
final< T extends Actor > T	getActorAt (Class< T > cls, Coordinate pos)
final< T extends Actor > Collection< T >	getActorsAt (Class< T > cls, Coordinate pos)
List< ColoredChar >	lookAll (int x, int y)
final List< ColoredChar >	lookAll (Coordinate pos)
final ColoredChar	look (int x, int y)
final ColoredChar	look (Coordinate pos)
ColoredChar	tileAt (int x, int y)
void	viewable (int x, int y)
Boolean	isviewable (int x, int y)
final ColoredChar	tileAt (Coordinate coord)
boolean	passableAt (int x, int y)
final boolean	passableAt (Coordinate coord)
void	setTile (ColoredChar face, boolean passable, int x, int y)
final void	setTile (ColoredChar face, boolean passable, Coordinate coord)
Coordinate	getOpenTile (Dice dice, int x1, int y1, int x2, int y2)
final Coordinate	getOpenTile (Dice dice, Coordinate topLeft, Coordinate bottomRight)
final Coordinate	getOpenTile (Dice dice)
final Coordinate	getOpenTile (int x1, int y1, int x2, int y2)
final Coordinate	getOpenTile (Coordinate topLeft, Coordinate bottomRight)
final Coordinate	getOpenTile ()
boolean	insideBounds (int x, int y)
final boolean	insideBounds (Coordinate pos)
Public Member Functions inherited from jade.core.Messenger
	Messenger ()
void	appendMessage (String message)
Iterable< String >	retrieveMessages ()
void	aggregateMessages (Messenger messenger)
void	filterMessages (Collection< Messenger > filter)
void	clearMessages ()

Public Attributes
Coordinate	playerstart

Detailed Description

Represents a game world on which

Actor 

can interact.

Constructor & Destructor Documentation

jade.core.World.World	(	int	width,
		int	height
	)

Constructs a new

World 

with the given dimensions. Both width and height must be positive integers.

Parameters

width	the width of the new World
height	the height of the new World

Member Function Documentation

void jade.core.World.addActor	(	Actor	actor,
		int	x,
		int	y
	)

Adds an

Actor 

to the

World 

at the specified location.

Parameters

actor	the World being added
x	the x location of the Actor
y	the y location of the Actor

final void jade.core.World.addActor	(	Actor	actor,
		Coordinate	coord
	)

Adds an

Actor 

to the

World 

at the specified location.

Parameters

actor	the World being added
coord	the location of the Actor

final void jade.core.World.addActor	(	Actor	actor,
		Dice	dice
	)

Adds an

Actor 

to the

World 

at a random open tile, as generated by the specified

Dice 

with a call to

getOpenTile() 

/

Parameters

actor	the Actor to be added
dice	the random number generator used to find the open tile

final void jade.core.World.addActor

(

Actor

actor

)

Adds an

Actor 

to the

World 

at a random open tile, as generated by the global instance of

Dice 

with a call to

getOpenTile() 

/

Parameters

actor

the Actor to be added

final<T extends Actor> T jade.core.World.getActorAt	(	Class< T >	cls,
		Coordinate	pos
	)

Returns an

Actor 

of the given class at the given location, or null if there is none. If there are multiple possible

Actor 

that could be returned, an arbitrary

Actor 

is returned.

Parameters

<T>	the generic type of the class to be returned
cls	the Class<T extends Actor> of the Actor to be returned
pos	the location being queried

Returns

an

Actor 

of the given class located at (x, y)

List<Class<? extends Actor> > jade.core.World.getActOrder

(

)

Returns the act order for the

World 

. This list will affect the

tick() 

method by changing the priority with which

Actor 

s will act. Note that if one class in the draw order is a superclass of another in the list, any

Actor 

of the type of the subclass will act twice in the

tick() 

method.

Returns

the act order for the

World 

final<T extends Actor> Collection<T> jade.core.World.getActorsAt	(	Class< T >	cls,
		Coordinate	pos
	)

Returns a

Collection<T extends Actor> 

of all

Actor 

of the given class at the given location.

Parameters

<T>	the generic type of the class type to be returned
cls	the Class<T extends Actor> of the Actor to be returned
pos	the location being queried

Returns

a

Collection<T extends Actor> 

of all

Actor 

of the given class located at (x, y)

List<Class<? extends Actor> > jade.core.World.getDrawOrder

(

)

Returns the draw order for the

World 

. This list will affect the

lookAll() 

method by changing the priority with which

Actor 

s will be drawn. Note that if one class in the draw order is a superclass of another in the list, any

Actor 

of the type of the subclass will be seen twice in the

lookAll() 

method.

Returns

the draw order for the

World 

Coordinate jade.core.World.getOpenTile	(	Dice	dice,
		int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Gets a randomly chosen open tile on the

World 

within the given bounds. If after 100 randomly selected tiles are closed, then each tile will be checked and the first open tile found is returned. If the entire

World 

is closed, null is returned.

Parameters

dice	the random number generator used to randomly select tiles
x1	the bounds left most value
y1	the bounds upper most value
x2	the bounds right most value
y2	the bounds bottom most value

Returns

a randomly chosen open tile

final Coordinate jade.core.World.getOpenTile	(	Dice	dice,
		Coordinate	topLeft,
		Coordinate	bottomRight
	)

Gets a randomly chosen open tile on the

World 

within the given bounds. If after 100 randomly selected tiles are closed, then each tile will be checked and the first open tile found is returned. If the entire

World 

is closed, null is returned.

Parameters

dice	the random number generator used to randomly select tiles
topLeft	the bounds upper-left most value
bottomRight	the bounds bottom-right most value

Returns

a randomly chosen open tile

final Coordinate jade.core.World.getOpenTile

(

Dice

dice

)

Gets a randomly chosen open tile from anywhere on the

World 

. If after 100 randomly selected tiles are closed, then each tile will be checked and the first open tile found is returned. If the entire

World 

is closed, null is returned.

Parameters

dice	the random number generator used to randomly select tiles

Returns

a randomly chosen open tile

final Coordinate jade.core.World.getOpenTile	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Gets a randomly chosen open tile on the

World 

within the given bounds. The global instance of

Dice 

is used as the default parameter for randomly choosing the tiles. If after 100 randomly selected tiles are closed, then each tile will be checked and the first open tile found is returned. If the entire

World 

is closed, null is returned.

Parameters

x1	the bounds left most value
y1	the bounds upper most value
x2	the bounds right most value
y2	the bounds bottom most value

Returns

a randomly chosen open tile

final Coordinate jade.core.World.getOpenTile	(	Coordinate	topLeft,
		Coordinate	bottomRight
	)

Gets a randomly chosen open tile on the

World 

within the given bounds. The global instance of

Dice 

is used as the default parameter for randomly choosing the tiles. If after 100 randomly selected tiles are closed, then each tile will be checked and the first open tile found is returned. If the entire

World 

is closed, null is returned.

Parameters

topLeft	the bounds upper-left most value
bottomRight	the bounds bottom-right most value

Returns

a randomly chosen open tile

final Coordinate jade.core.World.getOpenTile

(

)

Gets a randomly chosen open tile from anywhere on the

World 

. The global instance of

Dice 

is used as the default parameter for randomly choosing the tiles. If after 100 randomly selected tiles are closed, then each tile will be checked and the first open tile found is returned. If the entire

World 

is closed, null is returned.

Returns

a randomly chosen open tile

int jade.core.World.height

(

)

Returns the height of the

World 

.

Returns

the height of the

World 

boolean jade.core.World.insideBounds	(	int	x,
		int	y
	)

Returns true if the given (x, y) location is inside the bounds of the

World 

.

Parameters

x	the x value of the location being queried
y	the y value of the location being queried

Returns

true if the given (x, y) location is inside the bounds of the

World 

final boolean jade.core.World.insideBounds

(

Coordinate

pos

)

Returns true if the given

Coordinate 

location is inside the bounds of the

World 

.

Parameters

pos	the location on the World being queried

Returns

true if pos is inside the bounds of the

World 

final ColoredChar jade.core.World.look	(	int	x,
		int	y
	)

Returns the face that should be drawn for the given location. This should be the same as the first face returned by lookAll.

Parameters

x	the x value of the location being queried
y	the y value of the location being queried

Returns

the face that should be drawn for the given location.

final ColoredChar jade.core.World.look

(

Coordinate

pos

)

Returns the face that should be drawn for the given location.

Parameters

pos	the location being queried

Returns

the face that should be drawn for the given location.

List<ColoredChar> jade.core.World.lookAll	(	int	x,
		int	y
	)

Returns every tile that is visible at a given location, ordered such that the tile with highest priority (the tile returned by look) is first, and the lowest priority is last. This last tile will be the face of the actual tile itself. Note that any actor which has a null face will not be included.

Parameters

x	the x value of the location being queried
y	the y value of the location being queried

Returns

every tile that is visible at a given location

final List<ColoredChar> jade.core.World.lookAll

(

Coordinate

pos

)

Returns every tile that is visible at a given location, ordered such that the tile with highest priority (the tile returned by look) is first, and the lowest priority is last. This last tile will be the face of the actual tile itself. Note that any actor which has a null face will not be included.

Parameters

pos	the location being queried

Returns

every tile that is visible at a given location

boolean jade.core.World.passableAt	(	int	x,
		int	y
	)

Returns true if the tile at the provided (x, y) coordinates is passable.

Parameters

x	the x value of the position being queried
y	the y value of the position being queried

Returns

true if the tile at (x, y)

final boolean jade.core.World.passableAt

(

Coordinate

coord

)

Returns true if the tile at the provided

Coordinate 

is passable.

Parameters

coord

the value of the position being queried

Returns

true if the tile at the given

Coordinate 

void jade.core.World.removeActor

(

Actor

actor

)

Removes an

Actor 

from the

World 

. The

Actor 

must be both bound to this

World 

and not held by another

Actor 

. However, if the

Actor 

is expired, it may always be removed.

Parameters

actor

the Actor to be removed

void jade.core.World.removeExpired

(

)

Removes all expired

Actor 

from the

World 

.

void jade.core.World.setTile	(	ColoredChar	face,
		boolean	passable,
		int	x,
		int	y
	)

Sets the face and passable value of the tile at the specified (x, y) location.

Parameters

face	the new face of the tile
passable	the new passable value of the tile
x	the x value of the position being updated
y	the y value of the position being updated

final void jade.core.World.setTile	(	ColoredChar	face,
		boolean	passable,
		Coordinate	coord
	)

Sets the face and passable value of the tile at the specified

Coordinate 

.

Parameters

face	the new face of the tile
passable	the new passable value of the tile
coord	the value of the position being updated

void jade.core.World.tick

(

)

Performs one tick. This will call

act() 

on all

Actor 

in the order specified by the act order of the

World 

. Any

Actor 

whose type does not appear in the act order does not act. Any expired

Actor 

are removed from the

World 

.

ColoredChar jade.core.World.tileAt	(	int	x,
		int	y
	)

Returns the face of the tile at the provided (x, y) coordinates.

Parameters

x	the x value of the position being queried
y	the y value of the position being queried

Returns

the face of the tile at (x, y)

final ColoredChar jade.core.World.tileAt

(

Coordinate

coord

)

Returns the face of the tile at the provided coordinates.

Parameters

coord

the value of the position being queried

Returns

the face of the tile at then given

Coordinate 

int jade.core.World.width

(

)

Returns the width of the

World 

.

Returns

the width of the

World 

---

The documentation for this class was generated from the following file:

• jade/core/World.java