Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


stickyCursorLock

Set cursor lock behavior to be "sticky" or "unsticky".
Read time 1 minuteLast updated 10 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.WebGLModule
public static bool stickyCursorLock { get; set; }

Remarks

Sticky cursor lock means if the browser unlocks the cursor when the user presses the ESC key, the cursor will remain locked in Unity. To match the browser's behavior, this property can be set to false, which will "unstick" the cursor lock and unlock it in Unity as well. The default value for this propery is true.

Examples

using UnityEngine;public class Example : MonoBehaviour{ void Start() {#if !UNITY_EDITOR && UNITY_WEBGL // disable WebGLInput.stickyCursorLock so if the browser unlocks the cursor (with the ESC key) the cursor will unlock in Unity WebGLInput.stickyCursorLock = false;#endif }}