0x73 — set_bgm_volume

Reads one operand and calls CRadiSound::SetBgmVolume(int,unsigned int,unsigned int).

proven— handler traced, and exercised by at least one shipped script.

At a glance

Opcode	`0x73` (115)
Handler	`CRadiScript::Command_73`
Signature	`CRadiScript::Command_73(int,SCR_DATA*,unsigned int,unsigned int)`
Translation unit	`r_script_run7.cpp`
Address	— debug build; click for all 3
Handler size	`0x38` (56 bytes)
Engine name	`set_bgm_volume`
Family	Primitives, textures, sound and movies
Command size	`4 + extra_words * 4` bytes

Handler behaviour

Reads one operand and calls CRadiSound::SetBgmVolume(int,unsigned int,unsigned int).

Encoding

The command header is one 32-bit word, as described in §3 Instruction encoding:

 31            24 23            16 15             8 7              0
+----------------+----------------+----------------+----------------+
|  flags         |  argument byte |  extra words   |  0x73          |
+----------------+----------------+----------------+----------------+

Bits 8–15 give the number of 32-bit operand words that follow. Bits 16–23 are handed to the handler as a bitfield; on character commands bit 0 normally says whether a character selector word is present. Bit 31 is the keep-going bit.

Operand fields

4 documented fields. input fields are read from the command's operand words; derived fields are computed from other fields rather than stored separately.

Field	Role	Meaning
`slot`	input	Index into a runtime table owned by this command's subsystem.
`time`	input	Ramp duration passed to SetBgmVolume, which is how music fades work.
`volume`	input	Volume target passed to CRadiSound::SetBgmVolume; 0x3FFF is the full-volume value seen in samples.
`yield`	derived	Pause the script here for one game frame; the next command runs on the following update. Lines without it keep running immediately.

Engine calls

Engine functions this handler was observed calling:

CRadiSound::SetBgmVolume(int,unsigned int,unsigned int)

Bit masks

Masks the handler applies to its argument byte or operand words:

0x0003 0xFFFF