Autoya

AssetBundle API

(このドキュメントはgitpitch形式からまだ変更が済んでいません)(見辛い)
(単純にAPIとその解説をするように書き換え中、 全APIの列挙を先にやっちゃおう。)

概要

AssetBundle関連のAPI
AssetBundleに関しての機能を提供する。

  • List機構
  • Preload機構
  • LoadAsset機構

MethodsとOverridePoints

MethodsはAutoya.経由で使えるメソッド、
OverridePointsはデフォルト挙動を変更する
ための変更点を記述する箇所になっている。

List feature

Methods

  • AssetBundle_DownloadAssetBundleListIfNeed
  • AssetBundle_IsAssetBundleFeatureReady
  • AssetBundle_AssetBundleList
  • AssetBundle_DiscardAssetBundleList

OverridePoints

  • OverridePoints/AssetBundleListDownloadUrl
  • OverridePoints/OnAssetBundleListGetRequest
  • OverridePoints/LoadAssetBundleListFromStorage
  • OverridePoints/StoreAssetBundleListToStorage
  • OverridePoints/DeleteAssetBundleListFromStorage
  • OverridePoints/OnRequestNewAssetBundleList
  • OverridePoints/ShouldUpdateToNewAssetBundleList

Appで現在DL可能な全てのAssetBundle(AB)の
情報が入ったList(ABList)を制御するAPI。

Listを取得することで、AB関連の全APIが
使用可能になる。

Preload feature

Methods

  • AssetBundle_Preload
  • AssetBundle_PreloadByList

OverridePoints

  • OnAssetBundlePreloadListGetRequest

1~N個のABを使用前に一括DLするAPI。

もしABが更新されていれば、最新版をDLする。

PreloadList(PL)インスタンスを生成して使うほか、

PLを返す外部サービスを用意し、
urlからPLを取得->Preloadさせることができる。

Load Asset feature

Methods

  • AssetBundle_LoadAsset[T]
  • AssetBundle_UnloadOnMemoryAssetBundles
  • AssetBundle_UnloadOnMemoryAssetBundle
  • AssetBundle_UnloadOnMemoryAsset
  • AssetBundle_DeleteAllStorageCache

OverridePoints

  • OnAssetBundleGetRequest

AssetBundle_LoadAsset[T]

ABからAssetを取り出す。

もしABがDLされていなかった場合、
DL -> 展開までを自動で行う。

実行する際、リストが更新されて入れば、必ず最新版をDLする。

AssetBundle_DownloadAssetBundleListIfNeed

必要であればABListを特定のURLから取得、
端末内に保持する。

(このへんにmdDoc)

AssetBundle_IsAssetBundleFeatureReady

ABを使用できる状態であればtrueを返す。
そうでなければfalseを返す。

(このへんにmdDoc)

AssetBundle_AssetBundleList

現在保持しているABListを返す。
もし保持していなければ空のABListを返す。

(空のaBListは、.Exists()がfalseを返す。)

(このへんにmdDoc)

AssetBundle_DiscardAssetBundleList

現在保持されているABListを削除する。
保持されているABデータは一切変更されない。

(このへんにmdDoc)

OverridePoints/AssetBundleListDownloadUrl

[AssetBundle_DownloadAssetBundleListIfNeed に対してリスト取得用のURLを提供する。

(このへんにmdDoc)

OverridePoints/OnAssetBundleListGetRequest

[AssetBundle_DownloadAssetBundleListIfNeed で外部からリストを取得する際のパラメータを指定する。

(このへんにmdDoc)

OverridePoints/LoadAssetBundleListFromStorage

[AssetBundle_DownloadAssetBundleListIfNeed 等に対して、保存してあるABListを提供する。

(このへんにmdDoc)

OverridePoints/StoreAssetBundleListToStorage

ABListの更新時に呼ばれる。
ABListを上書き保存する。

(このへんにmdDoc)

OverridePoints/DeleteAssetBundleListFromStorage

ABListの削除時に呼ばれる。
保存されているABListを削除する。

(このへんにmdDoc)

OverridePoints/OnRequestNewAssetBundleList

(このへんにmdDoc)

OverridePoints/ShouldUpdateToNewAssetBundleList

(このへんにmdDoc)

AssetBundle_Preload

urlからPreloadListを取得し、
記載されているABを端末へとキャッシュする。

(このへんにmdDoc)

AssetBundle_PreloadByList

listパラメータに記載されているABを
端末へとキャッシュする。

(このへんにmdDoc)

OverridePoints/OnAssetBundlePreloadListGetRequest

listパラメータに記載されているABを
CDNなどへリクエストする際のパラメータを指定する。

(このへんにmdDoc)

AssetBundle_LoadAsset[T]

(このへんにmdDoc)

AssetBundle_UnloadOnMemoryAssetBundles

(このへんにmdDoc)

AssetBundle_UnloadOnMemoryAssetBundle

(このへんにmdDoc)

AssetBundle_UnloadOnMemoryAsset

(このへんにmdDoc)

AssetBundle_DeleteAllStorageCache

(このへんにmdDoc)

OverridePoints/OnAssetBundleGetRequest

CDNなどからABを取得する際のパラメータを指定する。

OverridePoints/OnRequestNewAssetBundleList

OverridePoints/ShouldUpdateToNewAssetBundleList

← Persistence APIHttp API →