NullReferenceException en Unity

Dado que muchos usuarios se enfrentan al NullReferenceException: Object reference not set to an instance of an objecterror en Unity, pensé que sería una buena idea reunir algunas fuentes y explicaciones para solucionar este error.

Síntomas

Me aparece el siguiente error en mi consola, ¿qué significa y cómo lo soluciono?

NullReferenceException: referencia de objeto no establecida en una instancia de un objeto

Tipo de valor vs tipo de referencia

En muchos lenguajes de programación, las variables tienen lo que se llama un "tipo de datos". Los dos tipos de datos principales son los tipos de valor (int, float, bool, char, struct, ...) y el tipo de referencia (instancia de clases). Mientras que los tipos de valor contienen el valor en sí , las referencias contienen una dirección de memoria que apunta a una parte de la memoria asignada para contener un conjunto de valores (similar a C / C ++).

Por ejemplo, Vector3es un tipo de valor (una estructura que contiene las coordenadas y algunas funciones) mientras que los componentes adjuntos a su GameObject (incluidos sus scripts personalizados que heredan MonoBehaviour) son de tipo de referencia.

¿Cuándo puedo tener una NullReferenceException?

NullReferenceException se lanzan cuando intenta acceder a una variable de referencia que no hace referencia a ningún objeto, por lo tanto, es nula (la dirección de memoria apunta a 0).

Se NullReferenceExceptionplantearán algunos lugares comunes a :

Manipular un GameObject / Component que no se haya especificado en el inspector

// t is a reference to a Transform.
public Transform t ;

private void Awake()
{
     // If you do not assign something to t
     // (either from the Inspector or using GetComponent), t is null!
     t.Translate();
}

Recuperando un componente que no está conectado al GameObject y luego, tratando de manipularlo:

private void Awake ()
{
    // Here, you try to get the Collider component attached to your gameobject
    Collider collider = gameObject.GetComponent<Collider>();

    // But, if you haven't any collider attached to your gameobject,
    // GetComponent won't find it and will return null, and you will get the exception.
    collider.enabled = false ;
}

Acceder a un GameObject que no existe:

private void Start()
{
    // Here, you try to get a gameobject in your scene
    GameObject myGameObject = GameObject.Find("AGameObjectThatDoesntExist");

    // If no object with the EXACT name "AGameObjectThatDoesntExist" exist in your scene,
    // GameObject.Find will return null, and you will get the exception.
    myGameObject.name = "NullReferenceException";
}

Nota: Tenga cuidado, GameObject.Find, GameObject.FindWithTag, GameObject.FindObjectOfTypedevolver sólo GameObjects que están habilitadas en la jerarquía cuando se invoca la función.

Intentando usar el resultado de un getter que está regresando null:

var fov = Camera.main.fieldOfView;
// main is null if no enabled cameras in the scene have the "MainCamera" tag.

var selection = EventSystem.current.firstSelectedGameObject;
// current is null if there's no active EventSystem in the scene.

var target = RenderTexture.active.width;
// active is null if the game is currently rendering straight to the window, not to a texture.

Acceder a un elemento de una matriz no inicializada

private GameObject[] myObjects ; // Uninitialized array

private void Start()
{
    for( int i = 0 ; i < myObjects.Length ; ++i )
        Debug.Log( myObjects[i].name ) ;
}

Menos común, pero molesto si no lo sabe sobre los delegados de C #:

delegate double MathAction(double num);

// Regular method that matches signature:
static double Double(double input)
{
    return input * 2;
}

private void Awake()
{
    MathAction ma ;

    // Because you haven't "assigned" any method to the delegate,
    // you will have a NullReferenceException
    ma(1) ;

    ma = Double ;

    // Here, the delegate "contains" the Double method and
    // won't throw an exception
    ma(1) ;
}

Como arreglar ?

Si ha entendido los párrafos anteriores, sabe cómo corregir el error: asegúrese de que su variable haga referencia (señale) a una instancia de una clase (o que contenga al menos una función para delegados).

