Skip to content

0x25 — character_sub_anim

Resolves a character and performs sub-animation control through CCharacterAnim; one traced branch calls CCharacterAnim::StopSubAnimation().

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

At a glance

Opcode0x25 (37)
HandlerCRadiScript::Command_25
SignatureCRadiScript::Command_25(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run2.cpp
Address— debug build; click for all 3
Handler size0xF8 (248 bytes)
Engine namecharacter_sub_anim
FamilyCharacters
Command size4 + extra_words * 4 bytes

Handler behaviour

Resolves a character and performs sub-animation control through CCharacterAnim; one traced branch calls CCharacterAnim::StopSubAnimation().

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

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

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

FieldRoleMeaning
actionderivedWhich action this command performs, read from its mode or control bits. Each name is one branch of the handler, so changing it changes what the line does.
characterinputThe packed 32-bit character selector word. Its low half is the character id and byte 2 is a secondary class/variant input; see character_number and character_variant.
character_numberderivedLow 16 bits of the character selector: the character/actor id.
character_typederivedByte 2 of the character selector, where the handler treats it as a type selector rather than a variant.
explicit_charderived1 when the command carries its own character selector word, 0 when it acts on the script's current character. It corresponds to bit 0 of the handler argument and decides whether a character= word is present.
handler_modeinputMode selector for handler; 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:

  • CCharacterAnim::StopSubAnimation()
  • CCharacterManager::GetCharacterClass2(int,unsigned int,const CCharacter*,unsigned int)
  • CRadiScript::GetCharacterID(unsigned int&,unsigned int&,unsigned int*,SCR_DATA*,unsigned int)

Bit masks

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

0x0001