Class CCFileUtils

#include <Geode/cocos/platform/CCFileUtils.h>
classCCFileUtils:publiccocos2d::TypeInfo{ ... }

Helper class to handle file operations

Examples0
Public static methods3
staticcocos2d::CCFileUtils*sharedFileUtils()

Gets the instance of CCFileUtils.

staticcocos2d::CCFileUtils*get()
No description provided
staticvoidpurgeFileUtils()

Destroys the instance of CCFileUtils.

Public member functions29
virtuallonggetClassTypeInfo()

Returns an unique ID for this class.

Return value
The unique ID for this class.

ℹ It's only used for JSBindings now.

virtualvoidpurgeCachedEntries()

Purges the file searching cache.

ℹ It should be invoked after the resources were updated. For instance, in the CocosPlayer sample, every time you run application from CocosBuilder, All the resources will be downloaded to the writable folder, before new js app launchs, this method should be invoked to clean the file search cache.

virtualuchar*getFileData(
charconst*pszFileName
,
charconst*pszMode
,)

Gets resource file data

Parameters

pszFileName

The resource file name which contains the path.

pszMode

The read mode of the file.

pSize

If the file read operation succeeds, it will be the data size, otherwise 0.
Return value
Upon success, a pointer to the data is returned, otherwise NULL.

⚠️ Recall: you are responsible for calling delete[] on any Non-NULL pointer returned.

virtualuchar*getFileDataFromZip(
charconst*pszZipFilePath
,
charconst*pszFileName
,)

Gets resource file data from a zip file.

Parameters

pszFileName

The resource file name which contains the relative path of the zip file.

pSize

If the file read operation succeeds, it will be the data size, otherwise 0.
Return value
Upon success, a pointer to the data is returned, otherwise NULL.

⚠️ Recall: you are responsible for calling delete[] on any Non-NULL pointer returned.

virtualgd::stringfullPathForFilename(
charconst*pszFileName
,)
No description provided
virtualvoidremoveFullPath()
No description provided
virtualvoidloadFilenameLookupDictionaryFromFile(
charconst*filename
)

Since v2.1

Loads the filenameLookup dictionary from the contents of a filename.

Parameters

filename

The plist file name.

ℹ The plist file name should follow the format below:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>filenames</key>
    <dict>
        <key>sounds/click.wav</key>
        <string>sounds/click.caf</string>
        <key>sounds/endgame.wav</key>
        <string>sounds/endgame.caf</string>
        <key>sounds/gem-0.wav</key>
        <string>sounds/gem-0.caf</string>
    </dict>
    <key>metadata</key>
    <dict>
        <key>version</key>
        <integer>1</integer>
    </dict>
</dict>
</plist>
virtualvoidsetFilenameLookupDictionary(
cocos2d::CCDictionary*pFilenameLookupDict
)

Since v2.1

Sets the filenameLookup dictionary.

Parameters

pFilenameLookupDict

The dictionary for replacing filename.
virtualcharconst*fullPathFromRelativeFile(
charconst*pszFilename
,
charconst*pszRelativeFile
)

Gets full path from a file name and the path of the reletive file.

Parameters

pszFilename

The file name.

pszRelativeFile

The path of the relative file.
Return value
The full path. e.g. pszFilename: hello.png, pszRelativeFile: /User/path1/path2/hello.plist Return: /User/path1/path2/hello.pvr (If there a a key(hello.png)-value(hello.pvr) in FilenameLookup dictionary. )
virtualvoidsetSearchResolutionsOrder(
std::vector<gd::string>const&searchResolutionsOrder
)

Since v2.1

Sets the array that contains the search order of the resources.

Parameters

searchResolutionsOrder

The source array that contains the search order of the resources.
virtualvoidaddSearchResolutionsOrder()

Since v2.1

Append search order of the resources.

virtualstd::vector<gd::string>const&getSearchResolutionsOrder()

Since v2.1

Gets the array that contains the search order of the resources.

virtualvoidsetSearchPaths(
std::vector<gd::string>const&searchPaths
)

Since v2.1

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.

Parameters

searchPaths

The array contains search paths.

ℹ This method could access relative path and absolute path. If the relative path was passed to the vector, CCFileUtils will add the default resource directory before the relative path. For instance: On Android, the default resource root path is "assets/". If "/mnt/sdcard/" and "resources-large" were set to the search paths vector, "resources-large" will be converted to "assets/resources-large" since it was a relative path.

voidaddTexturePack()

Add a texture pack. Texture packs are prioritized over other search paths, so if a texture pack has a replacement for a file, it will be used over others. Contrary to addSearchPath, this function adds the pack to the front of the list. If the pack has already been added, it’s moved to the front of the list (equivalent to removing and re-adding the pack)

Parameters

pack

Pack to add

ℹ Geode addition

voidremoveTexturePack()

Remove texture pack by ID

Parameters

id

