fr.arakne.swfmaploader.swf.SwfMapStructure.ambianceId() - Code Metrics - Arakne/SwfMapLoader - Measure and Improve Code Quality continuously with Scrutinizer

ambianceId() A
last analyzed 2020-07-18 14:11 UTC

↳ Parent: fr.arakne.swfmaploader.swf.SwfMapStructure

Complexity

Conditions

Size

Total Lines	2
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	2
cc	1
ccs	1
cts	1
cp	1
crap	1
rs	10

/*

 * This file is part of Swf Map Loader.
 *
 * Swf Map Loader 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.
 *
 * Swf Map Loader 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 Swf Map Loader.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Copyright (c) 2020-2020 Vincent Quatrevieux
 */

package fr.arakne.swfmaploader.swf;

/**
 * Data structure of the swf map file
 */
final public class SwfMapStructure {

    private int id;
    private int width;
    private int height;
    private int backgroundNum;
    private int ambianceId;
    private int musicId;
    private boolean outdoor;
    private int capabilities;
    private String mapData;
    private String version;

    /**
     * @return The map id. This is the primary key
     */
    public int id() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    /**
     * @return The map width. positive integer
     */
    public int width() {
        return width;
    }

    public void setWidth(int width) {
        this.width = width;
    }

    /**
     * @return The map height. positive integer
     */
    public int height() {
        return height;
    }

    public void setHeight(int height) {
        this.height = height;
    }

    /**
     * @return The background image number. Can be zero for no background
     */
    public int backgroundNum() {
        return backgroundNum;
    }

    public void setBackgroundNum(int backgroundNum) {
        this.backgroundNum = backgroundNum;
    }

    /**
     * @return The ambiance sound id
     */
    public int ambianceId() {
        return ambianceId;
    }

    public void setAmbianceId(int ambianceId) {
        this.ambianceId = ambianceId;
    }

    /**
     * @return The music id
     */
    public int musicId() {
        return musicId;
    }

    public void setMusicId(int musicId) {
        this.musicId = musicId;
    }

    /**
     * @return true if the map is outdoor
     */
    public boolean isOutdoor() {
        return outdoor;
    }

    public void setOutdoor(boolean outdoor) {
        this.outdoor = outdoor;
    }

    /**
     * Bitset for allowing actions
     *
     * https://github.com/Emudofus/Dofus/blob/1.29/dofus/managers/MapsServersManager.as#L141
     * @return The bitset as integer
     */
    public int capabilities() {
        return capabilities;
    }

    public void setCapabilities(int capabilities) {
        this.capabilities = capabilities;
    }

    /**
     * The map data. If the map is encrypted (ends with X.swf), the map data will be encrypted.
     *
     * @return The raw map data as string
     */
    public String mapData() {
        return mapData;
    }

    public void setMapData(String mapData) {
        this.mapData = mapData;
    }

    /**
     * @return The map version string
     */
    public String version() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    /**
     * Check if the structure contains valid data
     *
     * @return true if valid
     */
    public boolean valid() {
        return id > 0 && width > 0 && height > 0 && mapData != null && !mapData.isEmpty();

    }

    @Override
    public String toString() {
        return "MapStructure{" +
            "id=" + id +
            ", width=" + width +
            ", height=" + height +
            ", backgroundNum=" + backgroundNum +
            ", ambianceId=" + ambianceId +
            ", musicId=" + musicId +
            ", outdoor=" + outdoor +
            ", capabilities=" + capabilities +
            ", mapData='" + mapData + '\'' +
            '}'
        ;
    }
}


