EOS_UI_GetToggleFriendsKey

EOS API reference page for EOS_UI_GetToggleFriendsKey

Choose your implementation method:

C

C#

This function is part of the UI Interface.

Remarks

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.

Parameters

EOS_UI_GetToggleFriendsKey

Parameter Type And Name

Usage Information

EOS_HUI Handle

const EOS_UI_GetToggleFriendsKeyOptions* Options

Structure containing any options that are needed to retrieve the key.

Related API Members

This function is part of the UI Interface.

Remarks

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){KeyCombination.Shift} | (int32_t){KeyCombination.F3}). {KeyCombination.None} will be returned if any error occurs.

Return Value

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

Parameters

UI.UIInterface.GetToggleFriendsKey

Parameter Type And Name

Usage Information

GetToggleFriendsKeyOptions options

Structure containing any options that are needed to retrieve the key.

Related API Members

Tags