Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating comments for CCFileUtils.

This commit is contained in:
James Chen 2013-01-28 23:28:14 +08:00
parent 2e421304ca
commit 341193eec6
1 changed files with 30 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
cocos2dx/platform/CCFileUtils.h
View File

@ -155,15 +155,24 @@ public:
*/
void loadFilenameLookupDictionaryFromFile(const char* filename);
/** Loads the filenameLookup dictionary from the contents of a filename.
@since v2.1
/**
* Sets the filenameLookup dictionary.
*
* @param pFilenameLookupDict The dictionary for replacing filename.
* @since v2.1
*/
void setFilenameLookupDictionary(CCDictionary* pFilenameLookupDict);
/// @cond
/**
* Gets full path from a file name and the path of the reletive file.
* @param pszFilename The file name.
* @param pszRelativeFile The path of the relative file.
* @return The full path.
* e.g. pszFilename: hello.png, pszRelativeFile: /User/path1/path2/hello.plist
* Return: /User/path1/path2/hello.pvr (If there are a key(hello.png)-value(hello.pvr) in FilenameLookup dictionary. )
*
*/
const char* fullPathFromRelativeFile(const char *pszFilename, const char *pszRelativeFile);
/// @endcond
/**
@brief Set the resource directory; we will find resources relative to this directory.
@ -173,24 +182,36 @@ public:
CC_DEPRECATED_ATTRIBUTE void setResourceDirectory(const char *pszDirectoryName);
/**
* Sets the array that contains the search order of the resources based for the device.
* Sets the array that contains the search order of the resources.
*
* @param searchResolutionsOrder The source array that contains the search order of the resources.
* @see getSearchResolutionsOrder().
* @since v2.1
*/
void setSearchResolutionsOrder(const std::vector<std::string>& searchResolutionsOrder);
/**
* Gets the array that contains the search order of the resources.
*
* @see setSearchResolutionsOrder().
* @since v2.1
*/
const std::vector<std::string>& getSearchResolutionsOrder();
/**
* Sets the array of search paths.
* You can use this array to modify the search path of the resources.
* If you want to use "themes" or search resources in the "cache", you can do it easily by adding new entries in this array.
*
* By default it is an array with only the "" (empty string) element.
*
*
* @param searchPaths
* @since v2.1
*/
void setSearchPath(const std::vector<std::string>& searchPaths);
/**
* Gets the array of search paths.
*
*/
const std::vector<std::string>& getSearchPath();
/**