Skip to content

0x26 — character_attach_parent

Parent attach/collision helper. It resolves one or two characters, searches SSF names, and calls CCharacterManager::AttachParent, CBackGround::AttachParent, or CCharacterCollision::SetCollisionAttribute.

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

At a glance

Opcode0x26 (38)
HandlerCRadiScript::Command_26
SignatureCRadiScript::Command_26(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run2.cpp
Address— debug build; click for all 3
Handler size0x39C (924 bytes)
Engine namecharacter_attach_parent
FamilyCharacters
Command size4 + extra_words * 4 bytes

Handler behaviour

Parent attach/collision helper. It resolves one or two characters, searches SSF names, and calls CCharacterManager::AttachParent, CBackGround::AttachParent, or CCharacterCollision::SetCollisionAttribute.

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

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

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

FieldRoleMeaning
attach_modeinputMode selector for attach; the handler branches on it.
backgroundinputSet when the command targets the background rather than a character.
background_attach_flaginputBoolean option controlling background attach.
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.
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.
parentinputThe object being attached to.
parent_characterderivedLow half of the parent selector: the parent's character id.
parent_sourceinputWhere parent is read from.
parent_variantderivedByte 2 of the parent selector: a secondary class input for the parent.
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::AttachParent(CCharacter*,CHierarchicalObject*,unsigned int)
  • CCharacterCollision::SetCollisionAttribute(unsigned int,unsigned int)
  • CCharacterManager::AttachParent(CCharacter*,CCharacter*,const char*,unsigned int)
  • CCharacterManager::GetCharacterClass2(int,unsigned int,const CCharacter*,unsigned int)
  • CRadiScript::GetAbstractionCharacterNumber(unsigned int&,unsigned int&,const SCR_DATA*)
  • CRadiScript::GetCharacterID(unsigned int&,unsigned int&,unsigned int*,SCR_DATA*,unsigned int)
  • CSsfHandler::SearchName("Root")
  • CSsfHandler::SearchName(const char*) const

Bit masks

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

0x0001 0x0010 0x0002 0xFFFF 0x00FF 0x0003