fr.quatrevieux.araknemu.game.fight.fighter.AbstractFighter - Code Metrics - Inspection of "#27 Add vitality effects" - Arakne/Araknemu - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#251)

by Vincent

created 2022-04-27 15:35 UTC

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

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Test Coverage

Coverage

98.28%

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	95
dl	0
loc	158
ccs	57
cts	58
cp	0.9828
c	1
b	0
f	0
rs	9.92
wmc	31

21 Methods

Rating	Name	Size	Complexity
A	turn()	7	2
A	cell()	7	2
A	perform(Consumer)	6	2
A	joinFight(Fight,FightCell)	9	2
A	states()	3	1
A	stop()	3	1
A	move(FightCell)	11	3
A	orientation()	3	1
A	dispatcher()	2	1
A	play(FightTurn)	3	1
A	setOrientation(Direction)	3	1
A	dispatch(Object)	3	1
A	buffs()	3	1
A	fight()	7	2
A	init()	7	2
A	attach(Object,Object)	3	1
A	equals(Object)	11	3
A	isOnFight()	3	1
A	isPlaying()	3	1
A	hashCode()	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.FighterInitialized;
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;

    @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;
    }

    @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 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.FighterInitialized;
29		import fr.quatrevieux.araknemu.game.fight.map.FightCell;
30		import fr.quatrevieux.araknemu.game.fight.turn.FightTurn;
31		import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
32		import org.checkerframework.checker.nullness.qual.Nullable;
33
34		import java.util.HashMap;
35		import java.util.Map;
36		import java.util.function.Consumer;
37
38		/**
39		* Base class for implements a fighter
40		* Provide commons attributes and methods
41		*/
42	1	public abstract class AbstractFighter implements Fighter {
43	1	private final ListenerAggregate dispatcher = new DefaultListenerAggregate();
44	1	@SuppressWarnings({"assignment", "argument"})
45		private final BuffList buffs = new BuffList(this);
46	1	@SuppressWarnings({"assignment", "argument"})
47		private final States states = new FighterStates(this);
48	1	private final Map<Object, Object> attachments = new HashMap<>();
49
50		// Mutable attributes
51		private @Nullable FightCell cell;
52		private @MonotonicNonNull Fight fight;
53		private @Nullable FightTurn turn;
54	1	private Direction orientation = Direction.SOUTH_EAST;
55
56		@Override
57		public void init() {
58	1	if (fight == null) {
59	1	throw new IllegalStateException("The fighter should join the fight before initialisation");
60		}
61
62	1	fight.dispatch(new FighterInitialized(this));
63	1	}
64
65		@Override
66		public final FightCell cell() {
67	1	if (cell == null) {
68	1	throw new IllegalStateException("The fighter is not on a cell");
69		}
70
71	1	return cell;
72		}
73
74		@Override
75		public final Direction orientation() {
76	1	return orientation;
77		}
78
79		@Override
80		public final void setOrientation(Direction orientation) {
81	1	this.orientation = orientation;
82	1	}
83
84		@Override
85		public final void move(@Nullable FightCell cell) {
86	1	if (this.cell != null) {
87	1	this.cell.removeFighter();
88		}
89
90	1	if (cell != null) {
91	1	cell.set(this);
92		}
93
94	1	this.cell = cell;
95	1	}
96
97		@Override
98		public void dispatch(Object event) {
99	1	dispatcher.dispatch(event);
100	1	}
101
102		public final ListenerAggregate dispatcher() {
103	1	return dispatcher;
104		}
105
106		@Override
107		public final BuffList buffs() {
108	1	return buffs;
109		}
110
111		@Override
112		public final States states() {
113	1	return states;
114		}
115
116		@Override
117		public final Fight fight() {
118	1	if (fight == null) {
119	1	throw new IllegalStateException("The fighter has not join a fight");
120		}
121
122	1	return fight;
123		}
124
125		@Override
126		public final void joinFight(Fight fight, FightCell startCell) {
127	1	if (this.fight != null) {
128	1	throw new IllegalStateException("A fight is already defined");
129		}
130
131	1	this.fight = fight;
132	1	this.cell = startCell;
133	1	startCell.set(this);
134	1	}
135
136		@Override
137		public void play(FightTurn turn) {
138	1	this.turn = turn;
139	1	}
140
141		@Override
142		public void stop() {
143	1	turn = null;
144	1	}
145
146		@Override
147		public final FightTurn turn() {
148	1	if (turn == null) {
149	1	throw new FightException("It's not your turn");
150		}
151
152	1	return turn;
153		}
154
155		@Override
156		public final void perform(Consumer<FightTurn> action) {
157	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 53. Consider renaming it. Loading history...
158
159	1	if (turn != null) {
160	1	action.accept(turn);
161		}
162	1	}
163
164		@Override
165		public boolean isPlaying() {
166	1	return turn != null;
167		}
168
169		@Override
170		public final void attach(Object key, Object value) {
171	1	attachments.put(key, value);
172	1	}
173
174		@Override
175		public final @Nullable Object attachment(Object key) {
176	1	return attachments.get(key);
177		}
178
179		@Override
180		public final boolean isOnFight() {
181	1	return fight != null && cell != null;
182		}
183
184		@Override
185		public final boolean equals(@Nullable Object obj) {
186	1	if (obj == this) {
187	1	return true;
188		}
189
190	1	if (!(obj instanceof PassiveFighter)) {
191		return false;
192		}
193
194	1	return id() == ((PassiveFighter) obj).id();
195		}
196
197		@Override
198		public final int hashCode() {
199	1	return id();
200		}
201		}
202

Arakne / Araknemu

Pull Request — master (#251)

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

Complexity

Size/Duplication

Test Coverage

Importance

21 Methods

Duplication Side-by-Side

Filter issues like