Skip to content

0x64 — primitive_play_paf

Primitive PAF sequence helper. It resolves a PAF id and sequence index, calls CPrimitiveAnimation::GetPafAddress, CPrimitiveAnimation::PlayPafSequence, and optionally CPrimitiveAnimation::SetOffset.

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

At a glance

Opcode0x64 (100)
HandlerCRadiScript::Command_64
SignatureCRadiScript::Command_64(int,SCR_DATA*,unsigned int,unsigned int)
Translation unitr_script_run6.cpp
Address— debug build; click for all 3
Handler size0x208 (520 bytes)
Engine nameprimitive_play_paf
FamilyPrimitives, textures, sound and movies
Command size4 + extra_words * 4 bytes

Handler behaviour

Primitive PAF sequence helper. It resolves a PAF id and sequence index, calls CPrimitiveAnimation::GetPafAddress, CPrimitiveAnimation::PlayPafSequence, and optionally CPrimitiveAnimation::SetOffset.

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

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

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

FieldRoleMeaning
has_offsetderivedWhether offset is present on this line.
paf_idinputIdentifier selecting which paf to use.
paf_modeinputMode selector for paf; the handler branches on it.
sequence_indexinputIndex selecting which sequence to act on.
slotinputIndex into a runtime table owned by this command's subsystem.
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:

  • CPrimitiveAnimation::GetPafAddress(unsigned int,unsigned int)
  • CPrimitiveAnimation::PlayPafSequence(CPafSeqInfo*)
  • CPrimitiveAnimation::SetOffset(unsigned int,short,short)

Bit masks

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

0x0080 0x0003 0x001F 0xFFFF 0x0001