Comp choreo sceneset: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Icon + the new TeamSpens template; Internal Names; New description; Removed the 'TargetName' templates ['/transforms/sceneset.py' doesn't seem to care about any of it, except for one which is 'targetname']. One comp entity down for the day)
Line 1: Line 1:
{{point ent|comp_choreo_screenset|game=TeamSpen's Hammer Addons|internal=1}} It is also available in {{P2CE}}[[Portal 2: Community Edition]]. It finds the closest entity of a given type, then outputs various values depending on the keyvalues set.
{{Teamspens point|comp_choreo_screenset|sprite=Comp_choreo_sceneset}} It chains set of [[Choreography|choreography]] .VCD scenes together, and allows quick but basic configuration of the choreography. When the map is compiled, this entity converted into a{{ent|logic_choreographed_scene}}}entity, with its given KVs / I/O transferred into it.


Available by default in {{P2CE}}[[Portal 2: Community Edition]].
<!--__TOC__-->
==KeyValues==
==KeyValues==
{{KV|Delay between each|float|Add a delay between each scene.}}
{{KV|Delay between each|intn=delay|float|Add a delay between each scene.}}
{{KV|Clean up after starting|choices|If set, Kill choreo scenes after starting so they only play once. If set, the Cancel input will not work properly.}}
{{KV|Clean up after starting|intn=only_once|choices|If set, Kill choreo scenes after starting so they only play once. If set, the Cancel input will not work properly.}}
:* 0 : No
:* 0 : No
:* 1 : Yes
:* 1 : Yes
{{KV|If an actor is talking...|choices|What to do if an actor in this scene is already talking when this scene is told to start.}}
{{KV|If an actor is talking...|intn=busyactor|choices|What to do if an actor in this scene is already talking when this scene is told to start.}}
:* 0 : Start immediately
:* 0 : Start immediately
:* 1 : Wait for actor to finish
:* 1 : Wait for actor to finish
:* 2 : Interrupt at next interrupt event
:* 2 : Interrupt at next interrupt event
:* 3 : Cancel at next interrupt event
:* 3 : Cancel at next interrupt event
{{KV|On player death|choices|What should this entity do if the player dies?}}
{{KV|On player death|intn=onplayerdeath|choices|What should this entity do if the player dies?}}
:* 0 : Do nothing
:* 0 : Do nothing
:* 1 : Cancel Script and return to AI
:* 1 : Cancel Script and return to AI
{{KV|Scene 1 (scene01) to Scene 20 (scene20)|scene|Scenes to chain}}
{{KV|Scene 1|intn=scene01|to=Scene 20|intn2=scene20|scene|Scenes to chain}}
{{KV Targetname}}
{{minititle|Base}}
{{KV|[[targetname|Name]]|intn=targetname|string|The name that other entities refer to this entity by.}}
{{KV|[[Origin]] (X Y Z)|intn=origin|coordinates|The position of this entity's center in the world. Rotating entities typically rotate around their origin.}}


==Inputs==
==Inputs==
{{IO|Start|Start the choreo sequence playing.}}
{{IO|Start|Start the choreo sequence set playing.}}
{{IO|Stop|Stop the choreo sequence at any point.}}
{{IO|Stop|Stop the choreo sequence set at any point.}}
{{I Targetname}}


==Outputs==
==Outputs==
{{IO|OnStart|Fired when the sequence starts.}}
{{IO|OnStart|Fired when the sequence set starts.}}
{{IO|OnFinish|Fired when the sequence is complete.}}
{{IO|OnFinish|Fired when the sequence set is complete.}}
{{O Targetname}}


==See also==
==See also==
* [[TeamSpen's Hammer Addons]]
* [[TeamSpen's Hammer Addons]]

Revision as of 00:51, 14 May 2021

Template:Teamspens point It chains set of choreography .VCD scenes together, and allows quick but basic configuration of the choreography. When the map is compiled, this entity converted into alogic_choreographed_scene}entity, with its given KVs / I/O transferred into it.

Available by default in Portal 2: Community EditionPortal 2: Community Edition.

KeyValues

Delay between each (delay) <float>
Add a delay between each scene.
Clean up after starting (only_once) <choices>
If set, Kill choreo scenes after starting so they only play once. If set, the Cancel input will not work properly.
  • 0 : No
  • 1 : Yes
If an actor is talking... (busyactor) <choices>
What to do if an actor in this scene is already talking when this scene is told to start.
  • 0 : Start immediately
  • 1 : Wait for actor to finish
  • 2 : Interrupt at next interrupt event
  • 3 : Cancel at next interrupt event
On player death (onplayerdeath) <choices>
What should this entity do if the player dies?
  • 0 : Do nothing
  • 1 : Cancel Script and return to AI
Scene 1 (scene01) to Scene 20 (scene20) <scene>
Scenes to chain

Base:

Name (targetname) <string>
The name that other entities refer to this entity by.
Origin (X Y Z) (origin) <coordinates>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.

Inputs

Start
Start the choreo sequence set playing.
Stop
Stop the choreo sequence set at any point.

Outputs

OnStart
Fired when the sequence set starts.
OnFinish
Fired when the sequence set is complete.

See also