net.sf.freecol.server.control

Class ChangeSet.AttackChange

java.lang.Object

net.sf.freecol.server.control.ChangeSet.Change

net.sf.freecol.server.control.ChangeSet.AttackChange

Enclosing class:

ChangeSet

private static class ChangeSet.AttackChange
extends ChangeSet.Change

Encapsulate an attack.

Field Summary

Fields

Modifier and Type	Field and Description
private Unit	attacker
private Unit	defender
private boolean	defenderInSettlement
private boolean	success

Fields inherited from class net.sf.freecol.server.control.ChangeSet.Change

see

Constructor Summary

Constructors

Constructor and Description
AttackChange(ChangeSet.See see, Unit attacker, Unit defender, boolean success) Build a new AttackChange.

Method Summary

Modifier and Type	Method and Description
void	attachToElement(org.w3c.dom.Element element) Some changes can not be directly specialized, but need to be directly attached to an element.
int	getPriority() Gets the sort priority.
boolean	isPerhapsNotifiable(ServerPlayer serverPlayer) Should a player perhaps be notified of this attack? Do not use canSeeUnit because that gives a false negative for units in settlements, which should be animated.
org.w3c.dom.Element	toElement(ServerPlayer serverPlayer, org.w3c.dom.Document doc) Specialize a AttackChange into an "animateAttack" element for a particular player.
java.lang.String	toString()

Methods inherited from class net.sf.freecol.server.control.ChangeSet.Change

consequences, convertsToElement, isNotifiable, matches

Methods inherited from class java.lang.Object

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

Field Detail

attacker

private final Unit attacker

defender

private final Unit defender

success

private final boolean success

defenderInSettlement

private final boolean defenderInSettlement

Constructor Detail

AttackChange

public AttackChange(ChangeSet.See see,
                    Unit attacker,
                    Unit defender,
                    boolean success)

Build a new AttackChange. Note that we must copy attackers and defenders because a successful attacker can move, any an unsuccessful participant can die, and unsuccessful defenders can be captured. Furthermore for defenders, insufficient information is serialized when a unit is inside a settlement, but if unscoped too much is disclosed. So we make a copy and neuter it. We have to remember if the defender was in a settlement because by the time serialization occurs the settlement might have been destroyed. We just have to accept that combat animation is an exception to the normal visibility rules.

Parameters:

see - The visibility of this change.

attacker - The Unit that is attacking.

defender - The Unit that is defending.

success - Did the attack succeed.

Method Detail

getPriority

public int getPriority()

Gets the sort priority.

Specified by:

getPriority in class ChangeSet.Change

Returns:

"CHANGE_ANIMATION".

isPerhapsNotifiable

public boolean isPerhapsNotifiable(ServerPlayer serverPlayer)

Should a player perhaps be notified of this attack? Do not use canSeeUnit because that gives a false negative for units in settlements, which should be animated.

Overrides:

isPerhapsNotifiable in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to notify.

Returns:

True if the player should be notified.

toElement

public org.w3c.dom.Element toElement(ServerPlayer serverPlayer,
                                     org.w3c.dom.Document doc)

Specialize a AttackChange into an "animateAttack" element for a particular player.

Specified by:

toElement in class ChangeSet.Change

Parameters:

serverPlayer - The ServerPlayer to update.

doc - The owner Document.

Returns:

An "animateAttack" element.

attachToElement

public void attachToElement(org.w3c.dom.Element element)

Some changes can not be directly specialized, but need to be directly attached to an element.

Specified by:

attachToElement in class ChangeSet.Change

Parameters:

element - The Element to attach to.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object