Skip to content

0x21 — character_delete_data

Resolves a character and calls either CCharacterManager::DeleteCharacter or CCharacterManager::DetachData_Main depending on command flags.

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

At a glance

Opcode0x21 (33)
HandlerCRadiScript::Command_21
SignatureCRadiScript::Command_21(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run2.cpp
Address— debug build; click for all 3
Handler size0xC0 (192 bytes)
Engine namecharacter_delete_data
FamilyCharacters
Command size4 + extra_words * 4 bytes

Handler behaviour

Resolves a character and calls either CCharacterManager::DeleteCharacter or CCharacterManager::DetachData_Main depending on command flags.

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

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

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

FieldRoleMeaning
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.
deletederivedSet when the command deletes rather than creates.
detach_data_maskinputBitmask selecting which parts of detach data apply.
flag7inputBoolean option 7 taken from the handler's argument byte.
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:

  • CCharacterManager::DeleteCharacter(CCharacter*,unsigned int)
  • CCharacterManager::DetachData_Main(CCharacter*,unsigned int,int)
  • 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