5700: Add documentation for `IServer::GetClientVersion` r=heinrich5991 a=Robyt3

Closes #5694.

## Checklist

- [ ] Tested the change ingame
- [ ] Provided screenshots if it is a visual change
- [ ] Tested in combination with possibly related configuration options
- [ ] Written a unit test (especially base/) or added coverage to integration test
- [ ] Considered possible null pointers and out of bounds array indexing
- [ ] Changed no physics that affect existing maps
- [ ] Tested the change with [ASan+UBSan or valgrind's memcheck](https://github.com/ddnet/ddnet/#using-addresssanitizer--undefinedbehavioursanitizer-or-valgrinds-memcheck) (optional)


Co-authored-by: Robert Müller <robytemueller@gmail.com>
This commit is contained in:
bors[bot] 2022-08-03 21:32:06 +00:00 committed by GitHub
commit 35280a7a2f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -60,6 +60,16 @@ public:
virtual void SetClientDDNetVersion(int ClientID, int DDNetVersion) = 0;
virtual void GetClientAddr(int ClientID, char *pAddrStr, int Size) const = 0;
/**
* Returns the version of the client with the given client ID.
*
* @param ClientID the client ID, which must be between 0 and
* MAX_CLIENTS - 1, or equal to SERVER_DEMO_CLIENT for server demos.
*
* @return The version of the client with the given client ID.
* For server demos this is always the latest client version.
* On errors, VERSION_NONE is returned.
*/
virtual int GetClientVersion(int ClientID) const = 0;
virtual int SendMsg(CMsgPacker *pMsg, int Flags, int ClientID) = 0;