github/mage
1
0
Fork 0
mirror of https://github.com/correl/mage.git synced 2025-01-11 19:13:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added some comments.

Browse source
This commit is contained in:
LevelX2 2015-02-19 08:53:12 +01:00
parent 8d0f45052a
commit 422b92e4ad
2 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Mage/src/mage/abilities/effects/ContinuousRuleModifiyingEffect.java
View file

@ -40,7 +40,7 @@ public interface ContinuousRuleModifiyingEffect extends ContinuousEffect {
/**
* This check for the relevant events is called at first to prevent further actions if
* the current event is ignored from this effect
* the current event is ignored from this effect. Speeds up event handling.
* @param event
* @param game
* @return

20
Mage/src/mage/abilities/effects/ContinuousRuleModifiyingEffectImpl.java
View file

@ -62,7 +62,17 @@ public abstract class ContinuousRuleModifiyingEffectImpl extends ContinuousEffec
public ContinuousRuleModifiyingEffectImpl(Duration duration, Outcome outcome) {
this(duration, outcome, true, false);
}
/**
*
* @param duration
* @param outcome
* @param messageToUser - Every time the effect replaces an event, the user gets a message in a dialog window.
* Don't set it to true if the event heppens regularly or very often. The message can be
* changed by overriding the getInfoMessage method.
* @param messageToLog - Every time the effect replaces an event, a message is posted to the game log. The message
* can be changed by overriding the getInfoMessage method.
*/
public ContinuousRuleModifiyingEffectImpl(Duration duration, Outcome outcome, boolean messageToUser, boolean messageToLog) {
super(duration, outcome);
this.effectType = EffectType.CONTINUOUS_RULE_MODIFICATION;
@ -78,6 +88,14 @@ public abstract class ContinuousRuleModifiyingEffectImpl extends ContinuousEffec
this.messageToGameLog = effect.messageToGameLog;
}
/**
* An early check for the event types this effect applies to. This check was added
* to speed up event handling. Once all existing ContinuousRuleModifiyingEffects have
* implemented this method, the method should be changed to abstract here or removed.
* @param event
* @param game
* @return
*/
@Override
public boolean checksEventType(GameEvent event, Game game) {
return true;