WwiseWorld - stingray.WwiseWorld 오브젝트 참조 - Stingray Lua API 참조
설명
이 오브젝트는 특정 게임 World에 대한 사운드 이벤트를 제어하는 함수에 대한 액세스를 제공합니다.
생성자 및 액세서 
관련 샘플 코드
기타 관련 참조 항목
관련 도움말 항목
리스너
 |
add_default_listeners ( self, listener_id ) 기본 리스너 목록에 지정된 리스너를 추가합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
listener_id : | integer | 기본값으로 설정할 리스너의 ID입니다. Wwise.LISTENER_0부터 Wwise.LISTENER_7까지 사용합니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
새 소스를 생성하면 기본 리스너에 추가됩니다. 기본적으로 유일한 기본 리스너는 Wwise.LISTENER_0입니다.
| |
remove_default_listeners ( self, listener_id )지정된 리스너를 기본 리스너 목록에서 제거합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
listener_id : | integer | 기본 리스너 목록에서 제거할 리스너의 ID입니다. Wwise.LISTENER_0부터 Wwise.LISTENER_7까지 사용합니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_listener ( self, listener_id, transform )리스너를 지정된 위치로 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
listener_id : | integer | 설정할 리스너의 색인입니다. Wwise.LISTENER_0부터 Wwise.LISTENER_7까지 사용합니다. |
transform : | 지정된 리스너의 새로운 위치 및 회전입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
8개 리스너가 지원됩니다.
관련 샘플 코드
소스
| |
add_soundscape_listener ( self, listener_id )지정된 리스너를 WwiseWorld의 음풍경에 추가합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
listener_id : | integer | 할당할 리스너의 숫자 ID입니다. Wwise.LISTENER_0부터 Wwise.LISTENER_7까지 사용합니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
새 소스를 생성하면 기본 리스너 목록과 함께 초기 리스너 마스크가 설정됩니다. 이 함수를 사용하여 추가 리스너를 선택된 소스에 할당할 수 있습니다.
| |
add_source_listeners ( self, source_id, listener_id )지정된 리스너를 지정된 소스에 추가합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 소스의 숫자 ID입니다. |
listener_id : | integer | 할당할 리스너의 숫자 ID입니다. Wwise.LISTENER_0부터 Wwise.LISTENER_7까지 사용합니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
새 소스를 생성하면 기본 리스너 목록과 함께 초기 리스너 마스크가 설정됩니다. 이 함수를 사용하여 추가 리스너를 선택된 소스에 할당할 수 있습니다.
| |
has_source ( self, source_id ) : boolean지정된 소스가 존재하는지(즉, 재생 중인 이벤트가 있는지) 여부를 나타냅니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 검색할 소스의 숫자 ID입니다. |
boolean |
지정된 ID의 소스가 있으면 true를, 그렇지 않으면 false를 반환합니다. |
| |
remove_soundscape_listener ( self, listener_id )지정된 리스너를 WwiseWorld의 음풍경에서 제거합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
listener_id : | integer | 소스에서 제거할 리스너의 숫자 ID입니다. Wwise.LISTENER_0부터 Wwise.LISTENER_7까지 사용합니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
remove_source_listeners ( self, source_id, listener_id )지정된 리스너를 지정된 소스에서 제거합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 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 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 이동할 소스의 숫자 ID입니다. |
transform : | 지정된 소스의 새 위치 및 회전입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_source_position ( self, source_id, position )지정된 소스를 지정된 위치로 이동합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 이동할 소스의 숫자 ID입니다. |
position : | 지정된 소스의 새 위치입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
이벤트
| |
destroy_manual_source ( self, source_id )지정된 소스를 삭제합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 기존 소스의 숫자 ID입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
make_manual_source()를 통해 생성되어 수동으로 삭제하도록 구성된 소스의 경우 소스 삭제가 필요합니다. 현재 소스에서 재생 중인 모든 사운드는 고립되고, 완료할 때까지 계속 재생됩니다. 예를 들어, 유닛 소스에서 이벤트가 재생 중인데 해당 소스를 destroy_manual_source()를 통해 수동으로 삭제하면 이 사운드는 마지막 위치에서 계속 재생됩니다. 재생 중인 사운드를 다른 소스에 다시 연결할 방법은 없습니다. 이 함수는 활성 이벤트가 없을 때 자동으로 삭제되도록 설정된 소스를 삭제하지 않습니다.
관련 샘플 코드
| |
get_playing_elapsed ( self, playing_id ) : number지정된 이벤트가 재생을 시작한 이후 경과한 시간(밀리초)을 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
playing_id : | integer | 위치를 획득하기 위한 재생 중 이벤트의 숫자 ID입니다. |
number |
이벤트 재생이 시작된 이후의 시간(밀리초)입니다. |
지정된 ID가 재생 중 사운드와 일치하지 않는 경우 0을 반환합니다.
| |
is_playing ( self, event_id ) : boolean지정된 재생 중 이벤트가 활성 상태인지 여부를 나타냅니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_id : | integer | 활성 이벤트의 숫자 ID입니다. |
boolean |
ID가 현재 재생 중 이벤트와 일치하면 true를, 그렇지 않으면 false를 반환합니다. |
| |
make_auto_source ( self, pose ) : integer지정된 게임 소스에 대한 새로운 Wwise 오브젝트 소스를 생성하고, 이 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
pose : | 새로운 Wwise 소스를 생성하는 데 사용되는 Matrix4x4입니다. |
integer |
소스의 ID입니다. |
소스 생성 중 유효하지 않은 소스 입력 또는 기타 오류가 발생하는 경우에는 WwiseWorldInterface::NO_SOURCE_ID가 반환됩니다. make_auto_source를 통해 생성된 소스는 활성 재생 중 이벤트가 없는 경우 자동으로 정리됩니다.
| |
make_auto_source ( self, unit, object ) : integer지정된 유닛이 기존 유닛 게임 소스와 일치하는 경우에는 기존 소스 ID가 반환되고, 활성 재생 중 이벤트가 없을 때 삭제되도록 유닛 소스 수명이 설정됩니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
unit : | 새 소스를 만들거나 지정된 유닛에 맞는 기존 소스를 찾는 데 사용할 유닛입니다. | |
object : | integer? | 이 매개변수에는 해당 유닛 내 오브젝트의 숫자 ID가 포함될 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
소스의 ID입니다. |
일치하는 기존 유닛 소스가 없는 경우에는 새 유닛 소스가 생성되고, 그 ID가 반환됩니다. 소스 생성 중 유효하지 않은 소스 입력 또는 기타 오류가 발생하는 경우에는 WwiseWorldInterface::NO_SOURCE_ID가 반환됩니다. make_auto_source를 통해 생성된 소스는 활성 재생 중 이벤트가 없는 경우 자동으로 정리됩니다.
| |
make_auto_source ( self, position, rotation ) : integer지정된 게임 소스에 대한 새로운 Wwise 오브젝트 소스를 생성하고, 이 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
position : | 새 Wwise 소스를 생성하는 데 사용되는 Vector3입니다. | |
rotation : | 이 매개변수는 소스 회전을 나타내는 Quaternion일 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
소스의 ID입니다. |
소스 생성 중 유효하지 않은 소스 입력 또는 기타 오류가 발생하는 경우에는 WwiseWorldInterface::NO_SOURCE_ID가 반환됩니다. make_auto_source를 통해 생성된 소스는 활성 재생 중 이벤트가 없는 경우 자동으로 정리됩니다.
| |
make_manual_source ( self, unit, object ) : integer지정된 유닛이 기존 유닛 게임 소스와 일치하는 경우 기존 소스 ID가 반환되고, 수동으로 삭제하도록 유닛 소스 수명이 설정됩니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
unit : | 새 소스를 만들거나 지정된 유닛에 맞는 기존 소스를 찾는 데 사용할 유닛입니다. | |
object : | integer? | 이 매개변수에는 해당 유닛 내 오브젝트의 숫자 ID가 포함될 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
소스의 ID입니다. |
일치하는 기존 유닛 소스가 없는 경우에는 새 유닛 수동 삭제 소스가 생성되고, 그 ID가 반환됩니다. 소스 생성 중 유효하지 않은 소스 입력 또는 기타 오류가 발생하는 경우에는 WwiseWorldInterface::NO_SOURCE_ID가 반환됩니다. make_manual_source()를 통해 생성된 소스의 경우 이 소스를 정리하려면 destroy_manual_source()를 호출해야 합니다.
| |
make_manual_source ( self, position, rotation ) : integer지정된 게임 소스에 대한 새로운 Wwise 오브젝트 소스를 생성하고, 이 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
position : | 새로운 Vector3 소스입니다. | |
rotation : | 이 매개변수는 소스 회전을 나타내는 Quaternion일 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
소스의 ID입니다. |
소스 생성 중 유효하지 않은 소스 입력 또는 기타 오류가 발생하는 경우에는 WwiseWorldInterface::NO_SOURCE_ID가 반환됩니다. make_manual_source()를 통해 생성된 소스의 경우 이 소스를 정리하려면 destroy_manual_source()를 호출해야 합니다.
| |
make_manual_source ( self, pose ) : integer지정된 게임 소스에 대한 새로운 Wwise 오브젝트 소스를 생성하고, 이 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
pose : | 새로운 Matrix4x4 소스입니다. |
integer |
소스의 ID입니다. |
소스 생성 중 유효하지 않은 소스 입력 또는 기타 오류가 발생하는 경우에는 WwiseWorldInterface::NO_SOURCE_ID가 반환됩니다. make_manual_source()를 통해 생성된 소스의 경우 이 소스를 정리하려면 destroy_manual_source()를 호출해야 합니다.
관련 샘플 코드
| |
pause_all ( self )Wwise 표준에서 현재 재생 중인 모든 이벤트를 일시 중지합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. |
| 이 함수는 아무 값도 반환하지 않습니다. |
기타 관련 참조 항목
| |
pause_event ( self, playing_id )숫자 ID가 지정된 ID와 일치하는 현재 재생 중 이벤트를 일시 중지합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
playing_id : | integer | 일시 중지할 이벤트의 숫자 ID입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
이 이벤트는 resume_event() 또는 resume_all()을 호출하여 다시 시작할 수 있습니다.
기타 관련 참조 항목
| |
resume_all ( self )이전에 pause_event() 또는 pause_all()을 호출하여 일시 중지한 Wwise 표준 내 모든 이벤트의 재생을 다시 시작합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. |
| 이 함수는 아무 값도 반환하지 않습니다. |
기타 관련 참조 항목
| |
resume_event ( self, playing_id )이전에 pause_event() 또는 pause_all()을 호출하여 일시 중지한 이벤트의 재생을 다시 시작합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
playing_id : | integer | 다시 시작할 이벤트의 숫자 ID입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
기타 관련 참조 항목
| |
stop_all ( self )Wwise 표준에서 현재 재생 중인 모든 이벤트를 중지합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. |
| 이 함수는 아무 값도 반환하지 않습니다. |
관련 샘플 코드
| |
stop_audio_input_sound ( self, playing_id )trigger_audio_input_sound를 통해 생성한 Audio Input Plugin 사운드를 중지합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
playing_id : | integer | trigger_audio_input_sound를 통해 생성한 재생 중 사운드입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
이 함수는 무한 루프 사운드를 중지하는 데 필요합니다. trigger_audio_input_event 인터페이스를 통해 생성한 사운드는 일반 이벤트 메서드를 통해 중지할 수 있습니다.
| |
stop_event ( self, playing_id )숫자 ID가 지정된 ID와 일치하는 현재 재생 중 이벤트를 중지합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
playing_id : | integer | 중지할 이벤트의 숫자 ID입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
trigger_audio_input_event ( self, event_name, source_id, stream_source ) : integerWwise Audio Input Plugin으로 버퍼에서 공급된 오디오 데이터를 사용하여 이벤트를 재생합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 사운드를 재생할 게임 오브젝트입니다. |
event_name : | string | 이벤트의 이름입니다. |
stream_source : | 사운드 재생에 사용할 오디오 스트림 데이터입니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID를 반환하거나, 재생에 실패하면 nil을 반환합니다. |
| |
trigger_audio_input_sound ( self, source_id, stream_source ) : integerWwise Audio Input Plugin으로 버퍼에서 공급된 오디오 데이터를 사용하여, 이벤트 사용 없이 사운드를 재생합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 사운드를 재생할 게임 오브젝트입니다. |
stream_source : | 사운드 재생에 사용할 오디오 스트림 데이터입니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID를 반환하거나, 재생에 실패하면 nil을 반환합니다. |
루프되는 사운드는 stop_audio_input_sound를 통해 중지해야 합니다.
| |
trigger_event ( self, event_name ) : integer, integer새로운 이벤트를 트리거하고, 지정된 WwiseWorld에 대한 위치 미지정 전역 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_name : | string | 이벤트의 이름입니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID입니다. |
integer |
새로운 이벤트를 재생 중인 소스의 ID입니다. |
이 소스는 2D 사운드를 재생하는 데 사용됩니다.
관련 샘플 코드
| |
trigger_event ( self, event_name, source_id ) : integer, integer새로운 이벤트를 트리거하고, 지정된 WwiseWorld에 대한 위치 미지정 전역 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_name : | string | 이벤트의 이름입니다. |
source_id : | integer | 이벤트를 트리거하기 위한 이미 존재하는 소스 ID입니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID입니다. |
integer |
새로운 이벤트를 재생 중인 소스의 ID입니다. |
이 소스는 2D 사운드를 재생하는 데 사용됩니다.
| |
trigger_event ( self, event_name, pose ) : integer, integer지정된 소스에 대한 새 이벤트를 트리거하고, 재생 중 이벤트의 ID 및 이벤트가 재생 중인 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_name : | string | 이벤트의 이름입니다. |
pose : | 새로운 Wwise 소스를 생성하는 데 사용되는 Matrix4x4입니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID입니다. |
integer |
새로운 이벤트를 재생 중인 소스의 ID입니다. |
새로 생성된 소스는 활성 재생 중 이벤트가 없으면 삭제됩니다.
| |
trigger_event ( self, event_name, position, rotation ) : integer, integer지정된 소스에 대한 새 이벤트를 트리거하고, 재생 중 이벤트의 ID 및 이벤트가 재생 중인 소스의 ID를 반환합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_name : | string | 이벤트의 이름입니다. |
position : | 새 Wwise 소스를 생성하는 데 사용되는 Vector3입니다. | |
rotation : | 이 매개변수는 소스 회전을 나타내는 Quaternion일 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID입니다. |
integer |
새로운 이벤트를 재생 중인 소스의 ID입니다. |
새로 생성된 소스는 활성 재생 중 이벤트가 없으면 삭제됩니다.
| |
trigger_event ( self, event_name, unit, unit_object ) : integer, integer지정된 유닛이 기존 유닛 소스와 일치하는 경우 기존 소스 ID가 반환됩니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_name : | string | 이벤트의 이름입니다. |
unit : | 새 소스를 만들거나 지정된 유닛에 맞는 기존 소스를 찾는 데 사용할 유닛입니다. | |
unit_object : | integer? | 이 매개변수에는 지정된 유닛 내 오브젝트의 숫자 색인이 포함될 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
새로운 재생 중 이벤트의 숫자 ID입니다. |
integer |
새로운 이벤트를 재생 중인 소스의 ID입니다. |
일치하는 기존 유닛 소스가 없는 경우에는 새 유닛 소스가 생성되고, 그 ID가 반환됩니다. 새로 생성된 소스는 활성 재생 중 이벤트가 없으면 삭제됩니다.
매개변수
| |
post_trigger ( self, source_id, name )지정된 소스에 대해 지정된 트리거를 트리거합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 소스 ID입니다. |
name : | string | 트리거 이름입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_global_parameter ( self, name, value )지정된 매개변수 이름 및 값의 경로를 해당하는 Wwise 전역 매개변수로 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
name : | string | 경로를 설정할 매개변수의 이름입니다. |
value : | number | 매개변수에 대한 숫자 값입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_source_parameter ( self, source_id, name, value )지정된 매개변수 이름 및 값의 경로를 지정된 소스의 해당하는 Wwise 오브젝트 매개변수로 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source_id : | integer | 소스의 숫자 ID입니다. |
name : | string | 경로를 설정할 매개변수의 이름입니다. |
value : | number | 매개변수에 대한 숫자 값입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
관련 샘플 코드
| |
set_switch ( self, group, state, source_id )스위치 그룹 Wwise 오브젝트의 상태를 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
group : | string | 상태 그룹입니다. Wwise 프로젝트 상태 설정과 일치해야 합니다. |
state : | string | 현재 상태입니다. Wwise 프로젝트 상태 설정과 일치해야 합니다. |
source_id : | integer | 연관된 소스 ID입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
스위치 값이 이벤트에 적용되게 하려면 소스에 대한 이벤트를 트리거하기 전에 이 함수를 설정해야 합니다. trigger_event 전에 make_source를 사용하여 이벤트 트리거 전에 스위치를 설정하기 위한 새로운 소스 ID를 획득합니다.
환경
| |
reset_aux_environment ( self )모든 보조 환경 버스에 대한 0 제어 출력값을 전송하여 해당 버스를 비활성화합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. |
| 이 함수는 아무 값도 반환하지 않습니다. |
지정된 표준 내 모든 소스에 적용됩니다.
| |
reset_environment_for_source ( self )지정된 소스의 모든 보조 환경 버스에 대한 0 제어 출력값을 전송하여 해당 버스를 비활성화합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_dry_environment ( self, value )이 표준 내 모든 소스에 대한 건조 버스 값을 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
value : | number | 전송할 버스 값입니다. 범위는 0에서 1까지입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
건조 값의 기본값은 1(최대)입니다.
| |
set_dry_environment_for_source ( self, source, value )지정된 소스에 대한 지정된 환경 버스 건조 값을 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
source : | integer | 소스입니다. |
value : | number | 전송할 버스 값입니다. 범위는 0에서 1까지입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
모든 소스에 대한 건조 값의 기본값은 1(최대)입니다.
| |
set_environment ( self, name, value )지정된 환경 버스를 이 표준 내 모든 소스에 대해 지정된 제어 출력 볼륨으로 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
name : | string | 보조 버스 이름입니다. |
value : | number | 전송할 버스 값입니다. 범위는 0에서 1까지입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_environment_for_source ( self, source, name, value )지정된 버스를 지정된 소스에 대해 지정된 제어 출력 볼륨으로 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 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 도움말 항목 또는 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 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
event_name : | string | 소스가 활성화될 때 트리거할 Wwise 이벤트 이름입니다. |
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 | Random Around Listener 위치 지정을 위한 최소 거리입니다. |
max_distance : | number | Random Around Listener 위치 지정을 위한 최대 거리입니다. |
trigger_range : | number? | 이벤트를 트리거하는 데 사용할 범위(선택 사항)입니다. 기본적으로 이벤트의 최대 감쇠 거리가 사용됩니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다. |
integer |
음풍경 소스의 ID입니다. 이 ID는 Wwise 소스 ID가 아닙니다. 이는 음풍경 추가/제거 기능에만 사용되는 ID입니다. |
| |
remove_soundscape_source ( self, ss_source_id )표준에서 음풍경 소스를 제거합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
ss_source_id : | integer | 음풍경 소스 ID입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
| |
set_obstruction_and_occlusion_for_soundscape_source ( self, ss_source, obstruction, occlusion )지정된 음풍경 소스에 대한 차단 및 폐색 값을 설정합니다.
|
self : | 이 함수가 작동하는 오브젝트 인스턴스를 지정합니다. 콜론 : 호출 구문을 사용하여 이 오브젝트의 인스턴스에 대해 이 함수를 호출할 수도 있습니다. 그렇게 하는 경우에는 이 매개변수를 생략해야 합니다. 자세한 내용은 이 Stingray 도움말 항목 또는 Lua 설명서의 이 페이지를 참조하십시오. | |
ss_source : | integer | add_soundscape_source를 통해 반환된 음풍경 소스 ID입니다. |
obstruction : | number | 소스가 차단되는 정도입니다. 범위는 0에서 1까지입니다. |
occlusion : | number | 소스가 폐색되는 정도입니다. 범위는 0에서 1까지입니다. |
| 이 함수는 아무 값도 반환하지 않습니다. |
add_soundscape_unit_source를 통해 반환된 음풍경 소스 ID입니다.