Skip to content

0x46 — background_stop_animation

Reads a background animation name payload and calls CBackGround::StopAnimation.

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

At a glance

Opcode0x46 (70)
HandlerCRadiScript::Command_46
SignatureCRadiScript::Command_46(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run4.cpp
Address— debug build; click for all 3
Handler size0x70 (112 bytes)
Engine namebackground_stop_animation
FamilyBackground, map, landscape and camera
Command size4 + extra_words * 4 bytes

Handler behaviour

Reads a background animation name payload and calls CBackGround::StopAnimation.

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

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.

FieldRoleMeaning
nameinputObject or animation name this line acts on, as text. The engine reads it as a NUL-terminated string; name_fill covers the bytes after the terminator.
name_sourceinputSelects where a name operand comes from, such as an inline four-word string.
stop_modeinputMode selector for stop; the handler branches on it.
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:

  • CBackGround::StopAnimation(const char*,unsigned int)

Bit masks

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

0x0003