0x31 — character_collision_setup
Resolves a character, writes collision-related fields, then calls CCharacterManager::GetCharacterCollisionClass and CCharacterCollision::SetupCollisionData.
proven— handler traced, and exercised by at least one shipped script.
At a glance
| Opcode | 0x31 (49) |
|---|---|
| Handler | CRadiScript::Command_31 |
| Signature | CRadiScript::Command_31(int,SCR_DATA*,unsigned int,unsigned int) |
| Translation unit | r_script_run2.cpp |
| Address | — debug build; click for all 3 |
| Handler size | 0x4C0 (1216 bytes) |
| Engine name | character_collision_setup |
| Family | Characters |
| Command size | 4 + extra_words * 4 bytes |
Handler behaviour
Resolves a character, writes collision-related fields, then calls CCharacterManager::GetCharacterCollisionClass and CCharacterCollision::SetupCollisionData.
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 | 0x31 |
+----------------+----------------+----------------+----------------+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.
| Field | Role | Meaning |
|---|---|---|
character | input | The 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. |
collision_flag | input | on sets, off clears one flag in the character's collision record; leave it out to leave the flag as it was. No mapped code reads the flag back, so the name says where it is written, not what it does. |
float_0c | derived | Float written to the engine record at offset +0x0c; the field's meaning is not yet named. |
float_10 | derived | Float written to the engine record at offset +0x10; the field's meaning is not yet named. |
float_80 | input | Float written to the engine record at offset +0x80; the field's meaning is not yet named. |
float_84 | derived | Float written to the engine record at offset +0x84; the field's meaning is not yet named. |
float_88 | input | Float written to the engine record at offset +0x88; the field's meaning is not yet named. |
float_array | input | Raw word introducing the float-array block: float_array_count floats follow. |
float_array_count | derived | How many float array entries follow on this line. |
float_array_values | input | The collision float array written to the record. |
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:
CCharacterCollision::SetupCollisionData()CCharacterManager::GetCharacterClass2(int,unsigned int,const CCharacter*,unsigned int)CCharacterManager::GetCharacterCollisionClass(const CCharacter*)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 0x0007 0x0002 0x0004 0x0008 0x0010 0x0020 0x0040 0x0080 0x0100