View source for Scripted sequence

[[File:scripted_sequence.png|right|300px]]
{{this is a|point entity|name=scripted_sequence}} It is used to make an [[NPC]] play scripted animations.

A <code>scripted_sequence</code> typically takes a Target NPC which can be set to either move to the sequence's position or play the sequence's animation at the NPC's current position. When the NPC is ready to begin the sequence, it will play the specified animation(s) in a special scripted state which may or may not be interrupted depending on the <code>scripted_sequence</code>'s settings.

{{tip|Multiple scripted sequences of the same name will frame-synchronize their animations once all the actors have moved to position. This allows tight interaction between actors (one actor grabbing another, hitting them, etc.)}}
{{tip|Scripted sequences can suppress various AI functions, including using [[Response System|responses]]. The input '''EnableSpeakWhileScripting''' exists for [[npc_citizen|Citizens]] (and other descendants of <code>CAI_PlayerAlly</code> class), allowing to use responses while in a scripted sequence. '''DisableSpeakWhileScripting''' works the opposite way.}}

__TOC__
{{clr}}

== Script flow ==
Whenever a <code>scripted_sequence</code> plays with a valid Target NPC, it uses a special flow to make the NPC play its animations in specific, coordinated ways:

# Unless the "Start on Spawn" flag ticked, the <code>scripted_sequence</code> remains inert until it is triggered. It will remain inert until the <code>BeginSequence</code> input is received or it is used by a previous <code>scripted_sequence</code>.
# Upon being triggered, the <code>scripted_sequence</code> will look for the nearest NPC specified in "Target NPC".
# When a NPC is found, it will either move to the <code>scripted_sequence</code>'s position or begin standing still depending on the "Move to Position" setting.
# When the NPC reaches the <code>scripted_sequence</code>, it will play the "Pre-Action Idle Animation" if it is set to wait (see below). It will play the animation until all conditions are satisfied. If the script is not set to wait for anything, it will skip this step.
# The <code>scripted_sequence</code> fires its <code>OnBeginSequence</code> output.
# If the <code>scripted_sequence</code> has an Entry Animation, the NPC will play it. If the script does not have an entry animation, it will skip this step.
# The NPC plays the Action Animation. If no action animation is specified in the script, it will skip this step.
# If the <code>scripted_sequence</code> has a Post-Action Idle Animation, the NPC will play it. If no post-action idle animation is specified in the script, it will skip this step. If the "Loop in Post Idle" spawnflag is set, the NPC will continue to play the post-action idle animation until the script is canceled.
# The <code>scripted_sequence</code> fires its <code>OnEndSequence</code> output.
# If the <code>scripted_sequence</code> has a Next Script, the NPC is handed to the target script and this process is repeated automatically. If not, the NPC returns to regular behavior.

There are a few external factors which can modify this flow:

* If the sequence was triggered by the "Start on Spawn" flag or the <code>MoveToPosition</code> input, the NPC will play the Pre-Action Idle Animation until the <code>BeginSequence</code> input was received. If <code>BeginSequence</code> was used to begin with, it will proceed as normal.
* If the sequence shares its name with other sequences, it will wait for other NPCs to get into position before starting, playing the Pre-Action Idle Animation until all actors are in position. When the script has no remaining dependencies, it will proceed as normal.
* If the Target NPC was asleep (via "Sleep State" or <code>Sleep</code>) when it was grabbed, it will awaken automatically without firing <code>OnWake</code>.
* If the Pre-Idle Idle Animation is the same as the Action Animation, the pre-action idle animation will freeze on its first frame, waiting for the script to start to play the full animation. {{confirm}}

== Keyvalues ==
{{KV Targetname}}

{{KV Parentname}}

{{KV Angles}}

{{KV DXLevelChoice}}

{{KV|Target NPC|intn=m_iszEntity|target_destination|The name or class name (such as 'npc_zombie') of an NPC to use for this script.}}

{{KV|Pre Action Idle Animation|intn=m_iszIdle|string|The name of the sequence (such as "idle01") or activity (such as 'ACT_IDLE') to play before the action animation if the NPC must wait for the script to be triggered. Use "Start on Spawn" flag or "MoveToPosition" input to play this idle animation.}}

{{KV|Entry Animation|intn=m_iszEntry|string|The name of the sequence (such as 'reload02') or activity (such as 'ACT_RELOAD') to play when the sequence starts, before transitioning to play the main action sequence.}}

{{KV|Action Animation|intn=m_iszPlay|string|The name of the main sequence (such as 'reload02') or activity (such as 'ACT_RELOAD') to play.}}

{{KV|Post Action Idle Animation|intn=m_iszPostIdle|string|The name of the sequence (such as 'idle01') or activity (such as 'ACT_IDLE') to play after the action animation.}}

{{KV|Custom Move Animation|intn=m_iszCustomMove|string|Used in conjunction with the 'Custom movement' setting for the 'Move to Position' property, specifies the sequence (such as 'crouch_run01') or activity (such as 'ACT_RUN') to use while moving to the scripted position.}}

{{KV|Loop Action Animation?|intn=m_bLoopActionSequence|bool|Repeat permamently "Action animation"? See "Action Animation."}}

{{KV|Synch Post Idles|intn=m_bSynchPostIdles|bool|}}

{{KV|Search Radius|intn=m_flRadius|radius|Radius to search within for an NPC to use. 0 searches everywhere.}}