¿Es más fácil decirlo que hacerlo? Si, de hecho. Aquí hay algunos consejos para evitar e identificar el problema.

La forma "sucia": el método try & catch:

Collider collider = gameObject.GetComponent<Collider>();

try
{
    collider.enabled = false ;
}       
catch (System.NullReferenceException exception) {
    Debug.LogError("Oops, there is no collider attached", this) ;
}

La forma "más limpia" (en mi humilde opinión): el cheque

Collider collider = gameObject.GetComponent<Collider>();

if(collider != null)
{
    // You can safely manipulate the collider here
    collider.enabled = false;
}    
else
{
    Debug.LogError("Oops, there is no collider attached", this) ;
}

Cuando enfrenta un error que no puede resolver, siempre es una buena idea encontrar la causa del problema. Si es "flojo" (o si el problema se puede resolver fácilmente), use Debug.Logpara mostrar en la consola información que lo ayudará a identificar qué podría causar el problema. Una forma más compleja es utilizar los puntos de interrupción y el depurador de su IDE.

El uso Debug.Loges bastante útil para determinar qué función se llama primero, por ejemplo. Especialmente si tiene una función responsable de inicializar campos. Pero no olvide eliminarlos Debug.Logpara evitar abarrotar su consola (y por razones de rendimiento).

Otro consejo, no dude en "cortar" sus llamadas a funciones y agregarlas Debug.Logpara hacer algunas verificaciones.

En lugar de :

 GameObject.Find("MyObject").GetComponent<MySuperComponent>().value = "foo" ;

Haga esto para verificar si todas las referencias están establecidas:

GameObject myObject = GameObject.Find("MyObject") ;

Debug.Log( myObject ) ;

MySuperComponent superComponent = myObject.GetComponent<MySuperComponent>() ;

Debug.Log( superComponent ) ;

superComponent.value = "foo" ;

Aun mejor :

GameObject myObject = GameObject.Find("MyObject") ;

if( myObject != null )
{
   MySuperComponent superComponent = myObject.GetComponent<MySuperComponent>() ;
   if( superComponent != null )
   {
       superComponent.value = "foo" ;
   }
   else
   {
        Debug.Log("No SuperComponent found onMyObject!");
   }
}
else
{
   Debug.Log("Can't find MyObject!", this ) ;
}

Fuentes:

1. http://answers.unity3d.com/questions/47830/what-is-a-null-reference-exception-in-unity.html
2. /programming/218384/what-is-a-nullpointerexception-and-how-do-i-fix-it/218510#218510
3. https://support.unity3d.com/hc/en-us/articles/206369473-NullReferenceException
4. https://unity3d.com/fr/learn/tutorials/topics/scripting/data-types

Si bien podemos simplemente hacer una verificación para asegurarnos de que no estamos tratando de acceder a una referencia nula, esta no siempre es una solución adecuada. Muchas veces, en la programación de Unity, nuestro problema puede derivarse del hecho de que la referencia no debe ser nula. En algunas situaciones, simplemente ignorar referencias nulas puede romper nuestro código.

Por ejemplo, podría ser una referencia a nuestro controlador de entrada. Es genial que el juego no se bloquee debido a la excepción de referencia nula, pero necesitamos descubrir por qué no hay un controlador de entrada y solucionar ese problema. Sin él, tenemos un juego que puede no bloquearse, pero tampoco puede recibir información.

A continuación, enumeraré posibles razones y soluciones, a medida que las encuentre en otras preguntas.

¿Estás tratando de acceder a una clase de "gerente"?

Si está intentando acceder a una clase que actúa como un "administrador" (es decir, una clase que solo debería tener una instancia ejecutándose a la vez), es mejor que utilice el enfoque Singleton . Se puede acceder idealmente a una clase Singleton desde cualquier lugar, directamente, manteniendo una public staticreferencia a sí misma. De esta manera, un Singleton puede contener una referencia a la instancia activa, que sería accesible sin la molestia de configurar la referencia real cada vez.

