cocos2d-x  2.2
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
CCUserDefault Class Reference

CCUserDefault acts as a tiny database. More...

#include <CCUserDefault.h>

Public Member Functions

 ~CCUserDefault ()
bool getBoolForKey (const char *pKey)
 Get bool value by key, if the key doesn't exist, a default value will return. More...
 
bool getBoolForKey (const char *pKey, bool defaultValue)
int getIntegerForKey (const char *pKey)
 Get integer value by key, if the key doesn't exist, a default value will return. More...
 
int getIntegerForKey (const char *pKey, int defaultValue)
float getFloatForKey (const char *pKey)
 Get float value by key, if the key doesn't exist, a default value will return. More...
 
float getFloatForKey (const char *pKey, float defaultValue)
double getDoubleForKey (const char *pKey)
 Get double value by key, if the key doesn't exist, a default value will return. More...
 
double getDoubleForKey (const char *pKey, double defaultValue)
std::string getStringForKey (const char *pKey)
 Get string value by key, if the key doesn't exist, a default value will return. More...
 
std::string getStringForKey (const char *pKey, const std::string &defaultValue)
void setBoolForKey (const char *pKey, bool value)
 Set bool value by key. More...
 
void setIntegerForKey (const char *pKey, int value)
 Set integer value by key. More...
 
void setFloatForKey (const char *pKey, float value)
 Set float value by key. More...
 
void setDoubleForKey (const char *pKey, double value)
 Set double value by key. More...
 
void setStringForKey (const char *pKey, const std::string &value)
 Set string value by key. More...
 
void flush ()
 Save content to xml file. More...
 

Static Public Member Functions

static CCUserDefaultsharedUserDefault ()
static void purgeSharedUserDefault ()
static const std::string & getXMLFilePath ()
static bool isXMLFileExist ()

Detailed Description

CCUserDefault acts as a tiny database.

You can save and get base type values by it. For example, setBoolForKey("played", true) will add a bool value true into the database. Its key is "played". You can get the value of the key by getBoolForKey("played").

It supports the following base types: bool, int, float, double, string

Constructor & Destructor Documentation

Member Function Documentation

void flush ( )

Save content to xml file.

bool getBoolForKey ( const char *  pKey)

Get bool value by key, if the key doesn't exist, a default value will return.

You can set the default value, or it is false.

bool getBoolForKey ( const char *  pKey,
bool  defaultValue 
)
double getDoubleForKey ( const char *  pKey)

Get double value by key, if the key doesn't exist, a default value will return.

You can set the default value, or it is 0.0.

double getDoubleForKey ( const char *  pKey,
double  defaultValue 
)
float getFloatForKey ( const char *  pKey)

Get float value by key, if the key doesn't exist, a default value will return.

You can set the default value, or it is 0.0f.

float getFloatForKey ( const char *  pKey,
float  defaultValue 
)
int getIntegerForKey ( const char *  pKey)

Get integer value by key, if the key doesn't exist, a default value will return.

You can set the default value, or it is 0.

int getIntegerForKey ( const char *  pKey,
int  defaultValue 
)
std::string getStringForKey ( const char *  pKey)

Get string value by key, if the key doesn't exist, a default value will return.

You can set the default value, or it is "".

std::string getStringForKey ( const char *  pKey,
const std::string &  defaultValue 
)
static const std::string&
getXMLFilePath
( )
static
static bool isXMLFileExist ( )
static
static void purgeSharedUserDefault ( )
static
void setBoolForKey ( const char *  pKey,
bool  value 
)

Set bool value by key.

void setDoubleForKey ( const char *  pKey,
double  value 
)

Set double value by key.

void setFloatForKey ( const char *  pKey,
float  value 
)

Set float value by key.

void setIntegerForKey ( const char *  pKey,
int  value 
)

Set integer value by key.

void setStringForKey ( const char *  pKey,
const std::string &  value 
)

Set string value by key.

static CCUserDefault*
sharedUserDefault
( )
static

The documentation for this class was generated from the following file: