Point commentary node

From Valve Developer Community
Revision as of 23:40, 31 October 2005 by Robin Walker (talk | contribs) (Created.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Template:Wrongtitle

Entity Description

The core entity used in the Commentary System. It appears as a floating speech bubble for the player to +USE, which then starts the commentary playing.

Keyvalues

Unlike most entities, the point_commentary_node is often hand-edited into the commentary files, and as a result, there are some extra keys listed here that Hammer would normally fill in automatically for you.

  • origin
<vector (X,Y,Z)> The origin of this entity within the map.
  • angles
<angles> The orientation of this entity within the map.
<sound> The commentary sound file that should be played when this node is used by the player.
  • commentaryfile_nohdr
<sound> The commentary sound file that should be played when this node is used by the player. If the player has HDR turned off, this file will be used instead of the commentaryfile. If this entry is not specified, the base commentaryfile entry will still be used.
  • speakers
<string> The name of the speakers of the commentary sound file(s). Will be displayed in the HUD while the commentary sound file is playing.
  • precommands
<string> A semi-colon delimited list of commands that should entered into the console when the commentary file starts playing. e.g. ai_disable 1;mat_wireframe 1;
  • postcommands
<string> A semi-colon delimited list of commands that should entered into the console when the commentary file finishes playing. e.g. ai_disable 0;mat_wireframe 0;
  • viewposition
<target_destination> The targetname of an entity to which the players view should move while the commentary file is playing. When the commentary file finishes, the players view will move back to the place it was when the commentary started.
  • viewtarget
<target_destination> The targetname of an entity that the players view should track while the commentary file is playing. The player will not be able to control their view while the commentary file plays.
  • prevent_movement
<boolean> If true, the player will not be able to move while the commentary sound file is playing.


Inputs

Force the commentary node to start.
  • StartUnstoppableCommentary
Force the commentary node to start, and don't allow the player to stop it in any way.

Outputs

Fires when this commentary starts playing.
  • OnCommentaryStopped
Fires when this commentary stops playing. May be caused by the commentary file finishing, or by the player stopping it manually (if the node wasn't started with the StartUnstoppableCommentary input). If the node controls the players view with the viewposition key, then this input will be fired when the players view has finished returning to its original position.