Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

WWW

class in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

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

#pragma strict
// Get the latest webcam shot from outside "Friday's" in Times Square
public var url: String = "http://images.earthcam.com/ec_metros/ourcams/fridays.jpg";
function Start() {
	var www: WWW = new WWW(url);
	var renderer: Renderer = GetComponent.<Renderer>();
	renderer.material.mainTexture = www.texture;
}
// Get the latest webcam shot from outside "Friday's" in Times Square
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 renderer = GetComponent<Renderer>(); renderer.material.mainTexture = www.texture; } }

Variables

assetBundleStreams an AssetBundle that can contain any kind of asset from the project folder.
audioClipReturns a AudioClip generated from the downloaded data (Read Only).
bytesReturns the contents of the fetched web page as a byte array (Read Only).
bytesDownloadedThe number of bytes downloaded by this WWW query (read only).
errorReturns an error message if there was an error during the download (Read Only).
isDoneIs the download already finished? (Read Only)
movieReturns a MovieTexture generated from the downloaded data (Read Only).
progressHow far has the download progressed (Read Only).
responseHeadersDictionary of headers returned by the request.
textReturns the contents of the fetched web page as a string (Read Only).
textureReturns a Texture2D generated from the downloaded data (Read Only).
textureNonReadableReturns a non-readable Texture2D generated from the downloaded data (Read Only).
threadPriorityPriority of AssetBundle decompression thread.
uploadProgressHow far has the upload progressed (Read Only).
urlThe URL of this WWW request (Read Only).

Constructors

WWWCreates a WWW request with the given URL.

Public Functions

DisposeDisposes of an existing WWW object.
GetAudioClipReturns an AudioClip generated from the downloaded data (Read Only).
GetAudioClipCompressedReturns an AudioClip generated from the downloaded data that is compressed in memory (Read Only).
LoadImageIntoTextureReplaces the contents of an existing Texture2D with an image from the downloaded data.

Static Functions

EscapeURLEscapes characters in a string to ensure they are URL-friendly.
LoadFromCacheOrDownloadLoads 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.
UnEscapeURLConverts URL-friendly escape sequences back to normal text.