us.asciiroth.client.core
Interface Effect

All Superinterfaces:
Piece
All Known Implementing Classes:
AbstractEffect, EnergyCloud, Fade, Fire, Hit, InFlightItem, Open, PoisonCloud, ResistancesCloud, Smash

public interface Effect
extends Piece

A kind of piece that exists on the board above items and terrain, used to handle animation like the throwing of items. It has two important consequences for animated pieces. First the animation timeline (frame count) of an effect always starts at zero, and not at a randomly seeded starting frame. Second, effects are not saved on the board. Instead, the game will wait to save until all non-transient effects have played out on the board. This is important with thrown items, for example, since their flight must end to accurately decide what will happen to them on the board. Other effects, like bullets, are not saved with the board.


Method Summary
 boolean isAboveAgent()
          Should this effect be displayed above or below an agent if an agent appears on the same cell?
 
Methods inherited from interface us.asciiroth.client.core.Piece
getColor, getName, getSymbol, is, not
 

Method Detail

isAboveAgent

boolean isAboveAgent()
Should this effect be displayed above or below an agent if an agent appears on the same cell?

Returns:
true if this effect should appear above the agent

0.7

2009 Alx Dark