Frame commands

From The DarkMod Wiki
Revision as of 19:02, 12 April 2010 by Tels (talk | contribs) (add ffirst stab)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Introduction

Each animation can have commands attached. These are either global (they influence the entire animation), or per-frame (they do something at the frame with the given number).

Apart from the default D3 frame commands, the darkmod team has added a few new, useful frame commands. This page tries to describe them all.


Default Doom3 frame commands

Keyword Description Example
call calls a global script function frame 1 call overrideLegs
object_call calls a script object function frame 1 object_call ArrowInvisible
event Calls an event function Unused so far
sound Plays the referenced sound shader on the general sound channel. frame 12 sound readable_page_turn
sound_voice Plays the referenced sound shader on the voice sound channel. frame 23 sound_voice snd_sight
sound_voice2 Plays the referenced sound shader on the second voice sound channel. frame 1 sound_voice2 monster_boss_vagary_attack1


TDM frame commands

Keyword Description Example
attach Spawns an entity of the given class and attaches it with the given attach name on the given attach position. frame 42 attach atdm:prop_single_card card hand_r
detach Detach and destroy the entity at the named attachment. frame 42 detach card
drop Detach and drop to world the entity at the named attachment. frame 42 drop bucket
pickup Find the entity with the given name, then attach it as the named attachment at the given position. frame 42 pickup atdm_water_bucket_01 bucket hand_l