WWW

Description

Simple access to web pages.

This is a small utility module for retrieving the contents of URLs.

You start a download in the background by calling WWW(url) which returns a new WWW object.

You can inspect the isDone 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).

Use 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.

See Also: WWWForm for a way to build valid form data for the postData parameter.

Note: URLs passed to WWW class must be '%' escaped.

Note: 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).

Note: The security sandbox present in web-player builds prevents you from accessing content not hosted the server where the webplayer is hosted.

// Get the latest webcam shot from outside "Friday's" in Times Square
var url = "http://images.earthcam.com/ec_metros/ourcams/fridays.jpg";
function Start () {
	 // Start a download of the given URL
	var www : WWW = new WWW (url);
	// Wait for download to complete
	yield www;
	// assign texture
	renderer.material.mainTexture = www.texture;
}

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public string url = "http://images.earthcam.com/ec_metros/ourcams/fridays.jpg";
    IEnumerator Start() {
        WWW www = new WWW(url);
        yield return www;
        renderer.material.mainTexture = www.texture;
    }
}

import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public url as string = 'http://images.earthcam.com/ec_metros/ourcams/fridays.jpg'

	def Start() as IEnumerator:
		www as WWW = WWW(url)
		yield www
		renderer.material.mainTexture = www.texture

Variables

assetBundle	Streams an AssetBundle that can contain any kind of asset from the project folder.
audioClip	Returns a AudioClip generated from the downloaded data (Read Only).
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)
movie	Returns a MovieTexture generated from the downloaded data (Read Only).
progress	How far has the download progressed (Read Only).
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	Priority of AssetBundle decompression thread.
uploadProgress	How far has the upload progressed (Read Only).
url	The URL of this WWW request (Read Only).

Constructors

WWW	Creates a WWW request with the given URL.

Functions

GetAudioClip	Returns an AudioClip generated from the downloaded data (Read Only).
GetAudioClipCompressed	Returns an AudioClip generated from the downloaded data that is compressed in memory (Read Only).
LoadImageIntoTexture	Replaces the contents of an existing Texture2D with an image from the downloaded data.
LoadUnityWeb	Loads the new web player data file.

Static Functions

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.