Torque3D Documentation / _generateds / assetManager_ScriptBinding.h

assetManager_ScriptBinding.h

Engine/source/assets/assetManager_ScriptBinding.h

More...

Public Functions

DefineEngineMethod(AssetManager , acquireAsset , String , (const char *assetId, bool asPrivate) , ("", false) , "Acquire the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "You must release the asset once you're finish with it using 'releaseAsset'.\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param asPrivate Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> acquire the asset Id as <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> private <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">asset.\n</a>" "@return The acquired asset or <a href="/coding/file/typesx86unix_8h/#typesx86unix_8h_1a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> not <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">acquired.\n</a>" )
DefineEngineMethod(AssetManager , addDeclaredAsset , bool , (const char *moduleDefinition, const char *assetFilePath) , ("", "") , "Add the specified asset against the specified module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition that may contain declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Whether adding declared assets was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , addModuleDeclaredAssets , bool , (const char *moduleDefinition) , ("") , "Add any the declared assets specified by the module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition specifies the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return Whether adding declared assets was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , addPrivateAsset , String , (const char *assetObject) , ("") , "Adds <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> private asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">object.\n</a>" "@param assetObject The asset object <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> add as <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> private <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">asset.\n</a>" "@return The allocated private asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , compileReferencedAssets , bool , (const char *moduleDefinition) , ("") , "Compile the referenced assets determined by the specified module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition specifies the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return Whether the compilation was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , deleteAsset , bool , (const char *assetId, bool deleteLooseFiles, bool deleteDependencies) , ("", false, false) , "Deletes the specified asset Id and optionally its loose files and asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">dependencies.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param deleteLooseFiles Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> delete an assets loose files or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param deleteDependencies Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> delete assets that depend on this asset or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@return Whether the asset deletion was successful or not. A failure only indicates that the specified asset was not deleted but dependent assets and their loose files may have being <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">deleted.\n</a>" )
DefineEngineMethod(AssetManager , dumpDeclaredAssets , void , () , "Dumps <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> breakdown of all declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )
DefineEngineMethod(AssetManager , findAllAssets , S32 , (const char *assetQuery, bool ignoreInternal, bool ignorePrivate) , ("", true, true) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> all assets optionally ignoring internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param ignoreInternal Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> ignore internal assets or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">true.\n</a>" "@param ignorePrivate Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> ignore private assets or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">true.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetAutoUnload , S32 , (const char *assetQuery, bool assetAutoUnload, bool assetQueryAsSource) , ("", false, false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset auto-unload <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">flag.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetInternal The asset internal flag <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetCategory , S32 , (const char *assetQuery, const char *assetCategory, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">category.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetCategory The asset category <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetDependsOn , S32 , (const char *assetQuery, const char *assetId) , ("", "") , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> asset Ids that the specified asset Id depends <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">on.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetId The asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> query <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> any asset Ids that it depends <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">on.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetInternal , S32 , (const char *assetQuery, bool assetInternal, bool assetQueryAsSource) , ("", false, false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">flag.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetInternal The asset internal flag <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetIsDependedOn , S32 , (const char *assetQuery, const char *assetId) , ("", "") , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> asset Ids that depend on the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetId The asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> query <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> any asset Ids that may depend on <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">it.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetLooseFile , S32 , (const char *assetQuery, const char *assetLooseFile, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified loose <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">file.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetLooseFile The loose-<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a> used by the asset <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetName , S32 , (const char *assetQuery, const char *assetName, bool partialName) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">name.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetName The asset name <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search for. This may be <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> partial name <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> 'partialName' is <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">true.\n</a>" "@param partialName Whether the asset name is <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> be used as <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> partial name or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetPrivate , S32 , (const char *assetQuery, bool assetPrivate, bool assetQueryAsSource) , ("", false, false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset private <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">flag.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetPrivate The asset private flag <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findAssetType , S32 , (const char *assetQuery, const char *assetType, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">type.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetType The asset type <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findInvalidAssetReferences , S32 , (const char *assetQuery) , ("") , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> invalid asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">references.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@return The number of asset Ids found that are invalid or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , findTaggedAssets , S32 , (const char *assetQuery, const char *assetTagNames, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset tag name(s).\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetTagNames The asset tag name or names <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search for. Multiple names can be specified using comma, space , tab or newline separation. Tags use an OR operation i.e. only assets tagged with ANY of the specified tags will be <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">returned.\n</a>" " @param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional:Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" " @return The number of asset Ids found or(-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )
DefineEngineMethod(AssetManager , getAssetCategory , String , (const char *assetId) , ("") , "Gets the asset category from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset category from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , getAssetDescription , String , (const char *assetId) , ("") , "Gets the asset description from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset description from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , getAssetFilePath , String , (const char *assetId) , ("") , "Gets the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a>-path from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a> - path from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , getAssetModule , String , (const char *assetId) , ("") , "Gets the module definition where the the specified asset Id is <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">located.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The module definition where the the specified asset Id is <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">located.\n</a>" )
DefineEngineMethod(AssetManager , getAssetName , String , (const char *assetId) , ("") , "Gets the asset name from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset name from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , getAssetPath , String , (const char *assetId) , ("") , "Gets the asset path (not including the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a>) from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset path(not including the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a>) from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , getAssetTags , S32 , () , "Gets the currently loaded asset tags <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return The currently loaded asset tags manifest or zero <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> not <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">loaded.\n</a>" )
DefineEngineMethod(AssetManager , getAssetType , String , (const char *assetId) , ("") , "Gets the asset type from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset type from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )
DefineEngineMethod(AssetManager , getDeclaredAssetCount , bool , () , "Gets the number of declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the number of declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )
DefineEngineMethod(AssetManager , getLoadedExternalAssetCount , bool , () , "Gets the number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )
DefineEngineMethod(AssetManager , getLoadedInternalAssetCount , bool , () , "Gets the number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )
DefineEngineMethod(AssetManager , getMaxLoadedExternalAssetCount , bool , () , "Gets the maximum number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the maximum number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )
DefineEngineMethod(AssetManager , getMaxLoadedInternalAssetCount , bool , () , "Gets the maximum number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the maximum number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )
DefineEngineMethod(AssetManager , getReferencedAssetCount , bool , () , "Gets the number of asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">referenced.\n</a>" "@return Returns the number of asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">references.\n</a>" )
DefineEngineMethod(AssetManager , isAssetAutoUnload , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is auto - unload or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is auto-unload or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , isAssetInternal , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is internal or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is internal or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , isAssetLoaded , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is loaded or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is loaded or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , isAssetPrivate , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is private or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is private or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , isDeclaredAsset , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is declared or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is declared or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , isReferencedAsset , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is referenced or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is referenced or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , purgeAssets , void , () , "Purge all assets that are not referenced even <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> they are set <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> not auto-<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">unload.\n</a>" "Assets can be in this state because they are either set <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> not auto-unload or the asset manager has/is disabling auto-<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">unload.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )
DefineEngineMethod(AssetManager , refreshAllAssets , void , (bool includeUnloaded) , (false) , "Refresh all declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@param Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> include currently unloaded assets in the refresh or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "Refreshing all assets can be an expensive (time-consuming) operation <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">perform.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )
DefineEngineMethod(AssetManager , refreshAsset , void , (const char *assetId) , ("") , "Refresh the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )
DefineEngineMethod(AssetManager , releaseAsset , bool , (const char *assetId) , ("") , "Release the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "The asset should have been acquired using 'acquireAsset'.\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the asset was released or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , removeDeclaredAsset , bool , (const char *assetId) , ("") , "Remove the specified declared asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether removing the declared asset was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , removeDeclaredAssets , bool , (const char *moduleDefinition) , ("") , "Remove any the declared assets specified by the module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition that may contain declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Whether removing declared assets was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , renameDeclaredAsset , bool , (const char *assetIdFrom, const char *assetIdTo) , ("", "") , "Rename declared asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">from.\n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">to.\n</a>" "@return Whether the rename was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , renameReferencedAsset , bool , (const char *assetIdFrom, const char *assetIdTo) , ("", "") , "Rename referenced asset Id. \<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">from.\n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">to.\n</a>" "@return Whether the rename was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , restoreAssetTags , bool , () , "Restore the currently loaded asset tags manifest from disk (replace anything in memory).\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@return Whether the restore was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )
DefineEngineMethod(AssetManager , saveAssetTags , bool , () , "Save the currently loaded asset tags <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return Whether the save was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

Detailed Description

Public Functions

DefineEngineMethod(AssetManager , acquireAsset , String , (const char *assetId, bool asPrivate) , ("", false) , "Acquire the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "You must release the asset once you're finish with it using 'releaseAsset'.\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param asPrivate Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> acquire the asset Id as <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> private <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">asset.\n</a>" "@return The acquired asset or <a href="/coding/file/typesx86unix_8h/#typesx86unix_8h_1a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> not <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">acquired.\n</a>" )

DefineEngineMethod(AssetManager , addDeclaredAsset , bool , (const char *moduleDefinition, const char *assetFilePath) , ("", "") , "Add the specified asset against the specified module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition that may contain declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Whether adding declared assets was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , addModuleDeclaredAssets , bool , (const char *moduleDefinition) , ("") , "Add any the declared assets specified by the module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition specifies the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return Whether adding declared assets was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , addPrivateAsset , String , (const char *assetObject) , ("") , "Adds <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> private asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">object.\n</a>" "@param assetObject The asset object <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> add as <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> private <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">asset.\n</a>" "@return The allocated private asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , compileReferencedAssets , bool , (const char *moduleDefinition) , ("") , "Compile the referenced assets determined by the specified module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition specifies the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return Whether the compilation was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , deleteAsset , bool , (const char *assetId, bool deleteLooseFiles, bool deleteDependencies) , ("", false, false) , "Deletes the specified asset Id and optionally its loose files and asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">dependencies.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param deleteLooseFiles Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> delete an assets loose files or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param deleteDependencies Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> delete assets that depend on this asset or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@return Whether the asset deletion was successful or not. A failure only indicates that the specified asset was not deleted but dependent assets and their loose files may have being <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">deleted.\n</a>" )

DefineEngineMethod(AssetManager , dumpDeclaredAssets , void , () , "Dumps <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> breakdown of all declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )

DefineEngineMethod(AssetManager , findAllAssets , S32 , (const char *assetQuery, bool ignoreInternal, bool ignorePrivate) , ("", true, true) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> all assets optionally ignoring internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param ignoreInternal Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> ignore internal assets or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">true.\n</a>" "@param ignorePrivate Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> ignore private assets or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">true.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetAutoUnload , S32 , (const char *assetQuery, bool assetAutoUnload, bool assetQueryAsSource) , ("", false, false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset auto-unload <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">flag.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetInternal The asset internal flag <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetCategory , S32 , (const char *assetQuery, const char *assetCategory, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">category.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetCategory The asset category <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetDependsOn , S32 , (const char *assetQuery, const char *assetId) , ("", "") , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> asset Ids that the specified asset Id depends <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">on.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetId The asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> query <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> any asset Ids that it depends <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">on.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetInternal , S32 , (const char *assetQuery, bool assetInternal, bool assetQueryAsSource) , ("", false, false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">flag.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetInternal The asset internal flag <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetIsDependedOn , S32 , (const char *assetQuery, const char *assetId) , ("", "") , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> asset Ids that depend on the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetId The asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> query <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> any asset Ids that may depend on <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">it.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetLooseFile , S32 , (const char *assetQuery, const char *assetLooseFile, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified loose <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">file.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetLooseFile The loose-<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a> used by the asset <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetName , S32 , (const char *assetQuery, const char *assetName, bool partialName) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">name.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetName The asset name <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search for. This may be <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> partial name <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> 'partialName' is <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">true.\n</a>" "@param partialName Whether the asset name is <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> be used as <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> partial name or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetPrivate , S32 , (const char *assetQuery, bool assetPrivate, bool assetQueryAsSource) , ("", false, false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset private <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">flag.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetPrivate The asset private flag <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findAssetType , S32 , (const char *assetQuery, const char *assetType, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">type.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetType The asset type <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">for.\n</a>" "@param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "@return The number of asset Ids found or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findInvalidAssetReferences , S32 , (const char *assetQuery) , ("") , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> invalid asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">references.\n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@return The number of asset Ids found that are invalid or (-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , findTaggedAssets , S32 , (const char *assetQuery, const char *assetTagNames, bool assetQueryAsSource) , ("", "", false) , "Performs an asset query searching <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> the specified asset tag name(s).\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetQuery The asset query object that will be populated with the <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">results.\n</a>" "@param assetTagNames The asset tag name or names <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> search for. Multiple names can be specified using comma, space , tab or newline separation. Tags use an OR operation i.e. only assets tagged with ANY of the specified tags will be <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">returned.\n</a>" " @param assetQueryAsSource Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> use the asset query as the data-<a href="/coding/file/pointer_8h/#pointer_8h_1adb82dfe18535e9a30aa97d275f82bd55">source</a> rather than the asset managers database or not. Doing this effectively filters the asset query. Optional:Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" " @return The number of asset Ids found or(-1) <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> an error <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">occurred.\n</a>" )

DefineEngineMethod(AssetManager , getAssetCategory , String , (const char *assetId) , ("") , "Gets the asset category from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset category from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , getAssetDescription , String , (const char *assetId) , ("") , "Gets the asset description from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset description from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , getAssetFilePath , String , (const char *assetId) , ("") , "Gets the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a>-path from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a> - path from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , getAssetModule , String , (const char *assetId) , ("") , "Gets the module definition where the the specified asset Id is <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">located.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The module definition where the the specified asset Id is <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">located.\n</a>" )

DefineEngineMethod(AssetManager , getAssetName , String , (const char *assetId) , ("") , "Gets the asset name from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset name from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , getAssetPath , String , (const char *assetId) , ("") , "Gets the asset path (not including the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a>) from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset path(not including the asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a702945180aa732857b380a007a7e2a21">file</a>) from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , getAssetTags , S32 , () , "Gets the currently loaded asset tags <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return The currently loaded asset tags manifest or zero <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> not <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">loaded.\n</a>" )

DefineEngineMethod(AssetManager , getAssetType , String , (const char *assetId) , ("") , "Gets the asset type from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return The asset type from the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" )

DefineEngineMethod(AssetManager , getDeclaredAssetCount , bool , () , "Gets the number of declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the number of declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )

DefineEngineMethod(AssetManager , getLoadedExternalAssetCount , bool , () , "Gets the number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )

DefineEngineMethod(AssetManager , getLoadedInternalAssetCount , bool , () , "Gets the number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )

DefineEngineMethod(AssetManager , getMaxLoadedExternalAssetCount , bool , () , "Gets the maximum number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the maximum number of loaded external <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )

DefineEngineMethod(AssetManager , getMaxLoadedInternalAssetCount , bool , () , "Gets the maximum number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Returns the maximum number of loaded internal <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" )

DefineEngineMethod(AssetManager , getReferencedAssetCount , bool , () , "Gets the number of asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">referenced.\n</a>" "@return Returns the number of asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">references.\n</a>" )

DefineEngineMethod(AssetManager , isAssetAutoUnload , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is auto - unload or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is auto-unload or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , isAssetInternal , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is internal or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is internal or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , isAssetLoaded , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is loaded or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is loaded or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , isAssetPrivate , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is private or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is private or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , isDeclaredAsset , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is declared or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is declared or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , isReferencedAsset , bool , (const char *assetId) , ("") , "Check whether the specified asset Id is referenced or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the specified asset Id is referenced or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , purgeAssets , void , () , "Purge all assets that are not referenced even <a href="/coding/file/tsmeshintrinsics_8cpp/#tsmeshintrinsics_8cpp_1a4e4fa7e3399708e0777b5308db01278c">if</a> they are set <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> not auto-<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">unload.\n</a>" "Assets can be in this state because they are either set <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> not auto-unload or the asset manager has/is disabling auto-<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">unload.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )

DefineEngineMethod(AssetManager , refreshAllAssets , void , (bool includeUnloaded) , (false) , "Refresh all declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@param Whether <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> include currently unloaded assets in the refresh or not. Optional: Defaults <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">false.\n</a>" "Refreshing all assets can be an expensive (time-consuming) operation <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">perform.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )

DefineEngineMethod(AssetManager , refreshAsset , void , (const char *assetId) , ("") , "Refresh the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return No return <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">value.\n</a>" )

DefineEngineMethod(AssetManager , releaseAsset , bool , (const char *assetId) , ("") , "Release the specified asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "The asset should have been acquired using 'acquireAsset'.\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether the asset was released or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , removeDeclaredAsset , bool , (const char *assetId) , ("") , "Remove the specified declared asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetId The selected asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@return Whether removing the declared asset was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , removeDeclaredAssets , bool , (const char *moduleDefinition) , ("") , "Remove any the declared assets specified by the module <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">definition.\n</a>" "@param moduleDefinition The module definition that may contain declared <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">assets.\n</a>" "@return Whether removing declared assets was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , renameDeclaredAsset , bool , (const char *assetIdFrom, const char *assetIdTo) , ("", "") , "Rename declared asset <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Id.\n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">from.\n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">to.\n</a>" "@return Whether the rename was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , renameReferencedAsset , bool , (const char *assetIdFrom, const char *assetIdTo) , ("", "") , "Rename referenced asset Id. \<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">from.\n</a>" "@param assetIdFrom The selected asset Id <a href="/coding/file/cmdgram_8cpp/#cmdgram_8cpp_1a5bafda9519252aa2d0fd038153f77dca">to</a> rename <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">to.\n</a>" "@return Whether the rename was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , restoreAssetTags , bool , () , "Restore the currently loaded asset tags manifest from disk (replace anything in memory).\<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">n</a>" "@return Whether the restore was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

DefineEngineMethod(AssetManager , saveAssetTags , bool , () , "Save the currently loaded asset tags <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">manifest.\n</a>" "@return Whether the save was successful or <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">not.\n</a>" )

  1
  2//-----------------------------------------------------------------------------
  3// Copyright (c) 2013 GarageGames, LLC
  4//
  5// Permission is hereby granted, free of charge, to any person obtaining a copy
  6// of this software and associated documentation files (the "Software"), to
  7// deal in the Software without restriction, including without limitation the
  8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  9// sell copies of the Software, and to permit persons to whom the Software is
 10// furnished to do so, subject to the following conditions:
 11//
 12// The above copyright notice and this permission notice shall be included in
 13// all copies or substantial portions of the Software.
 14//
 15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 21// IN THE SOFTWARE.
 22//-----------------------------------------------------------------------------
 23#include "console/engineAPI.h"
 24#include "assetBase.h"
 25#include "assetManager.h"
 26#include "module/moduleDefinition.h"
 27#include "console/sim.h"
 28
 29DefineEngineMethod(AssetManager, compileReferencedAssets, bool, (const char* moduleDefinition), (""),
 30   "Compile the referenced assets determined by the specified module definition.\n"
 31   "@param moduleDefinition The module definition specifies the asset manifest.\n"
 32   "@return Whether the compilation was successful or not.\n")
 33{
 34    // Fetch module definition.
 35   ModuleDefinition* pModuleDefinition;
 36   Sim::findObject(moduleDefinition, pModuleDefinition);
 37
 38    // Did we find the module definition?
 39    if ( pModuleDefinition == NULL )
 40    {
 41        // No, so warn.
 42       Con::warnf("AssetManager::compileReferencedAssets() - Could not find the module definition '%s'.", moduleDefinition);
 43        return false;
 44    }
 45
 46    // Compile referenced assets.
 47    return object->compileReferencedAssets( pModuleDefinition );
 48}
 49
 50//-----------------------------------------------------------------------------
 51
 52DefineEngineMethod(AssetManager, addModuleDeclaredAssets, bool, (const char* moduleDefinition), (""),
 53   "Add any the declared assets specified by the module definition.\n"
 54   "@param moduleDefinition The module definition specifies the asset manifest.\n"
 55   "@return Whether adding declared assets was successful or not.\n")
 56{
 57   // Fetch module definition.
 58   ModuleDefinition* pModuleDefinition;
 59   Sim::findObject(moduleDefinition, pModuleDefinition);
 60
 61    // Did we find the module definition?
 62    if ( pModuleDefinition == NULL )
 63    {
 64        // No, so warn.
 65       Con::warnf("AssetManager::addDeclaredAssets() - Could not find the module definition '%s'.", moduleDefinition);
 66        return false;
 67    }
 68
 69    // Add module declared assets.
 70    return object->addModuleDeclaredAssets( pModuleDefinition );
 71}
 72
 73//-----------------------------------------------------------------------------
 74
 75DefineEngineMethod(AssetManager, addDeclaredAsset, bool, (const char* moduleDefinition, const char* assetFilePath), ("", ""),
 76   "Add the specified asset against the specified module definition.\n"
 77   "@param moduleDefinition The module definition that may contain declared assets.\n"
 78   "@return Whether adding declared assets was successful or not.\n")
 79{
 80   // Fetch module definition.
 81   ModuleDefinition* pModuleDefinition;
 82   Sim::findObject(moduleDefinition, pModuleDefinition);
 83
 84    // Did we find the module definition?
 85    if ( pModuleDefinition == NULL )
 86    {
 87        // No, so warn.
 88       Con::warnf("AssetManager::addDeclaredAsset() - Could not find the module definition '%s'.", moduleDefinition);
 89        return false;
 90    }
 91
 92    // Fetch asset file-path.
 93    const char* pAssetFilePath = assetFilePath;
 94
 95    // Add declared asset.
 96    return object->addDeclaredAsset( pModuleDefinition, pAssetFilePath );
 97}
 98
 99//-----------------------------------------------------------------------------
100
101DefineEngineMethod(AssetManager, addPrivateAsset, String, (const char* assetObject), (""),
102   "Adds a private asset object.\n"
103   "@param assetObject The asset object to add as a private asset.\n"
104   "@return The allocated private asset Id.\n")
105{
106    // Fetch asset.
107   AssetBase* pAssetBase;
108   Sim::findObject(assetObject, pAssetBase);
109
110    // Did we find the asset?
111    if ( pAssetBase == NULL )
112    {
113        // No, so warn.
114       Con::warnf("AssetManager::addPrivateAsset() - Could not find the asset '%s'.", assetObject);
115        return StringTable->EmptyString();
116    }
117
118    // Add private asset.
119    return object->addPrivateAsset( pAssetBase );
120}
121
122//-----------------------------------------------------------------------------
123
124DefineEngineMethod(AssetManager, removeDeclaredAssets, bool, (const char* moduleDefinition), (""),
125   "Remove any the declared assets specified by the module definition.\n"
126   "@param moduleDefinition The module definition that may contain declared assets.\n"
127   "@return Whether removing declared assets was successful or not.\n")
128{
129    // Fetch module definition.
130   ModuleDefinition* pModuleDefinition;
131   Sim::findObject(moduleDefinition, pModuleDefinition);
132
133    // Did we find the module definition?
134    if ( pModuleDefinition == NULL )
135    {
136        // No, so warn.
137       Con::warnf("AssetManager::removeDeclaredAssets() - Could not find the module definition '%s'.", moduleDefinition);
138        return false;
139    }
140
141    // Remove declared assets.
142    return object->removeDeclaredAssets( pModuleDefinition );
143}
144
145//-----------------------------------------------------------------------------
146
147DefineEngineMethod(AssetManager, removeDeclaredAsset, bool, (const char* assetId), (""),
148   "Remove the specified declared asset Id.\n"
149   "@param assetId The selected asset Id.\n"
150   "@return Whether removing the declared asset was successful or not.\n")
151{
152    // Remove the declared asset Id.
153   return object->removeDeclaredAsset(assetId);
154}
155
156//-----------------------------------------------------------------------------
157
158DefineEngineMethod(AssetManager, getAssetName, String, (const char* assetId), (""),
159   "Gets the asset name from the specified asset Id.\n"
160   "@param assetId The selected asset Id.\n"
161   "@return The asset name from the specified asset Id.\n")
162{
163   return object->getAssetName(assetId);
164}
165
166//-----------------------------------------------------------------------------
167
168DefineEngineMethod(AssetManager, getAssetDescription, String, (const char* assetId), (""),
169   "Gets the asset description from the specified asset Id.\n"
170   "@param assetId The selected asset Id.\n"
171   "@return The asset description from the specified asset Id.\n")
172{
173   return object->getAssetDescription(assetId);
174}
175
176//-----------------------------------------------------------------------------
177
178DefineEngineMethod(AssetManager, getAssetCategory, String, (const char* assetId), (""),
179   "Gets the asset category from the specified asset Id.\n"
180   "@param assetId The selected asset Id.\n"
181   "@return The asset category from the specified asset Id.\n")
182{
183   return object->getAssetCategory(assetId);
184}
185
186//-----------------------------------------------------------------------------
187
188DefineEngineMethod(AssetManager, getAssetType, String, (const char* assetId), (""),
189   "Gets the asset type from the specified asset Id.\n"
190   "@param assetId The selected asset Id.\n"
191   "@return The asset type from the specified asset Id.\n")
192{
193   return object->getAssetType(assetId);
194}
195
196//-----------------------------------------------------------------------------
197
198DefineEngineMethod(AssetManager, getAssetFilePath, String, (const char* assetId), (""),
199   "Gets the asset file-path from the specified asset Id.\n"
200   "@param assetId The selected asset Id.\n"
201   "@return The asset file - path from the specified asset Id.\n")
202{
203   return object->getAssetFilePath(assetId);
204}
205
206//-----------------------------------------------------------------------------
207
208DefineEngineMethod(AssetManager, getAssetPath, String, (const char* assetId), (""),
209   "Gets the asset path (not including the asset file) from the specified asset Id.\n"
210   "@param assetId The selected asset Id.\n"
211   "@return The asset path(not including the asset file) from the specified asset Id.\n")
212{
213   return object->getAssetPath(assetId);
214}
215
216//-----------------------------------------------------------------------------
217
218DefineEngineMethod(AssetManager, getAssetModule, String, (const char* assetId), (""),
219   "Gets the module definition where the the specified asset Id is located.\n"
220   "@param assetId The selected asset Id.\n"
221   "@return The module definition where the the specified asset Id is located.\n")
222{
223    // Fetch module definition.
224   ModuleDefinition* pModuleDefinition = object->getAssetModuleDefinition(assetId);
225
226    return pModuleDefinition == NULL ? StringTable->EmptyString() : pModuleDefinition->getIdString();
227}
228
229//-----------------------------------------------------------------------------
230
231DefineEngineMethod(AssetManager, isAssetInternal, bool, (const char* assetId), (""),
232   "Check whether the specified asset Id is internal or not.\n"
233   "@param assetId The selected asset Id.\n"
234   "@return Whether the specified asset Id is internal or not.\n")
235{
236   return object->isAssetInternal(assetId);
237}
238
239//-----------------------------------------------------------------------------
240
241DefineEngineMethod(AssetManager, isAssetPrivate, bool, (const char* assetId), (""),
242   "Check whether the specified asset Id is private or not.\n"
243   "@param assetId The selected asset Id.\n"
244   "@return Whether the specified asset Id is private or not.\n")
245{
246   return object->isAssetPrivate(assetId);
247}
248
249//-----------------------------------------------------------------------------
250
251DefineEngineMethod(AssetManager, isAssetAutoUnload, bool, (const char* assetId), (""),
252   "Check whether the specified asset Id is auto - unload or not.\n"
253   "@param assetId The selected asset Id.\n"
254   "@return Whether the specified asset Id is auto-unload or not.\n")
255{
256   return object->isAssetAutoUnload(assetId);
257}
258
259//-----------------------------------------------------------------------------
260
261DefineEngineMethod(AssetManager, isAssetLoaded, bool, (const char* assetId), (""),
262   "Check whether the specified asset Id is loaded or not.\n"
263   "@param assetId The selected asset Id.\n"
264   "@return Whether the specified asset Id is loaded or not.\n")
265{
266   return object->isAssetLoaded(assetId);
267}
268
269//-----------------------------------------------------------------------------
270
271DefineEngineMethod(AssetManager, isDeclaredAsset, bool, (const char* assetId), (""),
272   "Check whether the specified asset Id is declared or not.\n"
273   "@param assetId The selected asset Id.\n"
274   "@return Whether the specified asset Id is declared or not.\n")
275{
276   return object->isDeclaredAsset(assetId);
277}
278
279//-----------------------------------------------------------------------------
280
281DefineEngineMethod(AssetManager, isReferencedAsset, bool, (const char* assetId), (""),
282   "Check whether the specified asset Id is referenced or not.\n"
283   "@param assetId The selected asset Id.\n"
284   "@return Whether the specified asset Id is referenced or not.\n")
285{
286   return object->isReferencedAsset(assetId);
287}
288
289//-----------------------------------------------------------------------------
290
291DefineEngineMethod(AssetManager, renameDeclaredAsset, bool, (const char* assetIdFrom, const char* assetIdTo), ("", ""),
292   "Rename declared asset Id.\n"
293   "@param assetIdFrom The selected asset Id to rename from.\n"
294   "@param assetIdFrom The selected asset Id to rename to.\n"
295   "@return Whether the rename was successful or not.\n")
296{
297   return object->renameDeclaredAsset(assetIdFrom, assetIdTo);
298}
299
300//-----------------------------------------------------------------------------
301
302DefineEngineMethod(AssetManager, renameReferencedAsset, bool, (const char* assetIdFrom, const char* assetIdTo), ("", ""),
303   "Rename referenced asset Id. \n"
304   "@param assetIdFrom The selected asset Id to rename from.\n"
305   "@param assetIdFrom The selected asset Id to rename to.\n"
306   "@return Whether the rename was successful or not.\n")
307{
308   return object->renameReferencedAsset(assetIdFrom, assetIdTo);
309}
310
311//-----------------------------------------------------------------------------
312
313DefineEngineMethod(AssetManager, acquireAsset, String, (const char* assetId, bool asPrivate), ("", false),
314   "Acquire the specified asset Id.\n"
315   "You must release the asset once you're finish with it using 'releaseAsset'.\n"
316   "@param assetId The selected asset Id.\n"
317   "@param asPrivate Whether to acquire the asset Id as a private asset.\n"
318   "@return The acquired asset or NULL if not acquired.\n")
319{
320    // Fetch asset Id.
321   const char* pAssetId = assetId;
322
323    // Reset asset reference.
324    AssetBase* pAssetBase = NULL;
325
326    // Acquire private asset?
327    if ( asPrivate )
328    {
329        // Acquire private asset.
330        pAssetBase = object->acquireAsPrivateAsset<AssetBase>( pAssetId );
331    }
332    else
333    {
334        // Acquire public asset.
335        pAssetBase = object->acquireAsset<AssetBase>( pAssetId );
336    }
337
338    return pAssetBase != NULL ? pAssetBase->getIdString() : StringTable->EmptyString();
339}
340
341//-----------------------------------------------------------------------------
342
343DefineEngineMethod(AssetManager, releaseAsset, bool, (const char* assetId), (""),
344   "Release the specified asset Id.\n"
345   "The asset should have been acquired using 'acquireAsset'.\n"
346   "@param assetId The selected asset Id.\n"
347   "@return Whether the asset was released or not.\n")
348{
349    // Release asset.
350   return object->releaseAsset(assetId);
351}
352
353//-----------------------------------------------------------------------------
354
355DefineEngineMethod(AssetManager, purgeAssets, void, (),,
356   "Purge all assets that are not referenced even if they are set to not auto-unload.\n"
357   "Assets can be in this state because they are either set to not auto-unload or the asset manager has/is disabling auto-unload.\n"
358   "@return No return value.\n")
359{
360    // Purge assets.
361    object->purgeAssets();
362}
363
364//-----------------------------------------------------------------------------
365
366DefineEngineMethod(AssetManager, deleteAsset, bool, (const char* assetId, bool deleteLooseFiles, bool deleteDependencies), ("", false, false),
367   "Deletes the specified asset Id and optionally its loose files and asset dependencies.\n"
368   "@param assetId The selected asset Id.\n"
369   "@param deleteLooseFiles Whether to delete an assets loose files or not.\n"
370   "@param deleteDependencies Whether to delete assets that depend on this asset or not.\n"
371   "@return Whether the asset deletion was successful or not.  A failure only indicates that the specified asset was not deleted but dependent assets and their loose files may have being deleted.\n")
372{
373    // Fetch asset Id.
374   const char* pAssetId = assetId;
375
376    // Delete asset.
377    return object->deleteAsset( pAssetId, deleteLooseFiles, deleteDependencies );
378}
379
380//-----------------------------------------------------------------------------
381
382DefineEngineMethod(AssetManager, refreshAsset, void, (const char* assetId), (""),
383   "Refresh the specified asset Id.\n"
384   "@param assetId The selected asset Id.\n"
385   "@return No return value.\n")
386{
387   object->refreshAsset(assetId);
388}
389
390//-----------------------------------------------------------------------------
391
392DefineEngineMethod(AssetManager, refreshAllAssets, void, (bool includeUnloaded), (false),
393   "Refresh all declared assets.\n"
394   "@param Whether to include currently unloaded assets in the refresh or not.  Optional: Defaults to false.\n"
395   "Refreshing all assets can be an expensive (time-consuming) operation to perform.\n"
396   "@return No return value.\n")
397{
398    // Refresh assets
399    object->refreshAllAssets(includeUnloaded);
400}
401
402//-----------------------------------------------------------------------------
403
404DefineEngineMethod(AssetManager, saveAssetTags, bool, (),,
405   "Save the currently loaded asset tags manifest.\n"
406   "@return Whether the save was successful or not.\n")
407{
408    // Save asset tags.
409    return object->saveAssetTags();
410}
411
412//-----------------------------------------------------------------------------
413
414DefineEngineMethod(AssetManager, restoreAssetTags, bool, (),,
415   "Restore the currently loaded asset tags manifest from disk (replace anything in memory).\n"
416   "@return Whether the restore was successful or not.\n")
417{
418    // Restore asset tags.
419    return object->restoreAssetTags();
420}
421
422//-----------------------------------------------------------------------------
423
424DefineEngineMethod(AssetManager, getAssetTags, S32, (), ,
425   "Gets the currently loaded asset tags manifest.\n"
426   "@return The currently loaded asset tags manifest or zero if not loaded.\n")
427{
428    // Fetch the asset tags manifest.
429    AssetTagsManifest* pAssetTagsManifest = object->getAssetTags();
430
431    return pAssetTagsManifest == NULL ? 0 : pAssetTagsManifest->getId();
432}
433
434//-----------------------------------------------------------------------------
435
436DefineEngineMethod(AssetManager, findAllAssets, S32, (const char* assetQuery, bool ignoreInternal, bool ignorePrivate), ("", true, true),
437   "Performs an asset query searching for all assets optionally ignoring internal assets.\n"
438   "@param assetQuery The asset query object that will be populated with the results.\n"
439   "@param ignoreInternal Whether to ignore internal assets or not.  Optional: Defaults to true.\n"
440   "@param ignorePrivate Whether to ignore private assets or not.  Optional: Defaults to true.\n"
441   "@return The number of asset Ids found or (-1) if an error occurred.\n")
442{
443   // Fetch asset query.
444   AssetQuery* pAssetQuery;
445   Sim::findObject(assetQuery, pAssetQuery);
446
447    // Did we find the asset query?
448    if ( pAssetQuery == NULL )
449    {
450        // No, so warn.
451       Con::warnf("AssetManager::findAllAssets() - Could not find the asset query object '%s'.", assetQuery);
452        return -1;
453    }
454
455    // Perform query.
456    return object->findAllAssets( pAssetQuery, ignoreInternal, ignorePrivate );
457}
458
459//-----------------------------------------------------------------------------
460
461DefineEngineMethod(AssetManager, findAssetName, S32, (const char* assetQuery, const char* assetName, bool partialName), ("", "", false),
462   "Performs an asset query searching for the specified asset name.\n"
463   "@param assetQuery The asset query object that will be populated with the results.\n"
464   "@param assetName The asset name to search for.  This may be a partial name if 'partialName' is true.\n"
465   "@param partialName Whether the asset name is to be used as a partial name or not.  Optional: Defaults to false.\n"
466   "@return The number of asset Ids found or (-1) if an error occurred.\n")
467{
468   // Fetch asset query.
469   AssetQuery* pAssetQuery;
470   Sim::findObject(assetQuery, pAssetQuery);
471
472    // Did we find the asset query?
473    if ( pAssetQuery == NULL )
474    {
475        // No, so warn.
476       Con::warnf("AssetManager::findAssetName() - Could not find the asset query object '%s'.", assetQuery);
477        return -1;
478    }
479
480    // Fetch asset name.
481    const char* pAssetName = assetName;
482
483    // Perform query.
484    return object->findAssetName( pAssetQuery, pAssetName, partialName );
485}
486
487//-----------------------------------------------------------------------------
488
489DefineEngineMethod(AssetManager, findAssetCategory, S32, (const char* assetQuery, const char* assetCategory, bool assetQueryAsSource), ("", "", false),
490   "Performs an asset query searching for the specified asset category.\n"
491   "@param assetQuery The asset query object that will be populated with the results.\n"
492   "@param assetCategory The asset category to search for.\n"
493   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
494   "@return The number of asset Ids found or (-1) if an error occurred.\n")
495{
496   // Fetch asset query.
497   AssetQuery* pAssetQuery;
498   Sim::findObject(assetQuery, pAssetQuery);
499
500    // Did we find the asset query?
501    if ( pAssetQuery == NULL )
502    {
503        // No, so warn.
504       Con::warnf("AssetManager::findAssetCategory() - Could not find the asset query object '%s'.", assetQuery);
505        return -1;
506    }
507
508    // Fetch asset category.
509    const char* pAssetCategory = assetCategory;
510
511    // Perform query.
512    return object->findAssetCategory( pAssetQuery, pAssetCategory, assetQueryAsSource );
513}
514
515//-----------------------------------------------------------------------------
516
517DefineEngineMethod(AssetManager, findAssetAutoUnload, S32, (const char* assetQuery, bool assetAutoUnload, bool assetQueryAsSource), ("", false, false),
518   "Performs an asset query searching for the specified asset auto-unload flag.\n"
519   "@param assetQuery The asset query object that will be populated with the results.\n"
520   "@param assetInternal The asset internal flag to search for.\n"
521   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
522   "@return The number of asset Ids found or (-1) if an error occurred.\n")
523{
524   // Fetch asset query.
525   AssetQuery* pAssetQuery;
526   Sim::findObject(assetQuery, pAssetQuery);
527
528    // Did we find the asset query?
529    if ( pAssetQuery == NULL )
530    {
531        // No, so warn.
532       Con::warnf("AssetManager::findAssetAutoUnload() - Could not find the asset query object '%s'.", assetQuery);
533        return -1;
534    }
535
536    // Perform query.
537    return object->findAssetAutoUnload( pAssetQuery, assetAutoUnload, assetQueryAsSource );
538}
539
540//-----------------------------------------------------------------------------
541
542DefineEngineMethod(AssetManager, findAssetInternal, S32, (const char* assetQuery, bool assetInternal, bool assetQueryAsSource), ("", false, false),
543   "Performs an asset query searching for the specified asset internal flag.\n"
544   "@param assetQuery The asset query object that will be populated with the results.\n"
545   "@param assetInternal The asset internal flag to search for.\n"
546   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
547   "@return The number of asset Ids found or (-1) if an error occurred.\n")
548{
549   // Fetch asset query.
550   AssetQuery* pAssetQuery;
551   Sim::findObject(assetQuery, pAssetQuery);
552
553    // Did we find the asset query?
554    if ( pAssetQuery == NULL )
555    {
556        // No, so warn.
557       Con::warnf("AssetManager::findAssetInternal() - Could not find the asset query object '%s'.", assetQuery);
558        return -1;
559    }
560
561    // Perform query.
562    return object->findAssetInternal( pAssetQuery, assetInternal, assetQueryAsSource );
563}
564
565//-----------------------------------------------------------------------------
566
567DefineEngineMethod(AssetManager, findAssetPrivate, S32, (const char* assetQuery, bool assetPrivate, bool assetQueryAsSource), ("", false, false),
568   "Performs an asset query searching for the specified asset private flag.\n"
569   "@param assetQuery The asset query object that will be populated with the results.\n"
570   "@param assetPrivate The asset private flag to search for.\n"
571   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
572   "@return The number of asset Ids found or (-1) if an error occurred.\n")
573{
574   // Fetch asset query.
575   AssetQuery* pAssetQuery;
576   Sim::findObject(assetQuery, pAssetQuery);
577
578    // Did we find the asset query?
579    if ( pAssetQuery == NULL )
580    {
581        // No, so warn.
582       Con::warnf("AssetManager::findAssetPrivate() - Could not find the asset query object '%s'.", assetQuery);
583        return -1;
584    }
585
586    // Perform query.
587    return object->findAssetInternal( pAssetQuery, assetPrivate, assetQueryAsSource );
588}
589
590//-----------------------------------------------------------------------------
591
592DefineEngineMethod(AssetManager, findAssetType, S32, (const char* assetQuery, const char* assetType, bool assetQueryAsSource), ("", "", false),
593   "Performs an asset query searching for the specified asset type.\n"
594   "@param assetQuery The asset query object that will be populated with the results.\n"
595   "@param assetType The asset type to search for.\n"
596   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
597   "@return The number of asset Ids found or (-1) if an error occurred.\n")
598{
599   // Fetch asset query.
600   AssetQuery* pAssetQuery;
601   Sim::findObject(assetQuery, pAssetQuery);
602
603    // Did we find the asset query?
604    if ( pAssetQuery == NULL )
605    {
606        // No, so warn.
607       Con::warnf("AssetManager::findAssetType() - Could not find the asset query object '%s'.", assetQuery);
608        return -1;
609    }
610
611    // Fetch asset type.
612    const char* pAssetType = assetType;
613
614    // Perform query.
615    return object->findAssetType( pAssetQuery, pAssetType, assetQueryAsSource );
616}
617
618//-----------------------------------------------------------------------------
619
620DefineEngineMethod(AssetManager, findAssetDependsOn, S32, (const char* assetQuery, const char* assetId), ("", ""),
621   "Performs an asset query searching for asset Ids that the specified asset Id depends on.\n"
622   "@param assetQuery The asset query object that will be populated with the results.\n"
623   "@param assetId The asset Id to query for any asset Ids that it depends on.\n"
624   "@return The number of asset Ids found or (-1) if an error occurred.\n")
625{
626   // Fetch asset query.
627   AssetQuery* pAssetQuery;
628   Sim::findObject(assetQuery, pAssetQuery);
629
630    // Did we find the asset query?
631    if ( pAssetQuery == NULL )
632    {
633        // No, so warn.
634       Con::warnf("AssetManager::findAssetDependsOn() - Could not find the asset query object '%s'.", assetQuery);
635        return -1;
636    }
637
638    // Fetch asset Id.
639    const char* pAssetId = assetId;
640
641    // Perform query.
642    return object->findAssetDependsOn( pAssetQuery, pAssetId );
643}
644
645//-----------------------------------------------------------------------------
646
647DefineEngineMethod(AssetManager, findAssetIsDependedOn, S32, (const char* assetQuery, const char* assetId), ("", ""),
648   "Performs an asset query searching for asset Ids that depend on the specified asset Id.\n"
649   "@param assetQuery The asset query object that will be populated with the results.\n"
650   "@param assetId The asset Id to query for any asset Ids that may depend on it.\n"
651   "@return The number of asset Ids found or (-1) if an error occurred.\n")
652{
653   // Fetch asset query.
654   AssetQuery* pAssetQuery;
655   Sim::findObject(assetQuery, pAssetQuery);
656
657    // Did we find the asset query?
658    if ( pAssetQuery == NULL )
659    {
660        // No, so warn.
661       Con::warnf("AssetManager::findAssetIsDependedOn() - Could not find the asset query object '%s'.", assetQuery);
662        return -1;
663    }
664
665    // Fetch asset Id.
666    const char* pAssetId = assetId;
667
668    // Perform query.
669    return object->findAssetIsDependedOn( pAssetQuery, pAssetId );
670}
671
672//-----------------------------------------------------------------------------
673
674DefineEngineMethod(AssetManager, findInvalidAssetReferences, S32, (const char* assetQuery), (""),
675   "Performs an asset query searching for invalid asset references.\n"
676   "@param assetQuery The asset query object that will be populated with the results.\n"
677   "@return The number of asset Ids found that are invalid or (-1) if an error occurred.\n")
678{
679   // Fetch asset query.
680   AssetQuery* pAssetQuery;
681   Sim::findObject(assetQuery, pAssetQuery);
682
683    // Did we find the asset query?
684    if ( pAssetQuery == NULL )
685    {
686        // No, so warn.
687       Con::warnf("AssetManager::findInvalidAssetReferences() - Could not find the asset query object '%s'.", assetQuery);
688        return -1;
689    }
690
691    // Perform query.
692    return object->findInvalidAssetReferences( pAssetQuery );
693}
694
695//-----------------------------------------------------------------------------
696
697DefineEngineMethod(AssetManager, findTaggedAssets, S32, (const char* assetQuery, const char* assetTagNames, bool assetQueryAsSource), ("", "", false),
698   "Performs an asset query searching for the specified asset tag name(s).\n"
699   "@param assetQuery The asset query object that will be populated with the results.\n"
700   "@param assetTagNames The asset tag name or names to search for.  Multiple names can be specified using comma, space, tab or newline separation.  Tags use an OR operation i.e. only assets tagged with ANY of the specified tags will be returned.\n"
701   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
702   "@return The number of asset Ids found or (-1) if an error occurred.\n")
703{
704   // Fetch asset query.
705   AssetQuery* pAssetQuery;
706   Sim::findObject(assetQuery, pAssetQuery);
707
708    // Did we find the asset query?
709    if ( pAssetQuery == NULL )
710    {
711        // No, so warn.
712       Con::warnf("AssetManager::findTaggedAssets() - Could not find the asset query object '%s'.", assetQuery);
713        return -1;
714    }
715
716    // Fetch asset tag name(s).
717    const char* pAssetTagNames = assetTagNames;
718
719    // Perform query.
720    return object->findTaggedAssets( pAssetQuery, pAssetTagNames, assetQueryAsSource );
721}
722
723//-----------------------------------------------------------------------------
724
725DefineEngineMethod(AssetManager, findAssetLooseFile, S32, (const char* assetQuery, const char* assetLooseFile, bool assetQueryAsSource), ("", "", false),
726   "Performs an asset query searching for the specified loose file.\n"
727   "@param assetQuery The asset query object that will be populated with the results.\n"
728   "@param assetLooseFile The loose-file used by the asset to search for.\n"
729   "@param assetQueryAsSource Whether to use the asset query as the data-source rather than the asset managers database or not.  Doing this effectively filters the asset query.  Optional: Defaults to false.\n"
730   "@return The number of asset Ids found or (-1) if an error occurred.\n")
731{
732   // Fetch asset query.
733   AssetQuery* pAssetQuery;
734   Sim::findObject(assetQuery, pAssetQuery);
735
736    // Did we find the asset query?
737    if ( pAssetQuery == NULL )
738    {
739        // No, so warn.
740       Con::warnf("AssetManager::findAssetLooseFile() - Could not find the asset query object '%s'.", assetQuery);
741        return -1;
742    }
743
744    // Fetch asset loose file.
745    const char* pAssetLooseFile = assetLooseFile;
746
747    // Perform query.
748    return object->findAssetLooseFile( pAssetQuery, pAssetLooseFile, assetQueryAsSource );
749}
750
751//-----------------------------------------------------------------------------
752
753DefineEngineMethod(AssetManager, getDeclaredAssetCount, bool, (),,
754   "Gets the number of declared assets.\n"
755   "@return Returns the number of declared assets.\n")
756{
757    return object->getDeclaredAssetCount();
758}
759
760//-----------------------------------------------------------------------------
761
762DefineEngineMethod(AssetManager, getReferencedAssetCount, bool, (), ,
763   "Gets the number of asset referenced.\n"
764   "@return Returns the number of asset references.\n")
765{
766    return object->getReferencedAssetCount();
767}
768
769//-----------------------------------------------------------------------------
770
771DefineEngineMethod(AssetManager, getLoadedInternalAssetCount, bool, (), ,
772   "Gets the number of loaded internal assets.\n"
773   "@return Returns the number of loaded internal assets.\n")
774{
775    return object->getLoadedInternalAssetCount();
776}
777
778//-----------------------------------------------------------------------------
779
780DefineEngineMethod(AssetManager, getMaxLoadedInternalAssetCount, bool, (), ,
781   "Gets the maximum number of loaded internal assets.\n"
782   "@return Returns the maximum number of loaded internal assets.\n")
783{
784    return object->getMaxLoadedInternalAssetCount();
785}
786
787//-----------------------------------------------------------------------------
788
789DefineEngineMethod(AssetManager, getLoadedExternalAssetCount, bool, (), ,
790   "Gets the number of loaded external assets.\n"
791   "@return Returns the number of loaded external assets.\n")
792{
793    return object->getLoadedExternalAssetCount();
794}
795
796//-----------------------------------------------------------------------------
797
798DefineEngineMethod(AssetManager, getMaxLoadedExternalAssetCount, bool, (), ,
799   "Gets the maximum number of loaded external assets.\n"
800   "@return Returns the maximum number of loaded external assets.\n")
801{
802    return object->getMaxLoadedExternalAssetCount();
803}
804
805//-----------------------------------------------------------------------------
806
807DefineEngineMethod(AssetManager, dumpDeclaredAssets, void, (), ,
808   "Dumps a breakdown of all declared assets.\n"
809   "@return No return value.\n")
810{
811    return object->dumpDeclaredAssets();
812}
813