Module rrise::query_params

The sound engine parameter query interface.

Remark The functions in this namespace are thread-safe, unless stated otherwise.

Warnings

⚡ Unless noted otherwise in the function definition that it will not acquire the main audio lock, the functions in this namespace might stall for several milliseconds before returning (as they cannot execute while the main sound engine thread is busy). They should therefore not be called from any game critical thread, such as the main game loop.

⚡ There might be a significant delay between a Sound Engine call (such as PostEvent) and the information being reflected in a Query (such as GetIsGameObjectActive).

Enums

RtpcValueType

Enum used to request a specific RTPC Value.

Functions

get_listener_position

Get a listener’s position.

get_listeners

Get a game object’s listeners.

get_listeners_count

Get a game object’s listeners count.

get_position

Get the position of a game object.

get_rtpc_value

Get the value of a real-time parameter control.

get_state

Get the state of a state group.

get_switch

Get the state of a switch group.