0x72 — bgm_control
Reads one operand and calls either CRadiSound::StopBgm or CRadiSound::PauseBgm depending on handler_arg_byte & 0x80.
proven— handler traced, and exercised by at least one shipped script.
At a glance
| Opcode | 0x72 (114) |
|---|---|
| Handler | CRadiScript::Command_72 |
| Signature | CRadiScript::Command_72(int,SCR_DATA*,unsigned int,unsigned int) |
| Translation unit | r_script_run7.cpp |
| Address | — debug build; click for all 3 |
| Handler size | 0x58 (88 bytes) |
| Engine name | bgm_control |
| Family | Primitives, textures, sound and movies |
| Command size | 4 + extra_words * 4 bytes |
Handler behaviour
Reads one operand and calls either CRadiSound::StopBgm or CRadiSound::PauseBgm depending on handler_arg_byte & 0x80.
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 | 0x72 |
+----------------+----------------+----------------+----------------+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 |
|---|---|---|
mode | input | Handler path selector taken from the argument byte. The meaning is specific to each command. |
pause | input | Argument-byte bit 7: 1 calls CRadiSound::PauseBgm, 0 calls StopBgm. |
value | input | The value the condition compares against. |
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::PauseBgm(int,int)CRadiSound::StopBgm(int,int)
Bit masks
Masks the handler applies to its argument byte or operand words:
0xFFFF 0x0080 0x0003