EOS_UI_SetToggleFriendsKey

EOS API reference page for EOS_UI_SetToggleFriendsKey

実装方法を選んでください。

C

C#

This function is part of the [UI Interface](Interfaces/UI).

Remarks

Updates 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). The provided key should satisfy EOS_UI_IsValidKeyCombination. The value EOS_UIK_None is specially handled by resetting the key binding to the system default.

Return Value

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

  • EOS_InvalidParameters If any of the options are incorrect.

  • EOS_NotConfigured If the overlay is not properly configured.

  • EOS_NoChange If the key combination did not change.

See Also

EOS_UI_IsValidKeyCombination

Parameters

EOS_UI_SetToggleFriendsKey

Parameter Type And Name

Usage Information

EOS_HUI Handle

const EOS_UI_SetToggleFriendsKeyOptions* Options

Structure containing the key combination to use.

Related API Members

This function is part of the [UI Interface](Interfaces/UI).

Remarks

Updates 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). The provided key should satisfy EOS_UI_IsValidKeyCombination. The value EOS_UIK_None is specially handled by resetting the key binding to the system default.

Return Value

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

  • EOS_InvalidParameters If any of the options are incorrect.

  • EOS_NotConfigured If the overlay is not properly configured.

  • EOS_NoChange If the key combination did not change.

See Also

EOS_UI_IsValidKeyCombination

Parameters

UI.UIInterface.SetToggleFriendsKey

Parameter Type And Name

Usage Information

SetToggleFriendsKeyOptions options

Structure containing the key combination to use.

Related API Members

タグ