fr.quatrevieux.araknemu.game.fight.fighter.AbstractFighter - Code Metrics - Inspection of "Merge pull request #259 from vincent4vx/spell-effe..." - Arakne/Araknemu - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 668211...ef514d )

by Vincent

created 2022-05-23 10:00 UTC

fr.quatrevieux.araknemu.game.fight.fighter.AbstractFighter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Test Coverage

Coverage

98.48%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	106
c	1
b	0
f	0
dl	0
loc	177
ccs	65
cts	66
cp	0.9848
rs	9.52
wmc	36

23 Methods

Rating	Name	Size	Complexity
A	turn()	7	2
A	cell()	7	2
A	perform(Consumer)	6	2
A	attach(Object,Object)	3	1
A	joinFight(Fight,FightCell)	9	2
A	fight()	7	2
A	equals(Object)	11	3
A	states()	3	1
A	stop()	3	1
A	move(FightCell)	11	3
A	isOnFight()	3	1
A	init()	7	2
A	orientation()	3	1
A	dispatcher()	2	1
A	play(FightTurn)	3	1
A	setHidden(PassiveFighter,boolean)	10	4
A	isPlaying()	3	1
A	setOrientation(Direction)	3	1
A	dispatch(Object)	3	1
A	hashCode()	3	1
A	buffs()	3	1
A	hidden()	3	1
A	attachment(Object)	3	1

/*
 * This file is part of Araknemu.
 *
 * Araknemu is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Araknemu is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Araknemu.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Copyright (c) 2017-2020 Vincent Quatrevieux
 */

package fr.quatrevieux.araknemu.game.fight.fighter;

import fr.arakne.utils.maps.constant.Direction;
import fr.quatrevieux.araknemu.core.event.DefaultListenerAggregate;
import fr.quatrevieux.araknemu.core.event.ListenerAggregate;
import fr.quatrevieux.araknemu.game.fight.Fight;
import fr.quatrevieux.araknemu.game.fight.castable.effect.buff.BuffList;
import fr.quatrevieux.araknemu.game.fight.exception.FightException;
import fr.quatrevieux.araknemu.game.fight.fighter.event.FighterHidden;
import fr.quatrevieux.araknemu.game.fight.fighter.event.FighterInitialized;
import fr.quatrevieux.araknemu.game.fight.fighter.event.FighterVisible;
import fr.quatrevieux.araknemu.game.fight.map.FightCell;
import fr.quatrevieux.araknemu.game.fight.turn.FightTurn;
import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.HashMap;
import java.util.Map;
import java.util.function.Consumer;

/**
 * Base class for implements a fighter
 * Provide commons attributes and methods
 */
public abstract class AbstractFighter implements Fighter {
    private final ListenerAggregate dispatcher = new DefaultListenerAggregate();
    @SuppressWarnings({"assignment", "argument"})
    private final BuffList buffs = new BuffList(this);
    @SuppressWarnings({"assignment", "argument"})
    private final States states = new FighterStates(this);
    private final Map<Object, Object> attachments = new HashMap<>();

    // Mutable attributes
    private @Nullable FightCell cell;
    private @MonotonicNonNull Fight fight;
    private @Nullable FightTurn turn;
    private Direction orientation = Direction.SOUTH_EAST;
    private boolean hidden = false;

    @Override
    public void init() {
        if (fight == null) {
            throw new IllegalStateException("The fighter should join the fight before initialisation");
        }

        fight.dispatch(new FighterInitialized(this));
    }

    @Override
    public final FightCell cell() {
        if (cell == null) {
            throw new IllegalStateException("The fighter is not on a cell");
        }

        return cell;
    }

    @Override
    public final Direction orientation() {
        return orientation;
    }

    @Override
    public final void setOrientation(Direction orientation) {
        this.orientation = orientation;
    }

    @Override
    public final void move(@Nullable FightCell cell) {
        if (this.cell != null) {
            this.cell.removeFighter();
        }

        if (cell != null) {
            cell.set(this);
        }

        this.cell = cell;
    }

    @Override
    public void dispatch(Object event) {
        dispatcher.dispatch(event);
    }

    public final ListenerAggregate dispatcher() {
        return dispatcher;
    }

    @Override
    public final BuffList buffs() {
        return buffs;
    }

    @Override
    public final States states() {
        return states;
    }

