Logic choreographed scene: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (spelling)
No edit summary
Line 6: Line 6:
Manages a choreographed scene of one or more actors.
Manages a choreographed scene of one or more actors.


==Entity Values==
==Keyvalues==
===Keys===


* '''Name''' ''targetname <target_source>'' 
* {{kv targetname}}
** The name that other entities refer to this entity by.
* '''Scene file''' ''SceneFile <scene>''
** The VCD scene file to use.
* '''Target 1''' ''target1 <target_destination>''
* '''Target 2''' ''target2 <target_destination>''
* '''Target 3''' ''target3 <target_destination>''
* '''Target 4''' ''target4 <target_destination>''
* '''Target 5''' ''target5 <target_destination>''
* '''Target 6''' ''target6 <target_destination>''
* '''Target 7''' ''target7 <target_destination>''
* '''Target 8''' ''target8 <target_destination>''
* '''If an Actor is talking...''' ''busyactor <choices>''
** What to do if an actor this scene needs is already talking when this scene is told to start.


* '''SceneFile'''
: <scene> The VCD scene file to use.


===Inputs===
* '''target''(1-8)'''''
: <target_destination>
 
* '''busyactor'''
: {{boolean}} Wait for the actor to finish?
 
==Inputs==
 
* {{i targetname}}


* '''Kill'''
** Removes this entity from the world.
* '''KillHierarchy''' 
** Removes this entity and all its children from the world.
* '''AddOutput''' ''<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>''
** Adds an entity I/O connection to this entity. Very dangerous, use with care
* '''FireUser1'''
** Causes this entity's OnUser1 output to be fired.
* '''FireUser2'''
** Causes this entity's OnUser2 output to be fired.
* '''FireUser3'''
** Causes this entity's OnUser3 output to be fired.
* '''FireUser4'''
** Causes this entity's OnUser4 output to be fired.
* '''Start'''
* '''Start'''
** Starts playback of the scene file
: Starts playback of the scene file
 
* '''Pause'''
* '''Pause'''
** Pauses playback of the scene file
: Pauses playback of the scene file
 
* '''Resume'''
* '''Resume'''
** Resumes playback of the scene if it has been paused
: Resumes playback of the scene if it has been paused
 
* '''Cancel'''
* '''Cancel'''
** Cancels playback of the scene
: Cancels playback of the scene
 
* '''InterjectResponse <string>'''
* '''InterjectResponse <string>'''
** Finds an actor who can respond to the specified concept string while the scene continues playing
: Finds an actor who can respond to the specified concept string while the scene continues playing
 
* '''StopWaitingForActor'''
* '''StopWaitingForActor'''
** Stop waiting on an actor to stop talking.
: Stop waiting on an actor to stop talking.


==Outputs==


===Outputs===
* {{o targetname}}


* '''OnUser1'''
** Fired in response to FireUser1 input.
* '''OnUser2'''
** Fired in response to FireUser2 input.
* '''OnUser3'''
** Fired in response to FireUser3 input.
* '''OnUser4'''
** Fired in response to FireUser4 input.
* '''OnStart'''
* '''OnStart'''
** The scene has started
: The scene has started
 
* '''OnCompletion'''
* '''OnCompletion'''
** The scene has completed
: The scene has completed
 
* '''OnCanceled'''
* '''OnCanceled'''
** The scene has been canceled
: The scene has been canceled
* '''OnTrigger1'''
 
** Scene trigger 1
* '''OnTrigger''(1-8)'''''
* '''OnTrigger2'''
: Scene trigger ''(1-8)''
** Scene trigger 2
* '''OnTrigger3'''
** Scene trigger 3
* '''OnTrigger4'''
** Scene trigger 4
* '''OnTrigger5'''
** Scene trigger 5
* '''OnTrigger6'''
** Scene trigger 6
* '''OnTrigger7'''
** Scene trigger 7
* '''OnTrigger8'''
** Scene trigger 8


[[Category:Entities]]
[[Category:Entities]]

Revision as of 20:32, 11 July 2005

Template:Wrongtitle

Entity Description

Entity Name: logic_choreographed_scene

Manages a choreographed scene of one or more actors.

Keyvalues

  • SceneFile
<scene> The VCD scene file to use.
  • target(1-8)
<target_destination>
  • busyactor
<boolean> Wait for the actor to finish?

Inputs

  • 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.

Outputs

  • OnStart
The scene has started
  • OnCompletion
The scene has completed
  • OnCanceled
The scene has been canceled
  • OnTrigger(1-8)
Scene trigger (1-8)