Method scanDeclaredAssets

Engine/source/assets/assetManager.cpp:2391–2579

//-----------------------------------------------------------------------------

bool AssetManager::scanDeclaredAssets( const char* pPath, const char* pExtension, const bool recurse, ModuleDefinition* pModuleDefinition )
{
    // Debug Profiling.
    PROFILE_SCOPE(AssetManager_ScanDeclaredAssets);

    // Sanity!
    AssertFatal( pPath != NULL, "Cannot scan declared assets with NULL path." );
    AssertFatal( pExtension != NULL, "Cannot scan declared assets with NULL extension." );

    // Expand path location.
    String relativePath = Platform::makeRelativePathName(pPath, NULL);
    // Strip any trailing slash off the path.
    if (relativePath.endsWith("/"))
       relativePath = relativePath.substr(0, relativePath.length() - 1);

    Torque::Path scanPath = Torque::FS::GetCwd();
    scanPath.setPath(relativePath);

    // Find files.
    Vector<String> files;
    S32 numAssets = Torque::FS::FindByPattern(scanPath, pExtension, recurse, files, true);
    if (numAssets <= 0)
    {
        // Failed so warn. or don't... Common error when scanning modules with no assets
        //Con::warnf( "Asset Manager: No declared assets found in directory '%s'.", relativePath.c_str());
        return false;
    }

    // Is the asset file-path located within the specified module?
    if ( !Con::isBasePath(relativePath.c_str(), pModuleDefinition->getModulePath()) )
    {
        // No, so warn.
        Con::warnf( "Asset Manager: Could not add declared asset file '%s' as file does not exist with module path '%s'",
            pPath,
            pModuleDefinition->getModulePath() );
        return false;
    }

    // Info.
    if ( mEchoInfo )
    {
        Con::printSeparator();
        Con::printf( "Asset Manager: Scanning for declared assets in path '%s' for files with extension '%s'...", relativePath.c_str(), pExtension );
    }

    // Fetch module assets.
    ModuleDefinition::typeModuleAssetsVector& moduleAssets = pModuleDefinition->getModuleAssets();

    TamlAssetDeclaredVisitor assetDeclaredVisitor;

    // Iterate files.
    for (S32 i = 0; i < numAssets; ++i)
    {
        Torque::Path assetPath = files[i];

        // Clear declared assets.
        assetDeclaredVisitor.clear();