ID of the texture pack

ℹ Geode addition

voidaddPriorityPath()

Add a search path to the front of the list

Parameters

path

Path to add

ℹ Geode addition

voidupdatePaths()

Update search path order; texture packs are added first, then other
paths

ℹ Geode addition

virtualvoidaddSearchPath()

Since v2.2

Adds a path to search paths.

virtualvoidremoveSearchPath()

Since v2.2

Removes a path from search paths.

voidremoveAllPaths()

Since v2.2

Removes all paths.

virtualstd::vector<gd::string>const&getSearchPaths()

Gets the array of search paths.

Return value
The array of search paths.
virtualgd::stringgetWritablePath()

Gets the writable path.

Return value
The path that can be write/read a file in
virtualgd::stringgetWritablePath2()
No description provided
virtualboolisFileExist(
gd::stringconst&strFilePath
)

Checks whether a file exists.

Parameters

strFilePath

The path of the file, it could be a relative or absolute path.
Return value
true if the file exists, otherwise it will return false.

ℹ If a relative path was passed in, it will be inserted a default root path at the beginning.

virtualboolisAbsolutePath()

Checks whether the path is an absolute path.

Parameters

strPath

The path that needs to be checked.
Return value
true if it's an absolute path, otherwise it will return false.

ℹ On Android, if the parameter passed in is relative to "assets/", this method will treat it as an absolute path. Also on Blackberry, path starts with "app/native/Resources/" is treated as an absolute path.

virtualvoidsetPopupNotify(
boolbNotify
)

Sets/Gets whether to pop-up a message box when failed to load an image.

virtualboolisPopupNotify()
No description provided
gd::stringgetAndroidPath()const
No description provided
voidsetAndroidPath()
No description provided
Fields0
Protected member functions9
virtualboolinit()

Initializes the instance of CCFileUtils. It will set m_searchPathArray and m_searchResolutionsOrderArray to default values.

Return value
true if successed, otherwise it returns false.

ℹ When you are porting Cocos2d-x to a new platform, you may need to take care of this method. You could assign a default value to m_strDefaultResRootPath in the subclass of CCFileUtils(e.g. CCFileUtilsAndroid). Then invoke the CCFileUtils::init().

virtualgd::stringgetNewFilename(
charconst*pszFileName
)

Gets the new filename from the filename lookup dictionary.

Parameters

pszFileName

The original filename.
Return value
The new filename after searching in the filename lookup dictionary. If the original filename wasn't in the dictionary, it will return the original filename.
virtualboolshouldUseHD()
No description provided
virtualgd::stringaddSuffix(,)
No description provided
virtualgd::stringgetPathForFilename(,
gd::stringconst&resolutionDirectory
,)

Gets full path for filename, resolution directory and search path.

Parameters

filename

The file name.

resolutionDirectory

The resolution directory.

searchPath

The search path.
Return value
The full path of the file. It will return an empty string if the full path of the file doesn't exist.
virtualgd::stringgetFullPathForDirectoryAndFilename(
gd::stringconst&strDirectory
,
gd::stringconst&strFilename
)

Gets full path for the directory and the filename.

Parameters

strDirectory

The directory contains the file we are looking for.

strFilename

The name of the file.
Return value
The full path of the file, if the file can't be found, it will return an empty string.

ℹ Only iOS and Mac need to override this method since they are using `[[NSBundle mainBundle] pathForResource: ofType: inDirectory:]` to make a full path. Other platforms will use the default implementation of this method.

virtualcocos2d::CCDictionary*createCCDictionaryWithContentsOfFile()

Creates a dictionary by the contents of a file.

ℹ This method is used internally.

virtualboolwriteToFile(,)

Write a dictionary to a plist file.

ℹ This method is used internally.

virtualcocos2d::CCArray*createCCArrayWithContentsOfFile()

Creates an array by the contents of a file.

ℹ This method is used internally.

Protected fields5
cocos2d::CCDictionary*m_pFilenameLookupDict
;

Since v2.1

Dictionary used to lookup filenames based on a key. It is used internally by the following methods:

gd::string fullPathForFilename(const char*);

std::vector<gd::string>m_searchResolutionsOrderArray
;

The vector contains resolution folders. The lower index of the element in this vector, the higher priority for this resolution directory.

std::vector<gd::string>m_searchPathArray
;

The vector contains search paths. The lower index of the element in this vector, the higher priority for this search path.

gd::stringm_strDefaultResRootPath
;

The default root path of resources. If the default root path of resources needs to be changed, do it in the init method of CCFileUtils’s subclass. For instance: On Android, the default root path of resources will be assigned with “assets/” in CCFileUtilsAndroid::init(). Similarly on Blackberry, we assign “app/native/Resources/” to this variable in CCFileUtilsBlackberry::init().

;

The full path cache. When a file is found, it will be added into this cache. This variable is used for improving the performance of file search.