WeatherMakerSoundScript Class

Sound script, profile for a set of audio clips

Inheritance Hierarchy

SystemObject
  Object
    ScriptableObject
      DigitalRuby.WeatherMakerWeatherMakerBaseScriptableObjectScript
        DigitalRuby.WeatherMakerWeatherMakerSoundScript

Namespace: DigitalRuby.WeatherMaker
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0

Syntax

public class WeatherMakerSoundScript : WeatherMakerBaseScriptableObjectScript

Public Class WeatherMakerSoundScript
	Inherits WeatherMakerBaseScriptableObjectScript

public ref class WeatherMakerSoundScript : public WeatherMakerBaseScriptableObjectScript

type WeatherMakerSoundScript =  
    class
        inherit WeatherMakerBaseScriptableObjectScript
    end

The WeatherMakerSoundScript type exposes the following members.

Constructors

	Name	Description
	WeatherMakerSoundScript	Initializes a new instance of the WeatherMakerSoundScript class

Properties

	Name	Description
	AudioSourceLoop	Wrapper for AudioSource to help with looping
	CanPlay	Whether the sound can play - this is usually true unless something like an audio zone is used and the player is not in the zone.
	hideFlags	Should the object be hidden, saved with the scene or modifiable by the user? (Inherited from Object.)
	name	The name of the object. (Inherited from Object.)
	Parent	Parent game object to put sounds in

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetInstanceID	Returns the instance id of the object. (Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Initialize (Overrides WeatherMakerBaseScriptableObjectScriptInitialize.)
	MemberwiseClone	(Inherited from Object.)
	OnDestroy	OnDestroy (Overrides WeatherMakerBaseScriptableObjectScriptOnDestroy.)
	OnDisable	OnDisable (Overrides WeatherMakerBaseScriptableObjectScriptOnDisable.)
	OnEnable	OnEnable (Overrides WeatherMakerBaseScriptableObjectScriptOnEnable.)
	SetDirty	Obsolete. (Inherited from ScriptableObject.)
	Stop	Stop sounds
	ToString	Returns the name of the GameObject. (Inherited from Object.)
	Update	Update sounds (Overrides WeatherMakerBaseScriptableObjectScriptUpdate.)

Fields

	Name	Description
	AudioClips	The audio clip to play (one is chosen at random)
	Disabled	Whether this object is disabled (Inherited from WeatherMakerBaseScriptableObjectScript.)
	DurationRange	How long in seconds to play the sound, for non-looped AudioSource this is ignored, and the entire sound is played.
	FadeDuration	How long in seconds to fade in and out for looping audio sources.
	HoursOfDay	The hours in a day the sound can play, or null/empty to just use TimesOfDay.
	IntervalRange	How long in seconds to wait in between playing the sound. Set to 0 min and max to have no wait and a continous sound.
	Looping	Whether to loop the audio clip, all clips must be looping or not looping.
	Name	A name to help you keep track of the ambient sound
	TimesOfDay	The times of day the sound can play. In order to play HoursOfDay must be empty or must also match.
	VolumeRange	Range of volume for the ambient sound, a new value is chosen each time the sound is played.

Extension Methods

	Name	Description
	CachedName	Get cached name (Defined by WeatherMakerObjectExtensions.)
	SetCachedName	Put name in the cache (Defined by WeatherMakerObjectExtensions.)