0x40 — load_background
Reads a background id, optionally through GetEventValueForScript, and calls CBackGround::LoadData.
proven— handler traced, and exercised by at least one shipped script.
At a glance
| Opcode | 0x40 (64) |
|---|---|
| Handler | CRadiScript::Command_40 |
| Signature | CRadiScript::Command_40(int,SCR_DATA*,unsigned int,unsigned int) |
| Translation unit | r_script_run4.cpp |
| Address | — debug build; click for all 3 |
| Handler size | 0x5C (92 bytes) |
| Family | Background, map, landscape and camera |
| Command size | 4 + extra_words * 4 bytes |
Handler behaviour
Reads a background id, optionally through GetEventValueForScript, and calls CBackGround::LoadData.
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 | 0x40 |
+----------------+----------------+----------------+----------------+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 |
|---|---|---|
event_value | input | Script event-value id that the condition or command reads. |
id | input | Identifier for the thing this command acts on. |
slot | input | Index into a runtime table owned by this command's subsystem. |
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:
CBackGround::LoadData(unsigned int,unsigned int,bool)CRadiScript::GetEventValueForScript(int,const SCR_DATA*)
Bit masks
Masks the handler applies to its argument byte or operand words:
0x0080 0xFFFF 0x0003