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

説明

このオブジェクトは、特定のゲームの World のサウンド イベントをコントロールするための機能へのアクセスを提供します。

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

stingray.Wwise.wwise_world()

関連サンプル コード

キャラクタ テンプレート: /player.lua

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

	stingray.Wwise.wwise_world()
	Wwise Sound

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

	「オーディオを操作する > Wwise オーディオの基本 > オーディオ ソースについて > オーディオ ソースを設定する」
	「オーディオを操作する > Wwise オーサリング ツール」
	「オーディオを操作する > Wwise Lua 関数」

リスナー

add_default_listeners ( self, listener_id ) 特定のリスナーを既定のリスナーのリストに追加します。

パラメータ

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

戻り値

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

新しいソースを作成したときに、既定のリスナーに追加されます。既定では、唯一の既定のリスナーは Wwise.LISTENER_0 です。

remove_default_listeners ( self, listener_id ) 特定のリスナーを既定のリスナーのリストから除去します。

パラメータ

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

戻り値

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

set_listener ( self, listener_id, transform ) リスナーを指定の位置に設定します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
listener_id :	integer	設定されるリスナーのインデックスです。Wwise.LISTENER_0 から Wwise.LISTENER_7 までを使用します。
transform :	stingray.Matrix4x4	指定されたリスナーの新しい位置と回転です。

戻り値

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

8 つのリスナーがサポートされます。

関連サンプル コード

Appkit: /camera_wrapper.lua Oculus VR テンプレート: /project.lua

ソース

add_soundscape_listener ( self, listener_id ) 指定されたリスナーを WwiseWorld のサウンドスケープに追加します。

パラメータ

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

戻り値

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

新しいソースが作成されると、その初期リスナー マスクが既定のリスナーのリストを使用して設定されます。この関数は、選択されたソースにさらにリスナーを割り当てることができます。

add_source_listeners ( self, source_id, listener_id ) 指定されたリスナーを指定のソースに追加します。

パラメータ

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

戻り値

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

新しいソースが作成されると、その初期リスナー マスクが既定のリスナーのリストを使用して設定されます。この関数は、選択されたソースにさらにリスナーを割り当てることができます。

has_source ( self, source_id ) : boolean 特定のソースが存在するかどうか(つまり、再生イベントがあるかどうか)を示します。

パラメータ

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

戻り値

boolean

指定された ID を持つソースが存在する場合は true、そうでない場合は false です。

remove_soundscape_listener ( self, listener_id ) 指定されたリスナーを WwiseWorld のサウンドスケープから除去します。

パラメータ

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

戻り値

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

remove_source_listeners ( self, source_id, listener_id ) 指定されたリスナーを指定のソースから除去します。

パラメータ

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

戻り値

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

set_source_pose ( self, source_id, transform ) 指定されたソースを指定の位置と回転に移動させます。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
source_id :	integer	移動させるソースの数値 ID です。
transform :	stingray.Matrix4x4	指定されたソースの新しい位置と回転です。

戻り値

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

set_source_position ( self, source_id, position ) 指定されたソースを指定された位置に移動します。

パラメータ

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

戻り値

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

イベント

destroy_manual_source ( self, source_id ) 特定のソースを破壊します。

パラメータ

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

戻り値

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

make_manual_source() により作成され、手動で削除するように構成されているソースには、ソースの破壊が必要です。ソース上で再生されているサウンドのみが残り、終了するまで再生が続行されます。たとえば、イベントがユニット ソース上で再生されており、そのソースが destroy_manual_source() により手動で破壊されると、サウンドは最後の位置まで再生を続行します。再生サウンドを別のソースにアタッチし直す方法はありません。この関数は、アクティブなイベントがない場合に自動的に破壊されるように設定されているソースは破壊しません。

関連サンプル コード

車両テンプレート: /vehicle_unit_controller.lua

