Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

AudioSource.playOnAwake

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

Switch to Manual
public var playOnAwake: bool;
public bool playOnAwake;
public playOnAwake as bool

Description

If set to true, the audio source will automatically start playing on awake.

		@script RequireComponent(AudioSource)
		function Start() {
			if(!audio.playOnAwake) {
				audio.Play(); // Play the clip if it wasn't set to play on awake
		}
	}
using UnityEngine;
using System.Collections;

[RequireComponent(typeof(AudioSource))]
public class ExampleClass : MonoBehaviour {
    void Start() {
        if (!audio.playOnAwake)
            audio.Play();
        
    }
}
import UnityEngine
import System.Collections

[RequireComponent(typeof(AudioSource))]
public class ExampleClass(MonoBehaviour):

	def Start() as void:
		if not audio.playOnAwake:
			audio.Play()