Skip to content

0x05 — conditional_end

Conditional script end helper. It optionally calls CheckCondition; if the condition passes, or no condition is present, it calls Command_00.

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

At a glance

Opcode0x05 (5)
HandlerCRadiScript::Command_05
SignatureCRadiScript::Command_05(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run0.cpp
Address— debug build; click for all 3
Handler size0xB0 (176 bytes)
Engine nameconditional_end
FamilyScript control, flags and values
Command size4 + extra_words * 4 bytes

Handler behaviour

Conditional script end helper. It optionally calls CheckCondition; if the condition passes, or no condition is present, it calls Command_00.

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

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

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

FieldRoleMeaning
compare_controlinputBitmask controlling which optional compare values follow.
compare_from_eventderivedWhether compare is read from an event value instead of being a literal on this line.
cond_basederivedLow 7 bits of condition: which condition is evaluated.
conditionderivedCondition selector byte. The low 7 bits pick the condition (cond_base) and bit 7 inverts the result (invert). 0 means unconditional.
first_flaginputId of the first event flag the condition reads.
flag_countinputHow many flag entries follow on this line.
invertderivedBit 7 of condition: when 1 the condition result is inverted.
valueinputThe value the condition compares against.
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:

  • CRadiScript::CheckCondition(unsigned char,unsigned long,const SCR_DATA*)
  • CRadiScript::Command_00(int,SCR_DATA*,unsigned int,unsigned int)

Bit masks

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

0x00FF