get_playing_elapsed ( self, playing_id ) : number 特定のイベントが再生を開始してからの経過時間をミリ秒単位で返します。

パラメータ

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

戻り値

number

イベント再生の開始からのミリ秒単位の経過時間です。

指定された ID がサウンドの再生に対応していない場合は 0 を返します。

is_playing ( self, event_id ) : boolean 特定の再生イベントがアクティブであるかどうかを示します。

パラメータ

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

戻り値

boolean

ID が現在の再生イベントに対応する場合は true、そうでない場合は false です。

make_auto_source ( self, pose ) : integer 特定のゲーム ソースの新しい Wwise オブジェクト ソースを作成し、ソースの ID を返します。

パラメータ

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

戻り値

integer

ソースの ID です。

ソース作成中に無効なソース入力や他のエラーが発生した場合は、WwiseWorldInterface::NO_SOURCE_ID が返されます。make_auto_source により作成されたソースは、アクティブな再生イベントがない場合は自動的にクリーンアップされます。

make_auto_source ( self, unit, object ) : integer 特定のユニットが既存のユニット ゲーム ソースと一致する場合、既存のソース ID が返され、ユニット ソースのライフタイムは、アクティブな再生イベントがないときに削除されるように設定されます。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
unit :	stingray.Unit	新しいソースを作成するために使用されるユニット、または指定されたユニットに一致する既存のソースを検索するために使用されるユニットです。
object :	integer?	このパラメータには、このユニット内のオブジェクトの数値 ID を含めることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

ソースの ID です。

既存の一致するユニット ソースが見つからない場合は、新しいユニット ソースが作成され、その ID が返されます。ソース作成中に無効なソース入力や他のエラーが発生した場合は、WwiseWorldInterface::NO_SOURCE_ID が返されます。make_auto_source により作成されたソースは、アクティブな再生イベントがない場合は自動的にクリーンアップされます。

make_auto_source ( self, position, rotation ) : integer 特定のゲーム ソースの新しい Wwise オブジェクト ソースを作成し、ソースの ID を返します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
position :	stingray.Vector3	新しい Wwise ソースを作成するために使用される Vector3 です。
rotation :	stingray.Quaternion?	このパラメータは、ソース回転を示す Quaternion にすることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

ソースの ID です。

ソース作成中に無効なソース入力や他のエラーが発生した場合は、WwiseWorldInterface::NO_SOURCE_ID が返されます。make_auto_source により作成されたソースは、アクティブな再生イベントがない場合は自動的にクリーンアップされます。

make_manual_source ( self, unit, object ) : integer 指定されたユニットが既存のユニットのゲーム ソースと一致する場合、既存のソースの ID が返され、ユニット ソースのライフタイムは手動で削除するように設定されます。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
unit :	stingray.Unit	新しいソースを作成するために使用されるユニット、または指定されたユニットに一致する既存のソースを検索するために使用されるユニットです。
object :	integer?	このパラメータには、このユニット内のオブジェクトの数値 ID を含めることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

ソースの ID です。

既存の一致するユニット ソースが見つからない場合は、新しいユニット手動削除ソースが作成され、その ID が返されます。ソース作成中に無効なソース入力や他のエラーが発生した場合は、WwiseWorldInterface::NO_SOURCE_ID が返されます。ソースをクリーンアップするために、make_manual_source() により作成されるソースには、destroy_manual_source() が呼び出されることが必要です。

make_manual_source ( self, position, rotation ) : integer 特定のゲーム ソースの新しい Wwise オブジェクト ソースを作成し、ソースの ID を返します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
position :	stingray.Vector3	新しい Vector3 ソースです。
rotation :	stingray.Quaternion?	このパラメータは、ソース回転を示す Quaternion にすることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

ソースの ID です。

ソース作成中に無効なソース入力や他のエラーが発生した場合は、WwiseWorldInterface::NO_SOURCE_ID が返されます。ソースをクリーンアップするために、make_manual_source() により作成されるソースには、destroy_manual_source() が呼び出されることが必要です。

