This function is part of the AntiCheatClient Interface.
Remarks
Add a callback when a message must be displayed to the local client informing them on a local integrity violation, which will prevent further online play. Mode: Any.
Return Value
A valid notification ID if successfully bound, or EOS_INVALID_NOTIFICATIONID otherwise
Parameters
EOS_AntiCheatClient_AddNotifyClientIntegrityViolated
| Parameter Type And Name | Usage Information |
|---|---|
| EOS_HAntiCheatClient Handle | |
| const EOS_AntiCheatClient_AddNotifyClientIntegrityViolatedOptions* Options | Structure containing input data |
| void* ClientData | This value is returned to the caller when NotificationFn is invoked |
| EOS_AntiCheatClient_OnClientIntegrityViolatedCallback NotificationFn | The callback to be fired |
Callback Function Information
Because this function is asynchronous, it employs a callback of type EOS_AntiCheatClient_OnClientIntegrityViolatedCallback to report the results of its operation. See the EOS_AntiCheatClient_OnClientIntegrityViolatedCallbackInfo page for more details, or check the [Callback Data] section below.
Callback Remarks
Callback issued when the local client triggers an integrity violation. The message contains descriptive string of up to 256 characters and must be displayed to the player. This callback is always issued from within EOS_Platform_Tick on its calling thread.
Callback Parameters
EOS_AntiCheatClient_OnClientIntegrityViolatedCallback
| Parameter Type And Name | Usage Information |
|---|---|
| const EOS_AntiCheatClient_OnClientIntegrityViolatedCallbackInfo* Data |
Callback Data
The EOS SDK passes the following data structure to the callback function:
EOS_AntiCheatClient_OnClientIntegrityViolatedCallbackInfo
| Property | Value |
|---|---|
| void* ClientData | Caller-specified context data |
| EOS_EAntiCheatClientViolationType ViolationType | Code describing the violation that occurred |
| const char* ViolationMessage | String describing the violation which should be displayed to the user |
For more information, see the EOS_AntiCheatClient_OnClientIntegrityViolatedCallbackInfo page.