EOS API reference page for EOS_UI_PauseSocialOverlay

1 min to read

This function is part of the UI Interface.


Sets the bIsPaused state of the overlay. While true then all notifications will be delayed until after the bIsPaused is false again. While true then the key and button events will not toggle the overlay. If the Overlay was visible before being paused then it will be hidden. If it is known that the Overlay should now be visible after being paused then it will be shown.

Return Value

  • EOS_Success If the overlay has been notified about the request.

  • EOS_IncompatibleVersion if the API version passed in is incorrect.

  • EOS_InvalidParameters If any of the options are incorrect.

  • EOS_NotConfigured If the overlay is not properly configured.



Parameter Type And NameUsage Information
EOS_HUI Handle
const EOS_UI_PauseSocialOverlayOptions* Options