make_manual_source ( self, pose ) : integer 特定のゲーム ソースの新しい Wwise オブジェクト ソースを作成し、ソースの ID を返します。

パラメータ

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

戻り値

integer

ソースの ID です。

ソース作成中に無効なソース入力や他のエラーが発生した場合は、WwiseWorldInterface::NO_SOURCE_ID が返されます。ソースをクリーンアップするために、make_manual_source() により作成されるソースには、destroy_manual_source() が呼び出されることが必要です。

関連サンプル コード

車両テンプレート: /vehicle_unit_controller.lua

pause_all ( self ) Wwise ワールドで現在再生されているすべてのイベントを一時停止します。

パラメータ

self :

stingray.WwiseWorld

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

戻り値

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

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

stingray.WwiseWorld.resume_all() stingray.WwiseWorld.resume_event()

pause_event ( self, playing_id ) 数値 ID と指定されている ID とが一致する、現在再生されているイベントを一時停止します。

パラメータ

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

戻り値

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

イベントは resume_event() または resume_all() への呼び出しで再開できます。

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

stingray.WwiseWorld.resume_all() stingray.WwiseWorld.resume_event()

resume_all ( self ) 以前に pause_event() または pause_all() への呼び出しにより一時停止した、Wwise ワールドのすべてのイベントの再生を再開します。

パラメータ

self :

stingray.WwiseWorld

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

戻り値

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

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

stingray.WwiseWorld.pause_event()

resume_event ( self, playing_id ) pause_event() または pause_all() への呼び出しにより、以前に一時停止したイベントの再生を再開します。

パラメータ

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

戻り値

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

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

stingray.WwiseWorld.pause_event()

stop_all ( self ) Wwise ワールドで現在再生されているすべてのイベントを停止します。

パラメータ

self :

stingray.WwiseWorld

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

戻り値

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

関連サンプル コード

Appkit: /simple_project.lua

stop_audio_input_sound ( self, playing_id ) trigger_audio_input_sound によって作成されたオーディオ入力プラグイン サウンドを停止します。

パラメータ

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

戻り値

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

これは無限ループ サウンドを停止するために必要です。trigger_audio_input_event インタフェースにより作成されたサウンドは、通常のイベント メソッドで停止できます。

stop_event ( self, playing_id ) 数値 ID と指定されている ID が一致する、現在再生されているイベントを停止します。

パラメータ

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

戻り値

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

trigger_audio_input_event ( self, event_name, source_id, stream_source ) : integer バッファから供給されるオーディオ データを使用してイベントを再生するには、Wwise オーディオ入力プラグインを使用します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
source_id :	integer	サウンドを再生するゲーム オブジェクトです。
event_name :	string	イベントの名前です。
stream_source :	stingray.SoundStreamSource	サウンドの再生に使用するオーディオ ストリーム データです。

戻り値

integer

新しい再生イベントの数値 ID。再生が失敗した場合は nil です。

trigger_audio_input_sound ( self, source_id, stream_source ) : integer イベントを使用せず、バッファから供給されるオーディオ データを使用してサウンドを再生するには、Wwise オーディオ入力プラグインを使用します。

パラメータ

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

戻り値

integer

新しい再生イベントの数値 ID。再生が失敗した場合は nil です。

ループの場合、サウンドは stop_audio_input_sound で停止する必要があります。

trigger_event ( self, event_name ) : integer, integer 新しいイベントを発行し、特定の WwiseWorld のグローバル配置なしソースの ID を返します。

パラメータ

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

戻り値

integer	新しい再生イベントの数値 ID です。
integer	新しいイベントを再生するソースの ID です。

このソースは、2D のサウンドの再生に使用されます。

関連サンプル コード

基本テンプレート: /player.lua 車両テンプレート: /vehicle_unit_controller.lua Oculus VR テンプレート: /player.lua

