Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

var playOnAwake: bool;
bool playOnAwake;
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()