nn::pl::CTR Namespace

Description

The namespace of the CTR common font library, pedometer library, and play coin library.
(This namespace can also be written without the ::CTR part.)

Use the nn::ptm::CTR::Initialize and nn::ptm::CTR::Finalize functions to initialize and finalize the Pedometer library.

Classes

nn::pl::CTR::ResultIsWriting Indicates that step count data is currently being written. Try again in a little while.

Structures

nn::pl::CTR::PedometerMonthHeader Structure that holds the recorded year and month for step count entries.
nn::pl::CTR::PedometerHistoryHeader Structure that indicates the header information for step count data.
nn::pl::CTR::PedometerEntry The structure for the entry that indicates the year and month that step counts were recorded.

Enumerated Types

Shared Fonts
SharedFontType Indicates the type of shared font.
SharedFontLoadState Indicates the load state of the shared font.

typedef Definitions

Pedometer Library
PedometerMonthData Type that stores one month's worth of step counts.
PedometerHistoryData Type that stores all step count data (10 years' worth) stored by the Pedometer library.

Constants

Pedometer Library
MAX_MONTHDAYS const s32 The number of days saved in entries in a single month.
DAYHOURS const s32 The number of hours saved in entries in a single day.
NUM_FREESPACE const s32 Number of entries, used internally.
NUM_MONTHHISTORIES const s32 The maximum number of entries per month saved by the Pedometer library.
MAX_MONTHHISTORIES const s32 The internally saved number of entries per month.
NUM_MONTHHISTORYENTRIES const s32 The number of data instances saved per month.
INVALID_COUNTER const u16 A value that indicates an invalid entry.
Play Coins Library
MAX_GAME_COIN_COUNT const u16 The maximum number of Play Coins the user can own.

Functions

Pedometer Library
GetPedometerState Returns the status of the pedometer.
GetStepHistoryEntry Gets the entry information for the step counts recorded by the library.
GetStepHistory Gets the number of steps recorded for each hour.
GetTotalStepCount Gets the total number of steps.
GetStepHistoryAll Gets all step count data saved by the library.
Shared Fonts
InitializeSharedFont Enables use of shared font.
GetSharedFontAddress Gets the address of the shared font.
GetSharedFontSize Gets the size of the shared font.
GetSharedFontType Gets the type of the shared font.
GetSharedFontLoadState Gets the load state of the shared font.
MountSharedFont Mounts the archive of the shared font.
UnmountSharedFont Unmounts the archive of the shared font.
Play Coins Library
InitializeGameCoin Initializes the Play Coins library.
FinalizeGameCoin Finalizes the Play Coins library.
GetGameCoinCount Gets the current number of Play Coins owned.
UseGameCoin Consumes (spends) only the specified number of Play Coins.

Revision History

2011/08/19
Added description of the Play Coins library.
2010/11/16
Added description of how to initialize and finalize the Pedometer library.
2010/09/02
Initial version.

CONFIDENTIAL