stingray.ResourcePackage オブジェクト リファレンス

説明

パッケージ(.package 拡張子を使用してデータ ファイル内で定義するリソースのグループ)のロードとロード解除のためのインタフェースです。

コンストラクタとアクセサ

stingray.Application.resource_package() stingray.Application.resource_package_from_url() stingray.Mod.resource_package()

関連サンプル コード

Appkit: /simple_project.lua

その他の関連リファレンス項目

	stingray.Application.release_resource_package() stingray.Mod.release_resource_package()
	Core

この参照ページは、次の概要トピックと関連付けられています

	「ゲームプレイを作成する > Lua でスクリプトを作成する > Lua をゼロから開始する: カスタム ブート スクリプトを使用する > ブート スクリプトのサンプル」
	「ゲームプレイを作成する > Lua でスクリプトを作成する > ユーザ独自のスクリプト ファイルをロードして実行する」
	「コンテンツとリソースを管理する > ランタイムでコンテンツをロードおよびロード解除する > パッケージのロードとロード解除」
	「コンテンツとリソースを管理する > ランタイムでコンテンツをロードおよびロード解除する > 例: レベルごとの 1 つのリソース パッケージのロードおよびロード解除」
	「リリース後の作業 > ダウンロード可能なコンテンツ(DLC)とその他の追加コンテンツ」

関数

flush ( self ) パッケージ内のリソースをオンラインにします。

パラメータ

self :

stingray.ResourcePackage

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

この関数は値を返しません。

パッケージが完全にロードされていないときにこの関数を呼び出すと、パッケージがロードされるまでゲームがブロックされます。したがって、最初に has_loaded() を呼び出してパッケージがメモリにロードされているかどうかを確認することを推奨します。

has_loaded ( self ) : boolean バックグラウンド スレッドでパッケージのロードが完了しているかどうかを示します。

パラメータ

self :

stingray.ResourcePackage

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

boolean

パッケージが完全にロードされている場合は true を返します。

その他の関連リファレンス項目

stingray.ResourcePackage.flush()

load ( self ) 指定されたパッケージのロードをバックグラウンドで開始します。

パラメータ

self :

stingray.ResourcePackage

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

この関数は値を返しません。

unload ( self ) 指定されたパッケージ内のリソースをロード解除します。

パラメータ

self :

stingray.ResourcePackage

この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

戻り値

この関数は値を返しません。

リソースをロード解除する前に、ゲーム内でそれらのリソースがまだ使用されていないかどうかを確認する必要があります。