    @Override
    public final Fight fight() {
        if (fight == null) {
            throw new IllegalStateException("The fighter has not join a fight");
        }

        return fight;
    }

    @Override
    public final void joinFight(Fight fight, FightCell startCell) {
        if (this.fight != null) {
            throw new IllegalStateException("A fight is already defined");
        }

        this.fight = fight;
        this.cell = startCell;
        startCell.set(this);
    }

    @Override
    public void play(FightTurn turn) {
        this.turn = turn;
    }

    @Override
    public void stop() {
        turn = null;
    }

    @Override
    public final FightTurn turn() {
        if (turn == null) {
            throw new FightException("It's not your turn");
        }

        return turn;
    }

    @Override
    public final void perform(Consumer<FightTurn> action) {
        final FightTurn turn = this.turn;


        if (turn != null) {
            action.accept(turn);
        }
    }

    @Override
    public boolean isPlaying() {
        return turn != null && turn.active();
    }

    @Override
    public final void attach(Object key, Object value) {
        attachments.put(key, value);
    }

    @Override
    public final @Nullable Object attachment(Object key) {
        return attachments.get(key);
    }

    @Override
    public final boolean isOnFight() {
        return fight != null && cell != null;
    }

    @Override
    public boolean hidden() {
        return hidden;
    }

    @Override
    public void setHidden(PassiveFighter caster, boolean hidden) {
        if (this.hidden == hidden) {
            return;
        }

        this.hidden = hidden;

        if (fight != null) {
            fight.dispatch(hidden ? new FighterHidden(this, caster) : new FighterVisible(this, caster));
        }
    }

    @Override
    public final boolean equals(@Nullable Object obj) {
        if (obj == this) {
            return true;
        }

        if (!(obj instanceof PassiveFighter)) {
            return false;
        }

        return id() == ((PassiveFighter) obj).id();
    }

    @Override
    public final int hashCode() {
        return id();
    }
}


