Commentary configuration file: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(→‎Commentary root section: Auto line breaks would rock)
(Redirect.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
The commentary system is largely unknown. The current revision of this article reflects data gathered from [[Half-Life 2: Lost Coast|Lost Coast]]'s commentary.
#REDIRECT [[Commentary System]]
 
This file is in Valve's 'configuration file' format.
 
<br />
 
==Commentary root section==
Name: Commentary<br />
This is the root section for commentary.
 
===Entity section===
Name: entity<br />
Parent: "commentary"<br />
These are individual commentary entities. This element can be used more than once to add multiple commentary points to a level.
 
====Commentary entity details====
Parent: "entity"<br />
 
'''"classname"''' &nbsp;&nbsp;&mdash; Type of entity to display (usually [[point_commentary_node]])<br />
'''"origin"''' &nbsp;&nbsp;&mdash; Origin of the item (x y z  hammer position notation)<br />
'''"commentaryfile"''' &nbsp;&nbsp;&mdash; WAV file to play<br />
'''"commentaryfile_nohdr"''' &nbsp;&nbsp;&mdash; WAV file to play if HDR is disabled (will play above if not specified) (optional)<br />
'''"speakers"''' &nbsp;&nbsp;&mdash; The name of the speaker(s)<br />
'''"targetname"''' &nbsp;&nbsp;&mdash; [[targetname|Name of the entity]]<br />
'''"angles"''' &nbsp;&nbsp;&mdash; (x y z  hammer rotation notation) (unknown) (optional)<br />
 
====Start/finish commands====
Parent: "entity"<br />
 
'''"precommands"''' &nbsp;&nbsp;&mdash; Console commands to run before commentary (optional)<br />
'''"postcommands"''' &nbsp;&nbsp;&mdash; Console commands to run after commentary (optional)<br />
 
====Connections section====
Name: "connections"<br />
Parent: entity<br />
Triggers attached to this entity. Optional.
 
'''"OnCommentaryStarted"''' &nbsp;&nbsp;&mdash; Triggers to fire when commentary is started (related to point_commentary_node)<br />
'''"OnCommentaryStopped"''' &nbsp;&nbsp;&mdash; Triggers to fire when commentary is finished (related to point_commentary_node)<br />
 
====Moving the camera====
'''"viewposition"''' &nbsp;&nbsp;&mdash; Name of entity (unknown) (optional)<br />
'''"viewtarget"''' &nbsp;&nbsp;&mdash; Name of entity (unknown) (optional)
 
==Example from Lost Coast==
Below is an example from the Lost Coast's commentary to show the simple format of the file.
 
<pre>Commentary
{
entity
{
"classname" "point_commentary_node"
"origin" "1351.290771 2388.777588 -10.452896"
"commentaryfile" "#lostcoast\commentary\comm_intro.wav"
"commentaryfile_nohdr" "#lostcoast\commentary\comm_intro_nohdr.wav"
"speakers" "Gabe Newell"
"targetname" "comm_node_1"
}
}</pre>
 
[[Category:Technical]]

Latest revision as of 16:56, 31 October 2005

Redirect to:

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Commentary_configuration_file&oldid=95901"