2014-03-10 14:04:58 +08:00
--------------------------------
-- @module UserDefault
2014-07-02 10:15:26 +08:00
-- @parent_module cc
2014-03-18 15:55:30 +08:00
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- Set integer value by key.<br>
-- param key The key to set.<br>
-- param value A integer value to set to the key.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] setIntegerForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #int value
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
2015-07-06 18:37:24 +08:00
--------------------------------
-- delete any value by key,<br>
-- param key The key to delete value.<br>
-- js NA
-- @function [parent=#UserDefault] deleteValueForKey
-- @param self
-- @param #char key
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, char, float
-- @overload self, char
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] getFloatForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #float defaultValue
2014-10-17 22:56:22 +08:00
-- @return float#float ret (return value: float)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, char, bool
-- @overload self, char
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] getBoolForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #bool defaultValue
2014-10-17 22:56:22 +08:00
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- Set double value by key.<br>
-- param key The key to set.<br>
-- param value A double value to set to the key.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] setDoubleForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #double value
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- Set float value by key.<br>
-- param key The key to set.<br>
-- param value A float value to set to the key.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] setFloatForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #float value
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, char, string
-- @overload self, char
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] getStringForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #string defaultValue
2014-10-17 22:56:22 +08:00
-- @return string#string ret (return value: string)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- Set string value by key.<br>
-- param key The key to set.<br>
-- param value A string value to set to the key.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] setStringForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #string value
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- You should invoke this function to save values set by setXXXForKey().<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] flush
-- @param self
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, char, int
-- @overload self, char
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] getIntegerForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #int defaultValue
2014-10-17 22:56:22 +08:00
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-07-17 10:28:34 +08:00
-- @overload self, char, double
-- @overload self, char
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] getDoubleForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #double defaultValue
2014-10-17 22:56:22 +08:00
-- @return double#double ret (return value: double)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- Set bool value by key.<br>
-- param key The key to set.<br>
-- param value A bool value to set to the key.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] setBoolForKey
-- @param self
2015-03-19 11:55:42 +08:00
-- @param #char key
2014-09-02 13:45:07 +08:00
-- @param #bool value
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] destroyInstance
-- @param self
2015-01-21 17:33:26 +08:00
-- @return UserDefault#UserDefault self (return value: cc.UserDefault)
2014-03-10 14:04:58 +08:00
--------------------------------
2015-03-19 11:55:42 +08:00
-- All supported platforms other iOS & Android use xml file to save values. This function is return the file path of the xml path.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] getXMLFilePath
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
2015-05-22 10:04:38 +08:00
-- All supported platforms other iOS & Android and CC_PLATFORM_WINRT use xml file to save values. This function checks whether the xml file exists or not.<br>
2015-07-06 18:37:24 +08:00
-- return True if the xml file exists, false if not.<br>
2014-09-02 13:45:07 +08:00
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#UserDefault] isXMLFileExist
-- @param self
-- @return bool#bool ret (return value: bool)
return nil