WWW
Simple access to web pages.
Read time 3 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.UnityWebRequestWWWModule
- Inherits from: CustomYieldInstruction
- Implements: IEnumerator, IDisposable
Warning
Deprecated. Use UnityWebRequest, a fully featured replacement which is more efficient and has additional features
public class WWW : CustomYieldInstruction, IEnumerator, IDisposable
Remarks
Obsolete: WWW has been replaced with UnityWebRequest.
This is a small utility module for retrieving the contents of URLs.
You start a download in the background by calling which returns a new WWW object.
WWW(url)You can inspect the property to see if the download has completed or yield the download object to automatically wait until it is (without blocking the rest of the game).
isDoneUse it if you want to get some data from a web server for integration with a game such as highscore lists or calling home for some reason. There is also functionality to create textures from images downloaded from the web and to stream & load new web player data files.
The WWW class can be used to send both GET and POST requests to the server. The WWW class will use GET by default and POST if you supply a postData parameter.
Additional Resources: WWWForm for a way to build valid form data for the postData parameter.
Note: URLs passed to WWW class must be '%' escaped.
Notes http://, https:// and file:// protocols are supported on iPhone. ftp:// protocol support is limited to anonymous downloads only. Other protocols are not supported.
Note: When using file protocol on Windows and Windows Store Apps for accessing local files, you have to specify file:/// (with three slashes).
Examples
// Get the Unity logo as a texture from the Unity websiteusing UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public string url = "https://unity3d.com/files/images/ogimg.jpg"; IEnumerator Start() { using (WWW www = new WWW(url)) { yield return www; Renderer renderer = GetComponent<Renderer>(); renderer.material.mainTexture = www.texture; } }}
Constructors
Constructor | Description |
|---|---|
| WWW(System.String) | Creates a WWW request with the given URL. |
| WWW(System.String,System.Byte[]) | Creates a WWW request with the given URL. |
| WWW(System.String,System.Byte[],System.Collections.Generic.Dictionary{System.String,System.String}) | Creates a WWW request with the given URL. |
| WWW(System.String,UnityEngine.WWWForm) | Creates a WWW request with the given URL. |
Properties
Property | Description |
|---|---|
| assetBundle | Streams an AssetBundle that can contain any kind of asset from the project folder. |
| bytes | Returns the contents of the fetched web page as a byte array (Read Only). |
| bytesDownloaded | The number of bytes downloaded by this WWW query (read only). |
| error | Returns an error message if there was an error during the download (Read Only). |
| isDone | Is the download already finished? (Read Only) |
| progress | How far has the download progressed (Read Only). |
| responseHeaders | Dictionary of headers returned by the request. |
| text | Returns the contents of the fetched web page as a string (Read Only). |
| texture | Returns a Texture2D generated from the downloaded data (Read Only). |
| textureNonReadable | Returns a non-readable Texture2D generated from the downloaded data (Read Only). |
| threadPriority | Obsolete, has no effect. |
| uploadProgress | How far has the upload progressed (Read Only). |
| url | The URL of this WWW request (Read Only). |
Methods
Method | Description |
|---|---|
| Dispose | Disposes of an existing WWW object. |
| GetAudioClip | OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip(). |
| GetAudioClipCompressed | OBSOLETE. Use UnityWebRequestMultimedia.GetAudioClip(). |
| LoadImageIntoTexture | Replaces the contents of an existing Texture2D with an image from the downloaded data. |
Static Methods
Method | Description |
|---|---|
| EscapeURL | Escapes characters in a string to ensure they are URL-friendly. |
| LoadFromCacheOrDownload | 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. |
| UnEscapeURL | Converts URL-friendly escape sequences back to normal text. |