UnityEngine.UnityWebRequestWWWModule.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.UnityWebRequestWWWModule</name>
  6. </assembly>
  7. <member name="A:UnityEngine.UnityWebRequestWWWModule">
  8. <summary>
  9. <para>The UnityWebRequestWWW module implements the legacy WWW lets you communicate with http services.</para>
  10. </summary>
  11. </member>
  12. <member name="T:UnityEngine.WWW">
  13. <summary>
  14. <para>Simple access to web pages.</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.WWW.assetBundle">
  18. <summary>
  19. <para>Streams an AssetBundle that can contain any kind of asset from the project folder.</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.WWW.audioClip">
  23. <summary>
  24. <para>Returns a AudioClip generated from the downloaded data (Read Only).</para>
  25. </summary>
  26. </member>
  27. <member name="P:UnityEngine.WWW.bytes">
  28. <summary>
  29. <para>Returns the contents of the fetched web page as a byte array (Read Only).</para>
  30. </summary>
  31. </member>
  32. <member name="P:UnityEngine.WWW.bytesDownloaded">
  33. <summary>
  34. <para>The number of bytes downloaded by this WWW query (read only).</para>
  35. </summary>
  36. </member>
  37. <member name="P:UnityEngine.WWW.error">
  38. <summary>
  39. <para>Returns an error message if there was an error during the download (Read Only).</para>
  40. </summary>
  41. </member>
  42. <member name="P:UnityEngine.WWW.isDone">
  43. <summary>
  44. <para>Is the download already finished? (Read Only)</para>
  45. </summary>
  46. </member>
  47. <member name="P:UnityEngine.WWW.movie">
  48. <summary>
  49. <para>MovieTexture has been removed. Use VideoPlayer instead.</para>
  50. </summary>
  51. </member>
  52. <member name="P:UnityEngine.WWW.oggVorbis">
  53. <summary>
  54. <para>Load an Ogg Vorbis file into the audio clip.</para>
  55. </summary>
  56. </member>
  57. <member name="P:UnityEngine.WWW.progress">
  58. <summary>
  59. <para>How far has the download progressed (Read Only).</para>
  60. </summary>
  61. </member>
  62. <member name="P:UnityEngine.WWW.responseHeaders">
  63. <summary>
  64. <para>Dictionary of headers returned by the request.</para>
  65. </summary>
  66. </member>
  67. <member name="P:UnityEngine.WWW.text">
  68. <summary>
  69. <para>Returns the contents of the fetched web page as a string (Read Only).</para>
  70. </summary>
  71. </member>
  72. <member name="P:UnityEngine.WWW.texture">
  73. <summary>
  74. <para>Returns a Texture2D generated from the downloaded data (Read Only).</para>
  75. </summary>
  76. </member>
  77. <member name="P:UnityEngine.WWW.textureNonReadable">
  78. <summary>
  79. <para>Returns a non-readable Texture2D generated from the downloaded data (Read Only).</para>
  80. </summary>
  81. </member>
  82. <member name="P:UnityEngine.WWW.threadPriority">
  83. <summary>
  84. <para>Obsolete, has no effect.</para>
  85. </summary>
  86. </member>
  87. <member name="P:UnityEngine.WWW.uploadProgress">
  88. <summary>
  89. <para>How far has the upload progressed (Read Only).</para>
  90. </summary>
  91. </member>
  92. <member name="P:UnityEngine.WWW.url">
  93. <summary>
  94. <para>The URL of this WWW request (Read Only).</para>
  95. </summary>
  96. </member>
  97. <member name="M:UnityEngine.WWW.#ctor(System.String)">
  98. <summary>
  99. <para>Creates a WWW request with the given URL.</para>
  100. </summary>
  101. <param name="url">The url to download. Must be '%' escaped.</param>
  102. <returns>
  103. <para>A new WWW object. When it has been downloaded, the results can be fetched from the returned object.</para>
  104. </returns>
  105. </member>
  106. <member name="M:UnityEngine.WWW.#ctor(System.String,UnityEngine.WWWForm)">
  107. <summary>
  108. <para>Creates a WWW request with the given URL.</para>
  109. </summary>
  110. <param name="url">The url to download. Must be '%' escaped.</param>
  111. <param name="form">A WWWForm instance containing the form data to post.</param>
  112. <returns>
  113. <para>A new WWW object. When it has been downloaded, the results can be fetched from the returned object.</para>
  114. </returns>
  115. </member>
  116. <member name="M:UnityEngine.WWW.#ctor(System.String,System.Byte[])">
  117. <summary>
  118. <para>Creates a WWW request with the given URL.</para>
  119. </summary>
  120. <param name="url">The url to download. Must be '%' escaped.</param>
  121. <param name="postData">A byte array of data to be posted to the url.</param>
  122. <returns>
  123. <para>A new WWW object. When it has been downloaded, the results can be fetched from the returned object.</para>
  124. </returns>
  125. </member>
  126. <member name="M:UnityEngine.WWW.#ctor(System.String,System.Byte[],System.Collections.Hashtable)">
  127. <summary>
  128. <para>Creates a WWW request with the given URL.</para>
  129. </summary>
  130. <param name="url">The url to download. Must be '%' escaped.</param>
  131. <param name="postData">A byte array of data to be posted to the url.</param>
  132. <param name="headers">A hash table of custom headers to send with the request.</param>
  133. <returns>
  134. <para>A new WWW object. When it has been downloaded, the results can be fetched from the returned object.</para>
  135. </returns>
  136. </member>
  137. <member name="M:UnityEngine.WWW.#ctor(System.String,System.Byte[],System.Collections.Generic.Dictionary`2&lt;System.String,System.String&gt;)">
  138. <summary>
  139. <para>Creates a WWW request with the given URL.</para>
  140. </summary>
  141. <param name="url">The url to download. Must be '%' escaped.</param>
  142. <param name="postData">A byte array of data to be posted to the url.</param>
  143. <param name="headers">A dictionary that contains the header keys and values to pass to the server.</param>
  144. <returns>
  145. <para>A new WWW object. When it has been downloaded, the results can be fetched from the returned object.</para>
  146. </returns>
  147. </member>
  148. <member name="M:UnityEngine.WWW.Dispose">
  149. <summary>
  150. <para>Disposes of an existing WWW object.</para>
  151. </summary>
  152. </member>
  153. <member name="M:UnityEngine.WWW.EscapeURL(System.String)">
  154. <summary>
  155. <para>Escapes characters in a string to ensure they are URL-friendly.</para>
  156. </summary>
  157. <param name="s">A string with characters to be escaped.</param>
  158. <param name="e">The text encoding to use.</param>
  159. </member>
  160. <member name="M:UnityEngine.WWW.EscapeURL(System.String,System.Text.Encoding)">
  161. <summary>
  162. <para>Escapes characters in a string to ensure they are URL-friendly.</para>
  163. </summary>
  164. <param name="s">A string with characters to be escaped.</param>
  165. <param name="e">The text encoding to use.</param>
  166. </member>
  167. <member name="M:UnityEngine.WWW.GetAudioClip">
  168. <summary>
  169. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  170. </summary>
  171. <param name="threeD"></param>
  172. <param name="stream"></param>
  173. <param name="audioType"></param>
  174. </member>
  175. <member name="M:UnityEngine.WWW.GetAudioClip(System.Boolean)">
  176. <summary>
  177. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  178. </summary>
  179. <param name="threeD"></param>
  180. <param name="stream"></param>
  181. <param name="audioType"></param>
  182. </member>
  183. <member name="M:UnityEngine.WWW.GetAudioClip(System.Boolean,System.Boolean)">
  184. <summary>
  185. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  186. </summary>
  187. <param name="threeD"></param>
  188. <param name="stream"></param>
  189. <param name="audioType"></param>
  190. </member>
  191. <member name="M:UnityEngine.WWW.GetAudioClip(System.Boolean,System.Boolean,UnityEngine.AudioType)">
  192. <summary>
  193. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  194. </summary>
  195. <param name="threeD"></param>
  196. <param name="stream"></param>
  197. <param name="audioType"></param>
  198. </member>
  199. <member name="M:UnityEngine.WWW.GetAudioClipCompressed">
  200. <summary>
  201. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  202. </summary>
  203. <param name="threeD"></param>
  204. <param name="audioType"></param>
  205. </member>
  206. <member name="M:UnityEngine.WWW.GetAudioClipCompressed(System.Boolean)">
  207. <summary>
  208. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  209. </summary>
  210. <param name="threeD"></param>
  211. <param name="audioType"></param>
  212. </member>
  213. <member name="M:UnityEngine.WWW.GetAudioClipCompressed(System.Boolean,UnityEngine.AudioType)">
  214. <summary>
  215. <para>OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip().</para>
  216. </summary>
  217. <param name="threeD"></param>
  218. <param name="audioType"></param>
  219. </member>
  220. <member name="M:UnityEngine.WWW.GetMovieTexture">
  221. <summary>
  222. <para>MovieTexture has been removed. Use VideoPlayer instead.</para>
  223. </summary>
  224. </member>
  225. <member name="M:UnityEngine.WWW.LoadFromCacheOrDownload(System.String,System.Int32)">
  226. <summary>
  227. <para>Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage.</para>
  228. </summary>
  229. <param name="url">The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped.</param>
  230. <param name="version">Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url.</param>
  231. <param name="hash">Hash128 which is used as the version of the AssetBundle.</param>
  232. <param name="cachedBundle">A structure used to download a given version of AssetBundle to a customized cache path.
  233. Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.&lt;/param&gt;</param>
  234. <param name="crc">An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle.</param>
  235. <returns>
  236. <para>A WWW instance, which can be used to access the data once the load/download operation is completed.</para>
  237. </returns>
  238. </member>
  239. <member name="M:UnityEngine.WWW.LoadFromCacheOrDownload(System.String,System.Int32,System.UInt32)">
  240. <summary>
  241. <para>Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage.</para>
  242. </summary>
  243. <param name="url">The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped.</param>
  244. <param name="version">Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url.</param>
  245. <param name="hash">Hash128 which is used as the version of the AssetBundle.</param>
  246. <param name="cachedBundle">A structure used to download a given version of AssetBundle to a customized cache path.
  247. Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.&lt;/param&gt;</param>
  248. <param name="crc">An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle.</param>
  249. <returns>
  250. <para>A WWW instance, which can be used to access the data once the load/download operation is completed.</para>
  251. </returns>
  252. </member>
  253. <member name="M:UnityEngine.WWW.LoadFromCacheOrDownload(System.String,UnityEngine.Hash128,System.UInt32)">
  254. <summary>
  255. <para>Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage.</para>
  256. </summary>
  257. <param name="url">The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped.</param>
  258. <param name="version">Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url.</param>
  259. <param name="hash">Hash128 which is used as the version of the AssetBundle.</param>
  260. <param name="cachedBundle">A structure used to download a given version of AssetBundle to a customized cache path.
  261. Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.&lt;/param&gt;</param>
  262. <param name="crc">An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle.</param>
  263. <returns>
  264. <para>A WWW instance, which can be used to access the data once the load/download operation is completed.</para>
  265. </returns>
  266. </member>
  267. <member name="M:UnityEngine.WWW.LoadFromCacheOrDownload(System.String,UnityEngine.CachedAssetBundle,System.UInt32)">
  268. <summary>
  269. <para>Loads an AssetBundle with the specified version number from the cache. If the AssetBundle is not currently cached, it will automatically be downloaded and stored in the cache for future retrieval from local storage.</para>
  270. </summary>
  271. <param name="url">The URL to download the AssetBundle from, if it is not present in the cache. Must be '%' escaped.</param>
  272. <param name="version">Version of the AssetBundle. The file will only be loaded from the disk cache if it has previously been downloaded with the same version parameter. By incrementing the version number requested by your application, you can force Caching to download a new copy of the AssetBundle from url.</param>
  273. <param name="hash">Hash128 which is used as the version of the AssetBundle.</param>
  274. <param name="cachedBundle">A structure used to download a given version of AssetBundle to a customized cache path.
  275. Analogous to the cachedAssetBundle parameter for UnityWebRequestAssetBundle.GetAssetBundle.&lt;/param&gt;</param>
  276. <param name="crc">An optional CRC-32 Checksum of the uncompressed contents. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match. You can use this to avoid data corruption from bad downloads or users tampering with the cached files on disk. If the CRC does not match, Unity will try to redownload the data, and if the CRC on the server does not match it will fail with an error. Look at the error string returned to see the correct CRC value to use for an AssetBundle.</param>
  277. <returns>
  278. <para>A WWW instance, which can be used to access the data once the load/download operation is completed.</para>
  279. </returns>
  280. </member>
  281. <member name="M:UnityEngine.WWW.LoadImageIntoTexture(UnityEngine.Texture2D)">
  282. <summary>
  283. <para>Replaces the contents of an existing Texture2D with an image from the downloaded data.</para>
  284. </summary>
  285. <param name="tex">An existing texture object to be overwritten with the image data.</param>
  286. <param name="texture"></param>
  287. </member>
  288. <member name="M:UnityEngine.WWW.UnEscapeURL(System.String)">
  289. <summary>
  290. <para>Converts URL-friendly escape sequences back to normal text.</para>
  291. </summary>
  292. <param name="s">A string containing escaped characters.</param>
  293. <param name="e">The text encoding to use.</param>
  294. </member>
  295. <member name="M:UnityEngine.WWW.UnEscapeURL(System.String,System.Text.Encoding)">
  296. <summary>
  297. <para>Converts URL-friendly escape sequences back to normal text.</para>
  298. </summary>
  299. <param name="s">A string containing escaped characters.</param>
  300. <param name="e">The text encoding to use.</param>
  301. </member>
  302. </members>
  303. </doc>