UnityEngine.UnityWebRequestAssetBundleModule.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.UnityWebRequestAssetBundleModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Networking.DownloadHandlerAssetBundle">
  8. <summary>
  9. <para>A DownloadHandler subclass specialized for downloading AssetBundles.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.Networking.DownloadHandlerAssetBundle.assetBundle">
  13. <summary>
  14. <para>Returns the downloaded AssetBundle, or null. (Read Only)</para>
  15. </summary>
  16. </member>
  17. <member name="M:UnityEngine.Networking.DownloadHandlerAssetBundle.#ctor(System.String,System.UInt32)">
  18. <summary>
  19. <para>Standard constructor for non-cached asset bundles.</para>
  20. </summary>
  21. <param name="url">The nominal (pre-redirect) URL at which the asset bundle is located.</param>
  22. <param name="crc">A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking.</param>
  23. </member>
  24. <member name="M:UnityEngine.Networking.DownloadHandlerAssetBundle.#ctor(System.String,System.UInt32,System.UInt32)">
  25. <summary>
  26. <para>Simple versioned constructor. Caches downloaded asset bundles.</para>
  27. </summary>
  28. <param name="url">The nominal (pre-redirect) URL at which the asset bundle is located.</param>
  29. <param name="crc">A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking.</param>
  30. <param name="version">Current version number of the asset bundle at url. Increment to redownload.</param>
  31. </member>
  32. <member name="M:UnityEngine.Networking.DownloadHandlerAssetBundle.#ctor(System.String,UnityEngine.Hash128,System.UInt32)">
  33. <summary>
  34. <para>Versioned constructor. Caches downloaded asset bundles.</para>
  35. </summary>
  36. <param name="url">The nominal (pre-redirect) URL at which the asset bundle is located.</param>
  37. <param name="crc">A checksum to compare to the downloaded data for integrity checking, or zero to skip integrity checking.</param>
  38. <param name="hash">A hash object defining the version of the asset bundle.</param>
  39. </member>
  40. <member name="M:UnityEngine.Networking.DownloadHandlerAssetBundle.GetContent(UnityEngine.Networking.UnityWebRequest)">
  41. <summary>
  42. <para>Returns the downloaded AssetBundle, or null.</para>
  43. </summary>
  44. <param name="www">A finished UnityWebRequest object with DownloadHandlerAssetBundle attached.</param>
  45. <returns>
  46. <para>The same as DownloadHandlerAssetBundle.assetBundle</para>
  47. </returns>
  48. </member>
  49. <member name="M:UnityEngine.Networking.DownloadHandlerAssetBundle.GetData">
  50. <summary>
  51. <para>Not implemented. Throws &lt;a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception"&gt;NotSupportedException&lt;a&gt;.</para>
  52. </summary>
  53. <returns>
  54. <para>Not implemented.</para>
  55. </returns>
  56. </member>
  57. <member name="M:UnityEngine.Networking.DownloadHandlerAssetBundle.GetText">
  58. <summary>
  59. <para>Not implemented. Throws &lt;a href="http:msdn.microsoft.comen-uslibrarysystem.notsupportedexception"&gt;NotSupportedException&lt;a&gt;.</para>
  60. </summary>
  61. <returns>
  62. <para>Not implemented.</para>
  63. </returns>
  64. </member>
  65. <member name="T:UnityEngine.Networking.UnityWebRequestAssetBundle">
  66. <summary>
  67. <para>Helpers for downloading asset bundles using UnityWebRequest.</para>
  68. </summary>
  69. </member>
  70. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.String)">
  71. <summary>
  72. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  73. </summary>
  74. <param name="uri">The URI of the asset bundle to download.</param>
  75. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  76. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  77. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  78. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  79. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  80. <returns>
  81. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  82. </returns>
  83. </member>
  84. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.Uri)">
  85. <summary>
  86. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  87. </summary>
  88. <param name="uri">The URI of the asset bundle to download.</param>
  89. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  90. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  91. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  92. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  93. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  94. <returns>
  95. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  96. </returns>
  97. </member>
  98. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.String,System.UInt32)">
  99. <summary>
  100. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  101. </summary>
  102. <param name="uri">The URI of the asset bundle to download.</param>
  103. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  104. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  105. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  106. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  107. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  108. <returns>
  109. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  110. </returns>
  111. </member>
  112. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.Uri,System.UInt32)">
  113. <summary>
  114. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  115. </summary>
  116. <param name="uri">The URI of the asset bundle to download.</param>
  117. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  118. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  119. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  120. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  121. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  122. <returns>
  123. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  124. </returns>
  125. </member>
  126. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.String,System.UInt32,System.UInt32)">
  127. <summary>
  128. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  129. </summary>
  130. <param name="uri">The URI of the asset bundle to download.</param>
  131. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  132. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  133. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  134. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  135. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  136. <returns>
  137. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  138. </returns>
  139. </member>
  140. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.Uri,System.UInt32,System.UInt32)">
  141. <summary>
  142. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  143. </summary>
  144. <param name="uri">The URI of the asset bundle to download.</param>
  145. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  146. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  147. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  148. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  149. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  150. <returns>
  151. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  152. </returns>
  153. </member>
  154. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.String,UnityEngine.Hash128,System.UInt32)">
  155. <summary>
  156. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  157. </summary>
  158. <param name="uri">The URI of the asset bundle to download.</param>
  159. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  160. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  161. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  162. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  163. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  164. <returns>
  165. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  166. </returns>
  167. </member>
  168. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.Uri,UnityEngine.Hash128,System.UInt32)">
  169. <summary>
  170. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  171. </summary>
  172. <param name="uri">The URI of the asset bundle to download.</param>
  173. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  174. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  175. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  176. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  177. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  178. <returns>
  179. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  180. </returns>
  181. </member>
  182. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.String,UnityEngine.CachedAssetBundle,System.UInt32)">
  183. <summary>
  184. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  185. </summary>
  186. <param name="uri">The URI of the asset bundle to download.</param>
  187. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  188. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  189. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  190. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  191. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  192. <returns>
  193. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  194. </returns>
  195. </member>
  196. <member name="M:UnityEngine.Networking.UnityWebRequestAssetBundle.GetAssetBundle(System.Uri,UnityEngine.CachedAssetBundle,System.UInt32)">
  197. <summary>
  198. <para>Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.</para>
  199. </summary>
  200. <param name="uri">The URI of the asset bundle to download.</param>
  201. <param name="crc">If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.</param>
  202. <param name="version">An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.
  203. Analogous to the version parameter for WWW.LoadFromCacheOrDownload.</param>
  204. <param name="hash">A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.</param>
  205. <param name="cachedAssetBundle">A structure used to download a given version of AssetBundle to a customized cache path.</param>
  206. <returns>
  207. <para>A UnityWebRequest configured to downloading a Unity Asset Bundle.</para>
  208. </returns>
  209. </member>
  210. <member name="A:UnityEngine.UnityWebRequestAssetBundleModule">
  211. <summary>
  212. <para>The UnityWebRequestAudio module provides the DownloadHandlerAssetBundle class to use UnityWebRequest to download Asset Bundles.</para>
  213. </summary>
  214. </member>
  215. </members>
  216. </doc>