Logic choreographed scene

From Valve Developer Community

Table of contents

1 Entity Description 2 Keyvalues 3 Inputs 4 Outputs

Entity Description

Manages a choreographed scene of one or more actors.

For an example on how this entity can be used, see the npc_gman_overwatch prefab.

Keyvalues

• targetname <target_source>

Defines the name that other entities refer to this entity by.

• hammerid [Episode Two Update]

<integer readonly> This id is used for debugging purposes in Hammer.

• SceneFile

<scene> The VCD scene file to use.

• target(1-8)

<target_destination> Use these keyvalues to specify the resolution of Actor or Event Target names that are using a !Target# name in the VCD.

• busyactor

<choices> If an Actor is already talking...

Literal Value	Description
0	Start immediately
1	Wait for actor to finish
2 [Episode One Update]	Interrupt at next interrupt event [Episode One Update]
3 [Episode One Update]	Cancel at next interrupt event [Episode One Update]

• onplayerdeath [Episode One Update]

If set, NPC will cancel script and return to AI.

Inputs

• Kill

Removes this entity from the world.

• KillHierarchy

Removes this entity and all its children from the world.

• AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.

Format: <key> <value>

Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>

• FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

• Start

Starts playback of the scene file

• Pause

Pauses playback of the scene file

• Resume

Resumes playback of the scene if it has been paused

• Cancel

Cancels playback of the scene

• InterjectResponse <string>

Finds an actor who can respond to the specified concept string while the scene continues playing

• StopWaitingForActor

Stop waiting on an actor to stop talking.

• CancelAtNextInterrupt [Episode One Update]

Cancels playback of the scene at the next interrupt event in the scene.

Outputs

• OnUser1-4

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

!activator = activator

• OnStart

The scene has started

• OnCompletion

The scene has completed

• OnCanceled

The scene has been cancelled

• OnTrigger(1-8)

Scene trigger (1-8).

!activator = activator