Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VideoAsset

動画リソースを表すクラス。 本クラスのインスタンスをゲーム開発者が直接生成することはない。 game.jsonによって定義された内容をもとに暗黙的に生成されたインスタンスを、 Scene#assets、またはGame#assetsによって取得して利用する。

Hierarchy

Implements

Index

Constructors

constructor

  • new VideoAsset(id: string, assetPath: string, width: number, height: number, system: VideoSystem, loop: boolean, useRealSize: boolean): VideoAsset

Properties

Private _loop

_loop: boolean

Private _system

_system: VideoSystem

Private _useRealSize

_useRealSize: boolean

height

height: number

hint

id

id: string

onDestroyed

onDestroyed: Trigger<Asset>

originalPath

originalPath: string

path

path: string

realHeight

realHeight: number

動画の本来の高さ。

この値は参照のためにのみ公開されている。ゲーム開発者はこの値を変更してはならない。

realWidth

realWidth: number

動画の本来の幅。

この値は参照のためにのみ公開されている。ゲーム開発者はこの値を変更してはならない。

width

width: number

Methods

Private _assetPathFilter

  • _assetPathFilter(path: string): string
  • Parameters

    • path: string

    Returns string

Private Abstract _load

  • アセットの読み込みを行う。

    ゲーム開発者がアセット読み込み失敗時の挙動をカスタマイズする際、読み込みを再試行する場合は、 (このメソッドではなく) AssetLoadFailureInfo#cancelRetry に真を代入する必要がある。

    Parameters

    • loader: AssetLoadHandler

      読み込み結果の通知を受け取るハンドラ

    Returns void

Abstract asSurface

destroy

  • destroy(): void

destroyed

  • destroyed(): boolean

Abstract getPlayer

inUse

  • inUse(): boolean
  • 現在利用中で解放出来ない Asset かどうかを返す。 戻り値は、利用中である場合真、でなければ偽である。

    本メソッドは通常 false が返るべきである。 例えば Sprite の元画像として使われているケース等では、その Sprite によって AssetSurface に変換されているべきで、 Asset が利用中で解放出来ない状態になっていない事を各プラットフォームで保障する必要がある。

    唯一、例外的に本メソッドが true を返すことがあるのは音楽を表す Asset である。 BGM等はシーンをまたいで演奏することもありえる上、 演奏中のリソースのコピーを常に各プラットフォームに強制するにはコストがかかりすぎるため、 本メソッドは true を返し、適切なタイミングで Asset が解放されるよう制御する必要がある。

    Returns boolean

initialize

play

  • Parameters

    • Optional _loop: boolean

    Returns VideoPlayer

stop

  • stop(): void
  • Returns void

Generated using TypeDoc