1		/*
		1 ignored issue – show Code Smell introduced 2020-07-18 14:11 UTC by Report Bug Copy Issue Report It is a best practice to supply a copyright/licence header in your code. Your organisation probably has a template for that. Loading history...
2		* This file is part of Swf Map Loader.
3		*
4		* Swf Map Loader 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		* Swf Map Loader 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 Swf Map Loader. If not, see <https://www.gnu.org/licenses/>.
16		*
17		* Copyright (c) 2020-2020 Vincent Quatrevieux
18		*/
19
20		package fr.arakne.swfmaploader.swf;
21
22		/**
23		* Data structure of the swf map file
24		*/
25	1	final public class SwfMapStructure {
		0 ignored issues – show introduced 2020-07-18 13:36 UTC by Report Bug Copy Issue Report Add a constructor to the class. Loading history...
26		private int id;
27		private int width;
28		private int height;
29		private int backgroundNum;
30		private int ambianceId;
31		private int musicId;
32		private boolean outdoor;
33		private int capabilities;
34		private String mapData;
35		private String version;
36
37		/**
38		* @return The map id. This is the primary key
39		*/
40		public int id() {
41	1	return id;
42		}
43
44		public void setId(int id) {
45	1	this.id = id;
46	1	}
47
48		/**
49		* @return The map width. positive integer
50		*/
51		public int width() {
52	1	return width;
53		}
54
55		public void setWidth(int width) {
56	1	this.width = width;
57	1	}
58
59		/**
60		* @return The map height. positive integer
61		*/
62		public int height() {
63	1	return height;
64		}
65
66		public void setHeight(int height) {
67	1	this.height = height;
68	1	}
69
70		/**
71		* @return The background image number. Can be zero for no background
72		*/
73		public int backgroundNum() {
74	1	return backgroundNum;
75		}
76
77		public void setBackgroundNum(int backgroundNum) {
78	1	this.backgroundNum = backgroundNum;
79	1	}
80
81		/**
82		* @return The ambiance sound id
83		*/
84		public int ambianceId() {
85	1	return ambianceId;
86		}
87
88		public void setAmbianceId(int ambianceId) {
89	1	this.ambianceId = ambianceId;
90	1	}
91
92		/**
93		* @return The music id
94		*/
95		public int musicId() {
96	1	return musicId;
97		}
98
99		public void setMusicId(int musicId) {
100	1	this.musicId = musicId;
101	1	}
102
103		/**
104		* @return true if the map is outdoor
105		*/
106		public boolean isOutdoor() {
107	1	return outdoor;
108		}
109
110		public void setOutdoor(boolean outdoor) {
111	1	this.outdoor = outdoor;
112	1	}
113
114		/**
115		* Bitset for allowing actions
116		*
117		* https://github.com/Emudofus/Dofus/blob/1.29/dofus/managers/MapsServersManager.as#L141
118		* @return The bitset as integer
119		*/
120		public int capabilities() {
121	1	return capabilities;
122		}
123
124		public void setCapabilities(int capabilities) {
125	1	this.capabilities = capabilities;
126	1	}
127
128		/**
129		* The map data. If the map is encrypted (ends with X.swf), the map data will be encrypted.
130		*
131		* @return The raw map data as string
132		*/
133		public String mapData() {
134	1	return mapData;
135		}
136
137		public void setMapData(String mapData) {
138	1	this.mapData = mapData;
139	1	}
140
141		/**
142		* @return The map version string
143		*/
144		public String version() {
145	1	return version;
146		}
147
148		public void setVersion(String version) {
149	1	this.version = version;
150	1	}
151
152		/**
153		* Check if the structure contains valid data
154		*
155		* @return true if valid
156		*/
157		public boolean valid() {
158	1	return id > 0 && width > 0 && height > 0 && mapData != null && !mapData.isEmpty();
		0 ignored issues – show Comprehensibility introduced 2020-07-18 13:36 UTC by Report Bug Copy Issue Report Reduce the number of conditional operators (4) used in the expression (maximum allowed 3). Loading history...
159		}
160
161		@Override
162		public String toString() {
163	1	return "MapStructure{" +
164		"id=" + id +
165		", width=" + width +
166		", height=" + height +
167		", backgroundNum=" + backgroundNum +
168		", ambianceId=" + ambianceId +
169		", musicId=" + musicId +
170		", outdoor=" + outdoor +
171		", capabilities=" + capabilities +
172		", mapData='" + mapData + '\'' +
173		'}'
174		;
175		}
176		}
177

Arakne / SwfMapLoader

ambianceId() A last analyzed 2020-07-18 14:11 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ambianceId() A
last analyzed 2020-07-18 14:11 UTC