Class BackgroundAudio

An interface for music, used to generate playing a clip.

Inheritance

BackgroundAudio

Namespace: OmiyaGames.Audio

Assembly: cs.temp.dll.dll

Syntax

public abstract class BackgroundAudio : ScriptableObject

Remarks

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Revision	Description
Version: 1.0.0 Date: 4/12/2022 Author: Taro Omiya	Initial verison.
Version: 1.1.0 Date: 6/30/2022 Author: Taro Omiya	Adding new property, IsPausedOnTimeStop.

Fields

MENU_ORDER

Declaration

public const int MENU_ORDER = 210

Field Value

Type	Description
Int32

Properties

MainAudioSourcePrefab

A prefab reference to use as basis for constructing a new BackgroundAudio.Player.

Declaration

public AudioSource MainAudioSourcePrefab { get; }

Property Value

Type	Description
AudioSource

Methods

GeneratePlayer(GameObject)

Sets up attach with s and other items to play the music.

Declaration

public abstract BackgroundAudio.Player GeneratePlayer(GameObject attach)

Parameters

Type	Name	Description
GameObject	attach	The script generated s will be attached or be child of.

Returns

Type	Description
BackgroundAudio.Player

Reset()

Resets this file. Primarily used in the Unity Inspector.

Declaration

public virtual void Reset()