trigger_event ( self, event_name, source_id ) : integer, integer 新しいイベントを発行し、特定の WwiseWorld のグローバル配置なしソースの ID を返します。

パラメータ

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

戻り値

integer	新しい再生イベントの数値 ID です。
integer	新しいイベントを再生するソースの ID です。

このソースは、2D のサウンドの再生に使用されます。

trigger_event ( self, event_name, pose ) : integer, integer 指定されたソースの新しいイベントを発行し、再生イベントの ID と、イベントで再生しているソースの ID を返します。

パラメータ

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

戻り値

integer	新しい再生イベントの数値 ID です。
integer	新しいイベントを再生するソースの ID です。

新しく作成されたソースは、アクティブな再生イベントがない場合は破壊されます。

trigger_event ( self, event_name, position, rotation ) : integer, integer 指定されたソースの新しいイベントを発行し、再生イベントの ID と、イベントで再生しているソースの ID を返します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
event_name :	string	イベントの名前です。
position :	stingray.Vector3	新しい Wwise ソースを作成するために使用される Vector3 です。
rotation :	stingray.Quaternion?	このパラメータは、ソース回転を示す Quaternion にすることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer	新しい再生イベントの数値 ID です。
integer	新しいイベントを再生するソースの ID です。

新しく作成されたソースは、アクティブな再生イベントがない場合は破壊されます。

trigger_event ( self, event_name, unit, unit_object ) : integer, integer 特定のユニットが既存のユニット ソースと一致している場合、既存のソース ID が返されます。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
event_name :	string	イベントの名前です。
unit :	stingray.Unit	新しいソースを作成するために使用されるユニット、または指定されたユニットに一致する既存のソースを検索するために使用されるユニットです。
unit_object :	integer?	このパラメータには、特定のユニット内のオブジェクトの数値インデックスを含めることができます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer	新しい再生イベントの数値 ID です。
integer	新しいイベントを再生するソースの ID です。

既存の一致するユニット ソースが見つからない場合は、新しいユニット ソースが作成され、その ID が返されます。新しく作成されたソースは、アクティブな再生イベントがない場合は破壊されます。

パラメータ

post_trigger ( self, source_id, name ) 特定のソースの特定のトリガーが起動します。

パラメータ

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

戻り値

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

set_global_parameter ( self, name, value ) 特定のパラメータ名と値を、対応する Wwise グローバル パラメータにルーティングします。

パラメータ

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

戻り値

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

set_source_parameter ( self, source_id, name, value ) 特定のパラメータ名と値を、指定されたソースの対応する Wwise オブジェクト パラメータにルーティングします。

パラメータ

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

戻り値

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

関連サンプル コード

車両テンプレート: /vehicle_unit_controller.lua

set_switch ( self, group, state, source_id ) スイッチ グループ Wwise オブジェクトの状態を設定します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
group :	string	状態グループです。Wwise プロジェクトの状態設定と一致している必要があります。
state :	string	現在の状態です。Wwise プロジェクトの状態設定と一致している必要があります。
source_id :	integer	関連付けられているソース ID です。

戻り値

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

これは、イベントに適用するスイッチ値のソースでイベントを発生させる前に設定する必要があります。make_source は、イベント発生前にスイッチを設定する新しいソース ID を取得するための trigger_event の前に使用します。

環境

reset_aux_environment ( self ) 0 のコントロール出力値を送信して、すべての補助環境母線を無効にします。

パラメータ

self :

stingray.WwiseWorld

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

戻り値

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

特定のワールド内のすべてのソースに適用されます。

reset_environment_for_source ( self ) 0 のコントロール出力値を送信して、特定のソースのすべての補助環境母線を無効にします。

パラメータ

self :

stingray.WwiseWorld

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

戻り値

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

set_dry_environment ( self, value ) このワールド内のすべてのソースにドライ母線値を設定します。

パラメータ

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

