0x0B — script_stop

Script stop helper. It can check a condition, resolve a character abstraction, search a script slot, and call StopScript.

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

At a glance

Opcode	`0x0B` (11)
Handler	`CRadiScript::Command_0b`
Signature	`CRadiScript::Command_0b(int,SCR_DATA*,unsigned int,unsigned int)`
Translation unit	`r_script_run0.cpp`
Address	— debug build; click for all 3
Handler size	`0x17C` (380 bytes)
Engine name	`script_stop`
Family	Script control, flags and values
Command size	`4 + extra_words * 4` bytes

Handler behaviour

Script stop helper. It can check a condition, resolve a character abstraction, search a script slot, and call StopScript.

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

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

10 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`.
`cond_base`	derived	Low 7 bits of `condition`: which condition is evaluated.
`condition`	derived	Condition selector byte. The low 7 bits pick the condition (`cond_base`) and bit 7 inverts the result (`invert`). `0` means unconditional.
`invert`	input	Bit 7 of `condition`: when `1` the condition result is inverted.
`lookup_script_id`	input	Identifier selecting which `lookup script` to use.
`mode`	input	Handler path selector taken from the argument byte. The meaning is specific to each command.
`script_id`	input	Identifier selecting which `script` to use.
`script_lookup_control`	input	Bitmask controlling which optional `script lookup` values follow.
`selector`	input	Sub-selector byte choosing which variant of the command's behaviour runs.
`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:

CRadiScript::CheckCondition(unsigned char,unsigned long,const SCR_DATA*)
CRadiScript::GetAbstractionCharacterNumber(unsigned int&,unsigned int&,const SCR_DATA*)
CRadiScript::SearchScriptSlot(unsigned int,unsigned int,int,int,unsigned int)
CRadiScript::StopScript(SCR_DATA*)

Bit masks

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

0xFFFF 0x000F 0x00FF 0x0010