Skip to content

0x71 — play_bgm

Calls CRadiSound::PlayBgm(unsigned int) with handler_arg_byte & 3.

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

At a glance

Opcode0x71 (113)
HandlerCRadiScript::Command_71
SignatureCRadiScript::Command_71(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run7.cpp
Address— debug build; click for all 3
Handler size0x28 (40 bytes)
Engine nameplay_bgm
FamilyPrimitives, textures, sound and movies
Command size4 + extra_words * 4 bytes

Handler behaviour

Calls CRadiSound::PlayBgm(unsigned int) with handler_arg_byte & 3.

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   |  0x71          |
+----------------+----------------+----------------+----------------+

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

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

FieldRoleMeaning
modeinputHandler path selector taken from the argument byte. The meaning is specific to each command.
yieldderivedPause 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::PlayBgm(unsigned int)

Bit masks

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

0x0003