PB SV GetSs

From PunksBusted

PunkBuster Server Version Warning
The behavior of this PunkBuster Server command or setting has significantly changed as a result of an update to the PunkBuster Server released by Even Balance. Where possible, we have noted relevant changes to this function's behavior in this article, but some undocumented or unexpected behavior may exist.

[edit]

PB Server Command

Original Version:
PB_SV_GetSs [Term]

Updated Version:
PB_SV_GetSs [Term] {[Sequence#]}

Sends a request to applicable connected players asking for a PunkBuster Screenshot to be sent to the PB-enabled server. The behavior of this command is dependent on the version of the Screen Capture Facility used in the game.

In the original version of this command, when the command is issued, a screenshot is scheduled to be captured immediately (using the logic of the PB_SV_SsDelay setting) and is then returned to the server as soon as it is available. Requests for screenshots can be sent to multiple clients simultaneously, depending on what term is provided as a parameter to the command. If no term is set, the request will be sent to all players. If the term is set to a player slot number (which is defined using the list provided by the PB_SV_PList command), the request will be sent to that player. If any other term is given (in double-quotes), any player where any part of their name matches the term will be sent the request. The screenshot will be taken in a manner determined by the PBSS-related server settings.

When the Screen Capture Facility was revised, it changed the manner in which PunkBuster Screenshots are taken by the client. The behavior of the facility changed such that clients take screenshots in regular intervals without requiring a request from the server first. These screenshots are stored in a queue, each with a unique sequence number. When the server makes a screenshot request, the client will return the most recent available queued screenshot by default. This command was changed to add an optional second parameter which allows you to define which queued screenshot you want returned based on its sequence number. The list of available screenshot sequence numbers for each client is available by using the PB_SV_SsList command. Additionally, this command was modified so that a screenshot request can only be sent to one client at most at a time.

Note that the revised Screen Capture Facility is not available in all PunkBuster-supported games. To determine the version of the facility in a particular game, try running the PB_SV_SsList command. If it fails with an error saying that it is not a valid PunkBuster command, then that game uses the original version of the Screen Capture Facility.

[edit]

Parameters

[Term] - The players to whom the screenshot request will be sent. Acceptable values:
- blank
  - Original Version: All players will be sent the request.
  - Updated Version: Behavior unknown.
- [PlayerSlot#] - The player who is in the defined player slot will be sent the request. A player's slot can be determined by using the PB_PList client command.
- "[SearchTerm]"
  - Original Version: Any player whose name contains the search term will be sent the request. This term must be enclosed in double-quotes.
  - Updated Version: If the term matches exactly to a player name, that player will be sent the request.
[Sequence#] (Optional) - Requires the client to return the screenshot they have with the specified sequence number. This is available only in the updated version of this command.