Point commentary node

From Valve Developer Community

Table of contents

1 Entity description 2 Keyvalues 3 Inputs 4 Outputs

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.

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

• parentname <target_destination>

Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities move with their Parent.

• start_disabled

<boolean> Start disabled

• origin

<vector (X,Y,Z)> The origin of this entity within the map.

• angles

<angles> The orientation of this entity within the map.

• commentaryfile

<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

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

• SetParent <target_destination>

Changes the entity's parent in the movement hierarchy.

• SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

• SetParentAttachmentMaintainOffset <string> [Episode One Update]

Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.

• ClearParent

Removes this entity from its current movement hierarchy.

• Enable

Enable this entity.

• Disable

Disable this entity.

• StartCommentary

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

• OnUser1-4

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

!activator = activator

• OnCommentaryStarted

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.