戻り値

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

既定のドライ値は、1 (フル)です。

set_dry_environment_for_source ( self, source, value ) 特定のソースの、特定の環境母線ドライ値を設定します。

パラメータ

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

戻り値

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

既定のすべてのソースのドライ値は、1 (フル)です。

set_environment ( self, name, value ) 指定された環境母線を、このワールドのすべてのソースに指定された制御出力ボリュームに設定します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
name :	string	補助バス名です。
value :	number	送信される母線値です。0 から 1。

戻り値

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

set_environment_for_source ( self, source, name, value ) 特定の母線を、特定のソースに指定された制御出力ボリュームに設定します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
source :	integer	ソースです。
name :	string	補助バス名です。
value :	number	送信される母線値です。0 から 1。

戻り値

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

それぞれのソースは、最大で MAX_ENVIRONMENTS_PER_OBJECT (4)の、固有であるアクティブ補助母線環境を持つことができます。

set_obstruction_and_occlusion ( self, listener, source, obstruction, occlusion ) 特定のソースとリスナーのオブストラクションとオクルージョンの値を設定します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
listener :	integer	リスナーの ID です。Wwise.LISTENER_0 から Wwise.LISTENER_7 までを使用します。
source :	integer	ソースです。
obstruction :	number	ソースがブロックされる度合いです。0 から 1。
occlusion :	number	ソースが隠される度合いです。0 から 1。

戻り値

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

サウンドスケープ

add_soundscape_unit_source ( self, event_name, unit, unit_object, shape_type, shape_scale, positioning, min_distance, max_distance, trigger_range ) : integer サウンドスケープ ソースをワールドに追加します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
event_name :	string	ソースがアクティブになったときにトリガする Wwise イベント名です。
unit :	stingray.Unit	配置に使用するユニットです。ユニットの位置、スケール、回転を使用して、シェイプの境界を定義します。
unit_object :	integer	ユニット オブジェクト ノード インデックスです。
shape_type :	integer	サウンドスケープ ソースのシェイプ列挙値です。サポートされる値: Wwise.SHAPE_POINT、Wwise.SHAPE_SPHERE、Wwise.SHAPE_BOX。
shape_scale :	any(number, stingray.Vector3)	Wwise.SHAPE_BOX の場合は Vector3 の範囲、Wwise.SHAPE_POINT および Wwise.SHAPE_SPHERE の場合は浮動です。SHAPE_POINT の値は無視されます。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
positioning :	integer	シェイプ内の Wwise ソースの動作です。サポートされる値: Wwise.POSITIONING_CLOSEST_TO_LISTENER、Wwise.POSITIONING_RANDOM_IN_SHAPE、Wwise.POSITIONING_RANDOM_AROUND_LISTENER。
min_distance :	number	ランダム リスナー配置の最小距離。
max_distance :	number	ランダム リスナー配置の最大距離です。
trigger_range :	number?	イベントを発生させるために使用する任意指定の範囲です。既定値では、イベントの最大減衰距離が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

integer

サウンドスケープ ソースの ID です。この ID は、Wwise ソース ID ではありません。これはサウンドスケープの追加/除去機能に固有のものです。

remove_soundscape_source ( self, ss_source_id ) ワールドからサウンドスケープ ソースを除去します。

パラメータ

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

戻り値

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

set_obstruction_and_occlusion_for_soundscape_source ( self, ss_source, obstruction, occlusion ) 特定のサウンドスケープ ソースに対してオブストラクションとオクルージョンの値を設定します。

パラメータ

self :	stingray.WwiseWorld	この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
ss_source :	integer	add_soundscape_source から返されたサウンドスケープ ソース ID です。
obstruction :	number	ソースがブロックされる度合いです。0 から 1。
occlusion :	number	ソースが隠される度合いです。0 から 1。

戻り値

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

サウンドスケープ ソース ID は、add_soundscape_unit_source から返されます。