nn::friends::CTR::UpdateGameMode Function

Result UpdateGameMode(
     const GameMode & gameMode,
     const char16 description[MODE_DESCRIPTION_SIZE]
);

	Name	Description
in	gameMode	Specifies a game mode structure.
in	description[MODE_DESCRIPTION_SIZE]	Specifies a game mode description string.

Returns the result of the operation.

Updates the game mode.

Game mode information configured here is sent to friends when you are online and is displayed in their friend lists.

Specify your own local system's online group participation status in the game mode. Parameters set here are shared among applications for which the same join-in game ID is specified. Furthermore, the friend list determines which games can be joined according to fixed logic based on the game mode parameter set here. Note that there is a possibility that a friend list may erroneously display that join-in is possible if an inappropriate parameter is specified here. For details on how to use this feature, see the CTR Programming Manual: Wireless and NEX Programming Manual: Server Services.

The value specified in icon data is used for the value of the join-in game ID and the value specified here is ignored. For information on specifying a join-in game ID in icon data, see the ctr_makebanner manual.

An application must be restarted from the HOME Menu for the join-in game ID specified in its icon data to take effect. When an SD Card is inserted in the system, the HOME Menu caches icon data on the SD Card and thus updates to that data sometimes do not take effect. In this case, delete the cached icon data as described in the HOME Menu Manual.

The size of the game mode description string that is passed as an argument can be as large as nn::friends::CTR::MODE_DESCRIPTION_SIZE characters, including newline and terminating characters, but the friend list is limited to the display of 16 double-byte characters x 2 lines, and anything exceeding that is cut off and not shown.

The strings that are displayed on other players' friend lists have the following relationship with the system region.

Japan, the Americas, and Europe: The characters for Japan, the Americas, and Europe included in the internal fonts.

China: Simplified Chinese characters included in the internal fonts.

Korea:Hangul characters included in the internal fonts.

Taiwan: Traditional Chinese characters included in the internal fonts.

Characters that are not included here are replaced with the Nintendo extended character "?" (L'\xE011') for display For details about the character sets included in each font, see the CTR Overview.

For newlines, use L'\n'.

Follow the guidelines when determining how often to call this function.

2011/11/07

Added precautions related to how the join-in game ID takes effect.
Noted that you need to follow the guidelines when determining how often to call this function.

2011/08/30

Initial version.