Version: 2018.1 (switch to 2018.2b or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

MonoBehaviour.Awake()

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

Submission failed

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

Close

Cancel

Description

Awake is called when the script instance is being loaded.

Awake is used to initialize any variables or game state before the game starts. Awake is called only once during the lifetime of the script instance. Awake is called after all objects are initialized so you can safely speak to other objects or query them using for example GameObject.FindWithTag. Each GameObject's Awake is called in a random order between objects. Because of this, you should use Awake to set up references between scripts, and use Start to pass any information back and forth. Awake is always called before any Start functions. This allows you to order initialization of scripts. Awake can not act as a coroutine.

Note: For C# use Awake instead of the constructor for initialization, as the serialized state of the component is undefined at construction time. Awake is called once, just like the constructor.

Note: An inactive GameObject can be activated when SetActive is called on it.

#pragma strict
private var target: GameObject;
function Awake() {
	target = GameObject.FindWithTag("Player");
}
using UnityEngine;

public class ExampleClass : MonoBehaviour { private GameObject target;

void Awake() { target = GameObject.FindWithTag("Player"); } }

The following two scripts work together. Example1 starts as not active because the Awake function is not called. Example2 is a normal GameObject script. It has access to the Example1 script.

#pragma strict
public class Example1 extends MonoBehaviour {
	function Awake() {
		Debug.Log("Awake");
	}
	function Start() {
		Debug.Log("Example1");
		// gameObject.SetActive(false);
	}
	function Update() {
		if (Input.GetKeyDown("b")) {
			print("b key was pressed");
		}
	}
}
using UnityEngine;

public class Example1 : MonoBehaviour { void Awake() { Debug.Log("Awake"); }

void Start() { Debug.Log("Example1");

// Update() can be disabled by calling: // gameObject.SetActive(false); }

void Update() { if (Input.GetKeyDown("b")) { print("b key was pressed"); } } }

Example2. This causes Awake in Example1 to be called. The Space key is used to perform this:

#pragma strict
public class Example2 extends MonoBehaviour {
	public var GO: GameObject;
	function Start() {
		Debug.Log("Example2");
	}
	function Update() {
		if (Input.GetKeyDown("space")) {
			Debug.Log("space key was pressed");
			GO.SetActive(true);
		}
	}
}
using UnityEngine;

public class Example2 : MonoBehaviour { // GO has Example1 script assigned to it public GameObject GO;

void Start() { Debug.Log("Example2"); }

void Update() { if (Input.GetKeyDown("space")) { Debug.Log("space key was pressed"); GO.SetActive(true); } } }

Awake cannot be a co-routine.

Did you find this page useful? Please give it a rating: