Inheritance diagram for jade.core.Actor:

Public Member Functions
	Actor (ColoredChar face)

abstract void	act ()

ColoredChar	face ()

World	world ()

final boolean	bound ()

final boolean	bound (World world)

void	setPos (int x, int y)

final void	setPos (Coordinate coord)

final void	move (int dx, int dy)

final void	move (Coordinate delta)

final void	move (Direction dir)

int	x ()

int	y ()

final Coordinate	pos ()

boolean	expired ()

void	expire ()

void	attach (Actor holder)

void	detach ()

Actor	holder ()

final boolean	held ()

final boolean	held (Actor holder)

final Collection< Actor >	holds ()

void	setWorld (World world)

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

Detailed Description

Represents anything on a Jade

World

that can perform an action (or be acted upon). This obviously includes things like the player, NPCs, and monsters. Not as obviously, an

Actor

can represent things like items, spells, doors and traps, or even abstract actions like timers and events. An

Actor

can be attached to one another in order to create other interesting effects. For example, an enchantment spell might be an effect

Actor

attached to an item

Actor

. A timer

Actor

could be attached to the spell which simple counts an appropriate amount of turns, then expires the spell

Actor

.

Constructor & Destructor Documentation

jade.core.Actor.Actor ( ColoredChar face )

Constructs a new

Actor

with the given face.

Parameters

face	the face of the Actor

Member Function Documentation

abstract void jade.core.Actor.act ( )

pure virtual

Performs the actions of this

Actor

. Normally this would be called by the

World

in the

tick()

method, which allows the

Actor

actions to be scheduled properly based on act order and

Actor

speed.

Implemented in rogue.creature.Player, rogue.creature.Rat, rogue.creature.Unbeliever, rogue.creature.Zombie, rogue.creature.Dragon, rogue.creature.Frog_poisonous, rogue.creature.Orc, rogue.creature.Shadow, rogue.creature.Slug_fat, jade.gen.map.ItemGenerator, rogue.creature.Troll, rogue.creature.InvisibleZombie, and rogue.creature.Dummy.

void jade.core.Actor.attach ( Actor holder )

Attaches this

Actor

to another. Note that the

Actor

must not be currently held or bound to a

World

when calling this method. The position of this

Actor

will follow the holder, and the

Actor

will be bound to the holder's

World

. However, the

Actor

will not be placed on the

World

grid and will therefore not be accessible through

world.getActorAt()

or

world.getActorsAt()

.

Parameters

holder

the new holder of the

Actor

final boolean jade.core.Actor.bound ( )

Returns true if the

Actor

bound to a

World

. This is equivalent to calling

actor.world() != null

.

Returns: true if the
Actor

bound to a
World

final boolean jade.core.Actor.bound ( World world )

Returns true if the

Actor

is bound to the given

World

. This is equivalent to calling

actor.world() == world

.

Parameters

world

the

World

being tested

Returns: true if the
Actor

is bound to world

void jade.core.Actor.detach ( )

Detaches this

Actor

from its current holder. Note that the

Actor

must currently be held when calling this method. If the

Actor

is bound, it will be placed on the

World

at the current position of the holder.

void jade.core.Actor.expire ( )

Expires the

Actor

, or in other words, marks it for removal.

boolean jade.core.Actor.expired ( )

Returns true if the

Actor

is expired, or in other words, marked for removal.

Returns: true if the
Actor

is expired

ColoredChar jade.core.Actor.face ( )

Returns the face of the

Actor

.

Returns: the face of the
Actor

final boolean jade.core.Actor.held ( )

Returns true if the

Actor

is currently held. This is equivalent to

actor.holder() != null

.

Returns: true if the
Actor

is currently held

final boolean jade.core.Actor.held ( Actor holder )

Returns true if the

Actor

is held by the specified

Actor

. This is equivalent to

actor.holder() == holder

.

Parameters

holder the holder being tested

Returns: true if the
Actor

is held by the specified holder

Actor jade.core.Actor.holder ( )

Returns the current holder of the

Actor

, or null if it is not held.

Returns: the current holder of the
Actor

final Collection<Actor> jade.core.Actor.holds ( )

Returns all the

Actor

currently being held by this one.

Returns: all the
Actor

currently being held by this one

final void jade.core.Actor.move	(	int	dx,
		int	dy
	)

Moves the

Actor

by the specified amounts

Parameters

dx	the change x
dy	the change y

final void jade.core.Actor.move ( Coordinate delta )

Moves the

Actor

by the specified amount

Parameters

delta the change in x and y

final void jade.core.Actor.move ( Direction dir )

Moves the

Actor

one tile in the specified direction

Parameters

dir	the change in x and y

final Coordinate jade.core.Actor.pos ( )

Returns a copy of the current position of the

Actor

.

Returns: a copy of the current position of the
Actor

.

void jade.core.Actor.setPos	(	int	x,
		int	y
	)

Sets the position of the

Actor

on its current

World

. The

Actor

must be bound and not held when this method is called.

Parameters

x	the new x position of the Actor
y	the new y position of the Actor

final void jade.core.Actor.setPos ( Coordinate coord )

Sets the position of the

Actor

on its current

World

. The

Actor

must be bound and not held when this method is called.

Parameters

coord

the new position of the

Actor

World jade.core.Actor.world ( )

Returns the

World

the

Actor

is currently bound to, or null if the

Actor

is unbound.

Returns: the
World

the
Actor

is currently bound to

int jade.core.Actor.x ( )

Returns the x location of the

Actor

.

Returns: the x location of the
Actor

int jade.core.Actor.y ( )

Returns the y location of the

Actor

.

Returns: the y location of the
Actor

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

jade/core/Actor.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation