Visual Studio does not support debugging Unity WebGLA JavaScript API that renders 2D and 3D graphics in a web browser. The Unity WebGL build option allows Unity to publish content as JavaScript programs which use HTML5 technologies and the WebGL rendering API to run Unity content in a web browser. More info
See in Glossary content. To help you to find out exactly what’s going on with your content, here are some tips on how to get information out of your build.
Unity WebGL does not have access to your file system, so it does not write a log file like other platforms. However, it does write all logging information (such as Debug.Log, Console.WriteLine or Unity’s internal logging) to the browser’s JavaScript console.
To open the JavaScript console:
For debugging purposes, you might want to make a development build in Unity (open the Build Settings window and click the Development BuildA development build includes debug symbols and enables the Profiler. More info
See in Glossary checkbox). Development builds allow you to connect the profilerA window that helps you to optimize your game. It shows how much time is spent in the various areas of your game. For example, it can report the percentage of time spent rendering, animating or in your game logic. More info
See in Glossary, and Unity does not minify them, so the emitted JavaScript code still contains human-readable (though C++-mangled) function names. The browser can use these to display stack traces when you run into a browser error, when using Debug.LogError, or when you throw an exception and exception support is disabled. Unlike the managed stack traces that can occur when you have full exception support (see below), these stack traces have mangled names, and contain not only managed code, but also the internal UnityEngine code.
WebGL has different levels of exception support (see documentation on Building for WebGL). By default, Unity WebGL only supports explicitly thrown exceptions. You can enable Full exception support, which emits additional checks in the IL2CPP-generated code, to catch access to null references and out-of-bounds array elements in your managed code. These additional checks significantly impact performance and increase code size and load times, so you should only use it for debugging.
Full exception support also emits function names to generate stack traces for your managed code. For this reason, stack traces appear in the console for uncaught exceptions and for Debug.Log statements. Use System.Environment.Stacktrace to get a stack trace string.
This is a common problem, especially on 32-bit browsers. For more information on WebGL memory issues and how to fix them, see documentation on Memory in WebGL.
Unity WebGL stores all files that must persist between sessions (such as PlayerPrefs or files saved in persistentDataPath) to the browser IndexedDB. This is an asynchronous API, so you don’t know when it’s going to complete.
Call the following code to make sure Unity flushes all pending file system write operations to the IndexedDB file system from memory:
FS.syncfs(false, function (err) {
console.log('Error: syncfs failed!');
});
The browser console log usually prints this error as a result of incorrect server configuration. For more information on how to deploy a release build, see documentation on Deploying compressed builds.
The browser console log prints this error when the content tries to load an AssetBundle compressed using LZMA, which Unity WebGL does not support. Re-compress the AssetBundle using LZ4 compressionA method of storing data that reduces the amount of storage space it requires. See Texture Compression3D Graphics hardware requires Textures to be compressed in specialised formats which are optimised for fast Texture sampling. More info
See in Glossary, Animation CompressionThe method of compressing animation data to significantly reduce file sizes without causing a noticable reduction in motion quality. Animation compression is a trade off between saving on memory and image quality. More info
See in Glossary, Audio Compression, Build Compression.
See in Glossary to solve this problem. For more information on compression for WebGL, see documentation on WebGL building, particularly the AssetBundles section.
2018–09–03 Page amended with limited editorial review
MonoDevelop replaced with Visual Studio from 2018.1
Did you find this page useful? Please give it a rating: