EOS API reference page for EOS_UI_GetToggleFriendsKey

1 min to read

This function is part of the UI Interface.


Returns the current Toggle Friends Key. This key can be used by the user to toggle the friends overlay when available. The default value represents Shift + F3 as ((int32_t)EOS_UIK_Shift | (int32_t)EOS_UIK_F3).

Return Value

  • A valid key combination which represent a single key with zero or more modifier keys.

  • EOS_UIK_None will be returned if any error occurs.



Parameter Type And NameUsage Information
EOS_HUI Handle
const EOS_UI_GetToggleFriendsKeyOptions* OptionsStructure containing any options that are needed to retrieve the key.