1		/*
2		* This file is part of Araknemu.
3		*
4		* Araknemu is free software: you can redistribute it and/or modify
5		* it under the terms of the GNU Lesser General Public License as published by
6		* the Free Software Foundation, either version 3 of the License, or
7		* (at your option) any later version.
8		*
9		* Araknemu is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU Lesser General Public License for more details.
13		*
14		* You should have received a copy of the GNU Lesser General Public License
15		* along with Araknemu. If not, see <https://www.gnu.org/licenses/>.
16		*
17		* Copyright (c) 2017-2020 Vincent Quatrevieux
18		*/
19
20		package fr.quatrevieux.araknemu.game.fight.fighter;
21
22		import fr.arakne.utils.maps.constant.Direction;
23		import fr.quatrevieux.araknemu.core.event.DefaultListenerAggregate;
24		import fr.quatrevieux.araknemu.core.event.ListenerAggregate;
25		import fr.quatrevieux.araknemu.game.fight.Fight;
26		import fr.quatrevieux.araknemu.game.fight.castable.effect.buff.BuffList;
27		import fr.quatrevieux.araknemu.game.fight.exception.FightException;
28		import fr.quatrevieux.araknemu.game.fight.fighter.event.FighterHidden;
29		import fr.quatrevieux.araknemu.game.fight.fighter.event.FighterInitialized;
30		import fr.quatrevieux.araknemu.game.fight.fighter.event.FighterVisible;
31		import fr.quatrevieux.araknemu.game.fight.map.FightCell;
32		import fr.quatrevieux.araknemu.game.fight.turn.FightTurn;
33		import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
34		import org.checkerframework.checker.nullness.qual.Nullable;
35
36		import java.util.HashMap;
37		import java.util.Map;
38		import java.util.function.Consumer;
39
40		/**
41		* Base class for implements a fighter
42		* Provide commons attributes and methods
43		*/
44	1	public abstract class AbstractFighter implements Fighter {
45	1	private final ListenerAggregate dispatcher = new DefaultListenerAggregate();
46	1	@SuppressWarnings({"assignment", "argument"})
47		private final BuffList buffs = new BuffList(this);
48	1	@SuppressWarnings({"assignment", "argument"})
49		private final States states = new FighterStates(this);
50	1	private final Map<Object, Object> attachments = new HashMap<>();
51
52		// Mutable attributes
53		private @Nullable FightCell cell;
54		private @MonotonicNonNull Fight fight;
55		private @Nullable FightTurn turn;
56	1	private Direction orientation = Direction.SOUTH_EAST;
57	1	private boolean hidden = false;
58
59		@Override
60		public void init() {
61	1	if (fight == null) {
62	1	throw new IllegalStateException("The fighter should join the fight before initialisation");
63		}
64
65	1	fight.dispatch(new FighterInitialized(this));
66	1	}
67
68		@Override
69		public final FightCell cell() {
70	1	if (cell == null) {
71	1	throw new IllegalStateException("The fighter is not on a cell");
72		}
73
74	1	return cell;
75		}
76
77		@Override
78		public final Direction orientation() {
79	1	return orientation;
80		}
81
82		@Override
83		public final void setOrientation(Direction orientation) {
84	1	this.orientation = orientation;
85	1	}
86
87		@Override
88		public final void move(@Nullable FightCell cell) {
89	1	if (this.cell != null) {
90	1	this.cell.removeFighter();
91		}
92
93	1	if (cell != null) {
94	1	cell.set(this);
95		}
96
97	1	this.cell = cell;
98	1	}
99
100		@Override
101		public void dispatch(Object event) {
102	1	dispatcher.dispatch(event);
103	1	}
104
105		public final ListenerAggregate dispatcher() {
106	1	return dispatcher;
107		}
108
109		@Override
110		public final BuffList buffs() {
111	1	return buffs;
112		}
113
114		@Override
115		public final States states() {
116	1	return states;
117		}
118
119		@Override
120		public final Fight fight() {
121	1	if (fight == null) {
122	1	throw new IllegalStateException("The fighter has not join a fight");
123		}
124
125	1	return fight;
126		}
127
128		@Override
129		public final void joinFight(Fight fight, FightCell startCell) {
130	1	if (this.fight != null) {
131	1	throw new IllegalStateException("A fight is already defined");
132		}
133
134	1	this.fight = fight;
135	1	this.cell = startCell;
136	1	startCell.set(this);
137	1	}
138
139		@Override
140		public void play(FightTurn turn) {
141	1	this.turn = turn;
142	1	}
143
144		@Override
145		public void stop() {
146	1	turn = null;
147	1	}
148
149		@Override
150		public final FightTurn turn() {
151	1	if (turn == null) {
152	1	throw new FightException("It's not your turn");
153		}
154
155	1	return turn;
156		}
157
158		@Override
159		public final void perform(Consumer<FightTurn> action) {
160	1	final FightTurn turn = this.turn;
		0 ignored issues – show Comprehensibility introduced 2021-12-14 18:33 UTC by Report Bug Copy Issue Report The variable `turn`shadows a field with the same name declared in line 55. Consider renaming it. Loading history...
161
162	1	if (turn != null) {
163	1	action.accept(turn);
164		}
165	1	}
166
167		@Override
168		public boolean isPlaying() {
169	1	return turn != null && turn.active();
170		}
171
172		@Override
173		public final void attach(Object key, Object value) {
174	1	attachments.put(key, value);
175	1	}
176
177		@Override
178		public final @Nullable Object attachment(Object key) {
179	1	return attachments.get(key);
180		}
181
182		@Override
183		public final boolean isOnFight() {
184	1	return fight != null && cell != null;
185		}
186
187		@Override
188		public boolean hidden() {
189	1	return hidden;
190		}
191
192		@Override
193		public void setHidden(PassiveFighter caster, boolean hidden) {
194	1	if (this.hidden == hidden) {
195	1	return;
196		}
197
198	1	this.hidden = hidden;
199
200	1	if (fight != null) {
201	1	fight.dispatch(hidden ? new FighterHidden(this, caster) : new FighterVisible(this, caster));
202		}
203	1	}
204
205		@Override
206		public final boolean equals(@Nullable Object obj) {
207	1	if (obj == this) {
208	1	return true;
209		}
210
211	1	if (!(obj instanceof PassiveFighter)) {
212		return false;
213		}
214
215	1	return id() == ((PassiveFighter) obj).id();
216		}
217
218		@Override
219		public final int hashCode() {
220	1	return id();
221		}
222		}
223

Arakne / Araknemu

Push — master ( 668211...ef514d )

fr.quatrevieux.araknemu.game.fight.fighter.AbstractFighter A

Complexity

Size/Duplication

Test Coverage

Importance

23 Methods

Duplication Side-by-Side

Filter issues like