@@ -29,185 +29,208 @@ class FiveServer {
29
29
30
30
/***
31
31
* Get the number of connected players
32
- * @return {number } Number of players
32
+ * @type {number } Number of players
33
+ * @readonly
33
34
*/
34
- getPlayersCount ( ) {
35
+ get playersCount ( ) {
35
36
return this . data [ "clients" ] ;
36
37
}
37
38
38
39
/***
39
40
* Get the players list
40
- * @return {Array<FivePlayer> } List of players
41
+ * @type {Array<FivePlayer> } List of players
42
+ * @readonly
41
43
*/
42
- getPlayers ( ) {
44
+ get players ( ) {
43
45
return this . data [ "players" ] ;
44
46
}
45
47
46
48
/***
47
49
* Get game type
48
- * @return {string } Game type
50
+ * @type {string } Game type
51
+ * @readonly
49
52
*/
50
- getGameType ( ) {
53
+ get gameType ( ) {
51
54
return this . data [ "gametype" ] ;
52
55
}
53
56
54
57
/***
55
58
* Get the server's hostname
56
- * @return {string } Server's hostname
59
+ * @type {string } Server's hostname
60
+ * @readonly
57
61
*/
58
- getHostName ( ) {
62
+ get hostname ( ) {
59
63
return this . data [ "hostname" ] ;
60
64
}
61
65
62
66
/***
63
67
* Get the server's current map
64
- * @return {string } Server's current map
68
+ * @type {string } Server's current map
69
+ * @readonly
65
70
*/
66
- getMapName ( ) {
71
+ get mapName ( ) {
67
72
return this . data [ "mapname" ] ;
68
73
}
69
74
70
75
/***
71
76
* Get the server's max players
72
- * @return {number } Server's max players
77
+ * @type {number } Server's max players
78
+ * @readonly
73
79
*/
74
- getMaxPlayers ( ) {
80
+ get maxPlayers ( ) {
75
81
return this . data [ "sv_maxclients" ] ;
76
82
}
77
83
78
84
/***
79
85
* Is the server enhanced host support
80
- * @return {boolean } True if server has enhanced host support
86
+ * @type {boolean } True if server has enhanced host support
87
+ * @readonly
81
88
*/
82
- isEnhancedHostSupport ( ) {
89
+ get enhancedHostSupport ( ) {
83
90
return this . data [ "enhancedHostSupport" ] ;
84
91
}
85
92
86
93
/***
87
94
* Get the server's list of active resources
88
- * @return {Array<String> } List of active resources
95
+ * @type {Array<String> } List of active resources
96
+ * @readonly
89
97
*/
90
- getResources ( ) {
98
+ get resources ( ) {
91
99
return this . data [ "resources" ]
92
100
}
93
101
94
102
/***
95
103
* Get the server's FXServer version
96
- * @return {String } FXServer version
104
+ * @type {String } FXServer version
105
+ * @readonly
97
106
*/
98
- getServerVersion ( ) {
107
+ get serverVersion ( ) {
99
108
return this . data [ "server" ]
100
109
}
101
110
102
111
/***
103
112
* Get the server's public variables
104
- * @return {Object } Public variables
113
+ * @type {Object } Public variables
114
+ * @readonly
105
115
*/
106
- getPublicVariables ( ) {
116
+ get publicVariables ( ) {
107
117
return this . data [ "vars" ]
108
118
}
109
119
110
120
/***
111
121
* Get the server's players count from the last server report
112
- * @return {number } Server's players count
122
+ * @type {number } Server's players count
123
+ * @readonly
113
124
*/
114
- getPlayersCountFromServerReport ( ) {
125
+ get playersCountFromServerReport ( ) {
115
126
return this . data [ "selfReportedClients" ] ;
116
127
}
117
128
118
129
/***
119
130
* Get the server's owner id
120
- * @return {number } Server's owner id
131
+ * @type {number } Server's owner id
132
+ * @readonly
121
133
*/
122
- getOwnerId ( ) {
134
+ get ownerId ( ) {
123
135
return this . data [ "ownerID" ] ;
124
136
}
125
137
126
138
/***
127
139
* Get is the server is password protected
128
- * @return {boolean } True if server is password protected
140
+ * @type {boolean } True if server is password protected
141
+ * @readonly
129
142
*/
130
- isPrivate ( ) {
143
+ get private ( ) {
131
144
return this . data [ "private" ] ;
132
145
}
133
146
134
147
/***
135
148
* Get is the server fallbabk
136
- * @return {boolean } True if server is fallback
149
+ * @type {boolean } True if server is fallback
150
+ * @readonly
137
151
*/
138
- isFallback ( ) {
152
+ get fallback ( ) {
139
153
return this . data [ "fallback" ]
140
154
}
141
155
142
156
/***
143
157
* Get the server's connect endpoints
144
- * @return {Array<String> } Server's connect endpoints
158
+ * @type {Array<String> } Server's connect endpoints
159
+ * @readonly
145
160
*/
146
- getConnectedEndpoints ( ) {
161
+ get connectedEndpoints ( ) {
147
162
return this . data [ "connectEndPoints" ] ;
148
163
}
149
164
150
165
/***
151
166
* Get the server's upvote power
152
- * @return {number } Server's upvote power
167
+ * @type {number } Server's upvote power
168
+ * @readonly
153
169
*/
154
- getUpvotePower ( ) {
170
+ get upvotePower ( ) {
155
171
return this . data [ "upvotePower" ] ;
156
172
}
157
173
158
174
/***
159
175
* Get the server's burst power
160
- * @return {number } Server's burst power
176
+ * @type {number } Server's burst power
177
+ * @readonly
161
178
*/
162
- getBurstPower ( ) {
179
+ get burstPower ( ) {
163
180
return this . data [ "burstPower" ] ;
164
181
}
165
182
166
183
/***
167
184
* Get is the server supported
168
- * @return {string } "supported" if server is supported
185
+ * @type {string } "supported" if server is supported
186
+ * @readonly
169
187
*/
170
- isSupported ( ) {
188
+ get supported ( ) {
171
189
return this . data [ "support_status" ]
172
190
}
173
191
174
192
/***
175
193
* Get the server's owner name
176
- * @returns {string } Server's owner name
194
+ * @type {string } Server's owner name
195
+ * @readonly
177
196
*/
178
- getOwnerName ( ) {
197
+ get ownerName ( ) {
179
198
return this . data [ "ownerName" ] ;
180
199
}
181
200
182
201
/***
183
202
* Get the server's owner cfx profile url
184
- * @returns {string } Server's owner cfx profile url
203
+ * @type {string } Server's owner cfx profile url
204
+ * @readonly
185
205
*/
186
- getOwnerProfileUrl ( ) {
206
+ get ownerProfileUrl ( ) {
187
207
return this . data [ "ownerProfile" ] ;
188
208
}
189
209
190
210
/***
191
211
* Get the server's owner avatar url
192
- * @returns {string } Server's owner avatar url
212
+ * @type {string } Server's owner avatar url
213
+ * @readonly
193
214
*/
194
- getOwnerAvatarUrl ( ) {
215
+ get ownerAvatarUrl ( ) {
195
216
return this . data [ "ownerAvatar" ] ;
196
217
}
197
218
198
219
/***
199
220
* Get the server's last seen date
200
- * @returns {string } Server's last seen date
221
+ * @type {string } Server's last seen date
222
+ * @readonly
201
223
*/
202
- getLastSeenDate ( ) {
224
+ get lastSeenDate ( ) {
203
225
return this . data [ "lastSeen" ] ;
204
226
}
205
227
206
228
/***
207
229
* Get the server's icon version
208
- * @returns {number } Server's icon version
230
+ * @type {number } Server's icon version
231
+ * @readonly
209
232
*/
210
- getIconVersion ( ) {
233
+ get iconVersion ( ) {
211
234
return this . data [ "iconVersion" ] ;
212
235
}
213
236
}
0 commit comments