danmaq Nineball Library | All Packages | All Classes | Index | Frames No Frames |
Class CTaskBGM

Package | danmaq.nineball.task
Class | public final class CTaskBGM
Implements | IDisposed, ITask

部分ループポイント対応BGMタスクです。

Public Properties

| Property | Defined by
--- | --- | ---
|  | disposed : Boolean [read-only] タスクが終了したかどうかを取得します。 | CTaskBGM
|  | isAvailablePause : Boolean [read-only] 一時停止に対応しているかどうかを取得します。 | CTaskBGM
|  | isDisposeCancel : Boolean = false 解放命令を無視するかどうかが格納されます。 解除忘れ防止のため、一度無視するたびにオフになります。 | CTaskBGM
|  | isPlay : Boolean [static][read-only] 現在再生中かどうかを取得します。 | CTaskBGM
|  | layer : uint [read-only] レイヤ値を取得します。 | CTaskBGM
|  | manager : CTaskManager [write-only] タスク管理クラスを設定します。 このクラスでは特に必要ないので何も設定しません。 | CTaskBGM
|  | mute : Boolean ミュート中かどうかを取得します。 | CTaskBGM

Public Methods

| Method | Defined by
--- | --- | ---
|  | CTaskBGM(preset:CBGMPreset, uFadeTime:uint, uLayer:uint = 0) コンストラクタ。 | CTaskBGM
|  | dispose():void 解放時に管理クラスから呼び出される処理です。 | CTaskBGM
|  | fadeAndStop():void フェードアウトを開始します。 | CTaskBGM
|  | initialize():void コンストラクタの後、タスクが管理クラスに登録された直後に、 1度だけ自動的に呼ばれます。 | CTaskBGM
|  | update():Boolean タスクを1フレーム分動かします。 | CTaskBGM

Property detail

disposed | property

`disposed:Boolean` [read-only]

タスクが終了したかどうかを取得します。

Implementation
`public function get disposed():Boolean`

isAvailablePause | property |

`isAvailablePause:Boolean` [read-only]

一時停止に対応しているかどうかを取得します。

Implementation
`public function get isAvailablePause():Boolean`

isDisposeCancel | property |

`public var isDisposeCancel:Boolean = false`

解放命令を無視するかどうかが格納されます。 解除忘れ防止のため、一度無視するたびにオフになります。

isPlay | property |

`isPlay:Boolean` [read-only]

現在再生中かどうかを取得します。

Implementation
`public static function get isPlay():Boolean`

layer | property |

`layer:uint` [read-only]

レイヤ値を取得します。

Implementation
`public function get layer():uint`

manager | property |

`manager:CTaskManager` [write-only]

タスク管理クラスを設定します。 このクラスでは特に必要ないので何も設定しません。

Implementation
`public function set manager(value:CTaskManager):void`

mute | property |

`mute:Boolean` [read-write]

ミュート中かどうかを取得します。

Implementation
`public function get mute():Boolean`
`public function set mute(value:Boolean):void`
Constructor detail

CTaskBGM | () | constructor

`public function CTaskBGM(preset:CBGMPreset, uFadeTime:uint, uLayer:uint = 0)`

コンストラクタ。

Parameters

| `preset:CBGMPreset` — BGMプリセット
| `uFadeTime:uint` — フェード時間
| `uLayer:uint` (default = `0`)`` — レイヤ番号

Method detail

dispose | () | method

`public function dispose():void`

解放時に管理クラスから呼び出される処理です。

fadeAndStop | () | method |

`public function fadeAndStop():void`

フェードアウトを開始します。

initialize | () | method |

`public function initialize():void`

コンストラクタの後、タスクが管理クラスに登録された直後に、 1度だけ自動的に呼ばれます。

update | () | method |

`public function update():Boolean`

タスクを1フレーム分動かします。

Returns

| `Boolean` — フェードするまでの間、true