{{KV|Repeat Rate ms|intn=m_flRepeat|bool|How long NPC will repeat "Action Animation". See "Action Animation". Useless with "Loop Action Animation?"}}

{{KV|Move to Position|intn=m_fMoveTo|choices|How the NPC will walk to this scripted_sequence.}}
:{| class=standard-table
! Literal Value || Description
|-
| 0 || No
|-
| 1 || Walk
|-
| 2 || Run
|-
| 3 || Custom movement
|-
| 4 || Instantaneous
|-
| 5 || No - Turn to Face
|}
{{note|Despite the name, "Turn to Face" actually means turning to ''match'' scripted_sequence's ''own'' facing direction, and not the actor turning to face ''it''.}}
{{note|Does not seem to do anything in {{hla|1}}, actors will simply walk}}
{{KV|Next Script|intn=m_iszNextScript|target_destination|The name of the script to run immediately after this script completes. The NPC will not return to AI between the two scripts.}}

{{KV|Ignore Gravity on NPC during Script|intn=m_bIgnoreGravity|bool|If this is set to 'Yes', the NPC will not be subject to gravity while playing this script}}

{{KV|Disable NPC collisions during Script|intn=m_bDisableNPCCollisions|bool|Useful for when NPCs playing scripts must interpenetrate while riding on trains, elevators, etc. This only disables collisions between the NPCs in the script and must be enabled on BOTH scripted_sequences.}}

{{KV|On Player death|intn=onplayerdeath|bool|If set, NPC will cancel script and return to AI.}}

== Flags ==
{{Fl|4|Repeatable}}
{{Fl|8|Leave Corpse|Forces NPC corpse to remain rather than fade out. {{confirm|This only seems to be valid for NPCs which don't ragdoll on death (e.g. GoldSrc-era NPCs)}}}}
{{Fl|16|Start on Spawn|Makes the script search for a NPC and move to its position upon spawning, playing the Pre-Action Idle Animation until <code>BeginSequence</code> is received.}}
{{Fl|32|No Interruptions|Prevents the NPC from being interrupted by damage, etc.}}
{{Fl|64|Override AI|Overrides the NPC's current state to play the script, regardless of whether they're in combat or otherwise.}}
{{Fl|128|Don't Teleport NPC at End|Prevents the script from teleporting the NPC to the last animation's end position when the script is finished.}}
{{Fl|256|Loop in Post Idle|Makes the NPC loop the Post-Action Idle Animation after it finishes playing the Action Animation.}}
{{Fl|512|Priority Script|Stops other scripts from stealing this script's spot in a NPC's queue.}}
{{Fl|1024|Search Cyclically|Searches for the next entity from the last one found.|nofgd=1}}
{{Fl|2048|No Complaints|Suppresses developer warnings.|nofgd=1}}
{{Fl|4096|Allow NPC Death|The NPC using this scripted sequence may die without interrupting the scene. (used for scripted deaths)}}

== Inputs ==
{{I Targetname}}

{{I Parentname}}

{{IO|BeginSequence|Summons an NPC to act out the scripted sequence.|}}

{{IO|MoveToPosition|Summons an NPC to the script location. They will play their scripted idle (or "ACT_IDLE" if none is specified) until "BeginSequence" is triggered.|}}
{{bug|Don't use it for [[npc_antlion| npc_antlion]]! Seems it's overriding ai behaviour, when npc try to fly from high ground to lower as the result we have instance flying stuck with looped animation. (at least with Source SDK 2006), better use BeginSequence. Also set a delay before executing this, around 0.5 or other, depends on height and how many you spawn, don't move them all at same time from window (they will stuck), set a delay!}}
{{IO|CancelSequence|Stops the scripted sequence. If fired after a sequence starts, this input will not take effect until the NPC finishes playing the scripted action animation.}}

== Outputs ==
{{O Targetname}}

{{IO|OnBeginSequence|Fires when the action animation begins playing.|}}

{{IO|OnEndSequence|Fires when the action animation completes.|}}

{{IO|OnScriptEvent01|to=OnScriptEvent08|Fires when a 'trigger' anim event occurs while playing the script. Use { event 1003 framenum ''(1-8)'' } in the QC.|}}

{{IO|OnFoundNPC|since=mapbase|Fires when a target NPC is found and begins moving to play the script.|}}

== Locating animations ==

You can use the model tab in the entity window.

''Or''

You can use the [http://developer.valvesoftware.com/wiki/Model_Viewer Half-life Model Viewer] tool to see all the available sequences(Animations) for the model you're using.
You can find the application in the Source SDK.

When you've launched the tool go to File and load the model you want. Then go to the Sequence tab and select an animation from the dropdown menu to get the model you've select to play that animation or sequence.

'''What it looks like:'''
[[File:Hlmw.jpg|500px]]

== See also ==
* The [[npc_zombie_prone]] and [[npc_zombie_slump]] prefabs, providing examples of use.
* [[Activity List]] - a list of activities for use with this entity.
* [[aiscripted_schedule]] - a similar entity.
* [[falling headcrab tutorial]] - A tutorial for how to make a headcrab fall, using this entity.
* [[Actbusy]] - An alternative to <code>scripted_sequence</code> which doesn't involve setting a NPC in a scripted state.

[[Category:Entities]]