Update Indicator

Table of Contents

• 1. Introduction
• 2. Display Specifications Rules for Update Indicators
• 3. Update Indicator Image Data
• 4. Revision History

1. Introduction

The update indicator is an icon used on the HOME Menu to notify users that new data has arrived for an application, and that there are friends to join in with.

If an update indicator also displays in the application when it is displayed on the HOME Menu, then users can be smoothly guided to the place where the newly arrived data is shown. However, if every application uses its own rules for displaying update indicators, this can confuse users rather than aid them.
For this reason, you should obey the following rules when using update indicators in your applications.

2. Display Specifications Rules for Update Indicators

Here, we explain the rules you should follow when discussing specifications and methods for implementing update indicators.

Basic Rules

• If an update indicator is being displayed on the icon for the application in the HOME Menu, the same update indicator should be shown in the application itself.
• Sometimes an update indicator displays on the HOME Menu even while an application is suspended, so when an application resumes from its suspension you need to update the display state of the update indicator in the application (that is, display the update indicator if the conditions for showing it are satisfied).
• If it proves troublesome to automatically update the display state of the update indicator when the application resumes from suspension, then implement some mechanism by which the user can perform the process from some screen that the user readily associates with the place where the update indicator displays.
  (Example) Create a list of data received via StreetPass, displaying the update indicator next to each item, in effect presenting a screen where the user can check for received StreetPass data. Put a "Receive New Data" button on this screen. When the user taps this button, any newly received data gets added to the list and displays the update indicator.
• It is fine to display the update indicator inside the application but not on the icon for that application in the HOME Menu.
  (Example) Remove the update indicator from the HOME Menu but keep it displaying inside the application because the user has not yet actually checked the data that has arrived.

In the following sections we introduce rules for how the various update indicators should behave in the HOME Menu. When discussing the specifications and methods for implementing these update indicators, remember to also adhere to the basic rules laid out above.

Rules for Update Indicator Display for StreetPass

Follow these rules when displaying the StreetPass update indicator on application icons in the HOME Menu:

• When data arrives in the StreetPass box, display an update indicator on the icon for the application for which the data has been received.
• Delete the update indicator once the application has called the nn::cec::CTR::MessageBox::CloseMessageBox function after calling the nn::cec::CTR::MessageBox::OpenMessageBox function.
• There is no way for the application to determine whether the update indicator is displaying in the HOME Menu.

Rules for Update Indicator Display for SpotPass

Follow these rules when displaying the SpotPass update indicator on application icons in the HOME Menu:

• When new SpotPass data has arrived for an application, display an update indicator on the icon for that application.
• Determine the arrival of new data with the nn::boss::GetNewArrivalFlag function, and therefore do not display the update indicator when what has been downloaded in NS data for which the new arrival flag is not set in the server settings.
• Delete the update indicator when the application calls any of the nn::boss::Get*NsDataIdList functions, since the new arrival flag is cleared.
• For further details, see the boss Function Reference Manual and the associated programming manual.

Rules for Update Indicator Display for Friends

Follow these rules when displaying the update indicator for friends on the Friend List icon in the HOME Menu.

• If there is a friend to join in with, display the update indicator on the Friend List icon.
• If there are no friends to join in with, the update indicator should disappear.
• Here, the meaning of whether or not there are "friends to join in with" is the same as whether or not the "Join game being played" button has been pressed on the Friend List. This determination is not limited to the join-in target application, so there is no way for the application to get whether the update indicator is displaying in the HOME Menu.

As mentioned above, the update indicator for friends in the HOME Menu is not specific to any one application. However, if you will be using update indicators in your application, use them to indicate to users when they can join in with friends (that is, when the nn::friends::FriendPresense::IsJoinable function returns true).

3. Update Indicator Image Data

Here, we describe the update indicator image data and the rules for using that image data.

When Using NW4C Layout

Use the data located in the folder, $CTR_SDK/resources/icon/UpdateIndicator/layout.

When Not Using NW4C Layout

The data have been prepared in the form of a PSD file. Export the data to the appropriate format for your application development environment and implement according to the display rules.
The image data file is located in the following directory in the CTR-SDK.
$CTR_SDK/resources/icon/UpdateIndicator

The layer configuration of the PSD file is as follows.

Update Indicator Display Rules

　　

• Basic animation:

  Content	Details
  Graphics	Layer Light on top of Lamp.
  Animation	Loop of 60 frames Animate just the opacity of Light. -------------------------------- Frame count Opacity 0　　　　　　　 0 30　　　　　　　255 60　　　　　　　0 --------------------------------

  (Reference)
  
  The animation curve below is provided for reference purposes for creating a blinking animation the same as the HOME Menu.
  
  Refer to this when implementing your animation. (It does not need to be strictly the same.)
  
  The slope should be set to zero as shown in the animation curve.
  

  
  

• When both StreetPass and SpotPass data have arrived:

  To indicate the arrival of data for both StreetPass and SpotPass, adhere to the rules described above and alternate the color between green and blue within the span of 120 frames.
  
  Use cross-fading so the color of Lamp changes smoothly between green and blue.
  
  As a reference, view the following video clip.
  $CTR_SDK/documents/resources/UpdateIndicator/img/StreetPass_SpotPass.avi

　　


• Display size:

  You are free to adjust the size of the update indicator, providing you display it within a reasonable range that is not too large or too small.

　　


• Modifications:

  Icons cannot be modified. Do not switch to the use of original colors or make changes to the pattern.

4. Revision History

2012/05/21

Initial version.

CONFIDENTIAL