Skip to content

Commit dbebe1e

Browse files
Merge pull request #19 from startersclan/docs/readme-add-deprecation-notices-for-ping-query
Docs (readme): Add deprecation notices for ping query
2 parents a41f0bb + 0355511 commit dbebe1e

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ SourceQuery -Address $address -Port $port -Engine 'Source' -Type 'info'
3434
SourceQuery -Address $address -Port $port -Engine 'Source' -Type 'players'
3535
# A2S_RULES query, Returns a hashtable of server cvars
3636
SourceQuery -Address $address -Port $port -Engine 'Source' -Type 'rules'
37-
# A2A_PING query. Returns a hashtable of whether the ping was successful
37+
# A2A_PING query (deprecated). Returns a hashtable of whether the ping was successful
3838
SourceQuery -Address $address -Port $port -Engine 'Source' -Type 'ping'
3939
4040
# Goldsource Engine
@@ -44,7 +44,7 @@ SourceQuery -Address $address -Port $port -Engine 'Goldsource' -Type 'info'
4444
SourceQuery -Address $address -Port $port -Engine 'Goldsource' -Type 'players'
4545
# A2S_RULES query, Returns a hashtable of server cvars
4646
SourceQuery -Address $address -Port $port -Engine 'Goldsource' -Type 'rules'
47-
# A2A_PING query. Returns a hashtable of whether the ping was successful
47+
# A2A_PING query (deprecated). Returns a hashtable of whether the ping was successful
4848
SourceQuery -Address $address -Port $port -Engine 'Goldsource' -Type 'ping'
4949
```
5050

@@ -75,6 +75,10 @@ Engine | Games
7575

7676
The functions will probably work on a lot more games than those in the list.
7777

78+
Q: `ping` query not working for some games?
79+
80+
`A2A_PING` is no longer supported on Counter Strike: Source and Team Fortress 2 servers, and is considered a deprecated feature. See official documentation [here](https://developer.valvesoftware.com/wiki/Server_queries#A2A_PING) for more information.
81+
7882
## Notes
7983

8084
The functions are *stateless* - that is, `SourceQuery`, `SourceRcon`, and `GoldsourceRcon` are pure functions, storing no authentication or challenge states. This is to be expected for Source Queries, but not for Rcon. A possible future area of improvement would be to make `SourceRcon` and `GoldsourceRcon` construct and return a stateful Rcon object, that would improve client performance especially when multiple rcon commands need to be executed in sequence.

0 commit comments

Comments
 (0)