¿Estás haciendo referencia a la instancia de tu objeto?

Es común simplemente marcar una referencia como public, por lo que podemos establecer la referencia a la instancia a través del inspector. Compruebe siempre que haya establecido la referencia a una instancia, a través del inspector, ya que no es raro que se salte este paso.

¿Estás instanciando tu instancia?

Si estamos configurando nuestro objeto en código, es importante asegurarse de crear una instancia del objeto. Esto puede llevarse a cabo utilizando la newpalabra clave y los métodos de construcción. Por ejemplo, considere lo siguiente:

private GameObject gameObject;

Hemos creado una referencia a a GameObject, pero no apunta a nada. Acceder a esta referencia como está dará como resultado una excepción de referencia nula . Antes de hacer referencia a nuestra GameObjectinstancia, podemos llamar a un método de constructor predeterminado de la siguiente manera:

gameObject = new GameObject();

El tutorial de Unity sobre clases explica la práctica de crear y usar constructores.

¿Está utilizando el GetComponent<t>()método con el supuesto de que el componente existe?

Primero, asegúrese de que siempre llamemos GetComponent<t>()antes de llamar a los métodos desde la instancia del componente.

Por razones por las que no vale la pena entrar, podemos suponer que nuestro objeto de juego local contiene un componente en particular y tratar de acceder a él GetComponent<t>(). Si el objeto del juego local no contiene ese componente en particular, devolveremos un nullvalor.

Puede verificar fácilmente si el valor de retorno es null, antes de acceder a él. Sin embargo, si su objeto de juego debe tener el componente requerido, puede ser mejor asegurarse de que al menos tenga una versión predeterminada de ese componente. Podemos etiquetar una MonoBehaviourcomo [RequireComponent(typeof(t))]para asegurar que siempre tenemos ese tipo de componente.

Aquí hay un ejemplo de un MonoBehaviourobjeto para un juego que siempre debe contener un Rigidbody. Si el script se agrega a un objeto del juego que no contiene un Rigidbody, se Rigidbodycreará un valor predeterminado .

[RequireComponent(typeof(Rigidbody))]
public class AlwaysHasRigidbody : MonoBehaviour
{
    Rigidbody myRigidbody;


    void Start()
    {
        myRigidbody = GetComponent<Rigidbody>();
    }
}

¿Has intentado reconstruir tu proyecto?

Hay algunos casos en los que Unity puede causar problemas al intentar hacer referencia a una versión en caché de un objeto de juego. En línea con la antigua solución de "apagar y volver a encender", intente eliminar su carpeta Biblioteca y vuelva a abrir Unity. Unity se verá obligado a reconstruir su proyecto. Esto puede resolver algunos casos muy peculiares de este problema, y ​​debería apuntar a problemas que no aparecerían en una compilación final.

Veo que hay una respuesta aceptada. Pero, hay una mejor respuesta o sugerencia para usted para el manejo NullReferenceException. Si puede relacionar la programación en lenguaje Java como yo, puede evitar enviar un error nulo utilizando el try-catchbloque. Pruébalo por ti mismo! ;-)

Si está utilizando en C #, verifique si tiene using System;en la parte superior de su archivo de script. Si no, agréguelo. Ahora, puede usar todo tipo de Exceptionclases mientras intenta atrapar una línea de código.

Si está utilizando UnityScript, use import System;

Aquí hay un ejemplo:

using System; // --> This exact line of code. That's it.
using UnityEngine;

public class Test : MonoBehaviour {

    public GameObject player; // --> Example to check if there's a null content;

    public void Update() {

        // You may now catch null reference here.
        try {

            player.transform.Translate(0, 0, 2);

        } catch(NullReferenceException e) { // --> You may use this type of exception class

        }

    }
}

También recuerde, se puede tomar también otras excepciones como MissingReferenceException, MissingComponentException, IndexOutOfRangeException, o cualquier otra clase de excepción, siempre y cuando usted incluye using Systemen su guión.

Eso es todo.