sndtool_help.txt - ORIGINAL

<!-- schema text {7e125a45-3d83-4043-b292-9e24f8ef27b4} generic {198980d8-3a93-4919-b4c6-dd1fb07a3a4b} -->
CHelpData CHelpData_0
{
	CHelpEntry[] m_Entries =
	[
		CHelpEntry
		{
			string m_Id = "Operator math_random"
			string m_FriendlyName = "Math Random"
			string m_TooltipOverride = "Output a random number between Min and Max."
			string m_HelpText = "Output a random floating point number between <b>Min</b> and up to but not including <b>Max</b>.  <b>Seed</b> may be set to control the generated sequence.  <b>Round To Int</b> will force the output to an integer value."
		},
		CHelpEntry
		{
			string m_Id = "Operator On Start"
			string m_FriendlyName = "On Start"
			string m_TooltipOverride = "Execute this stack once, before the sound event starts."
			string m_HelpText = "The <b>On Start</b> operator is always the first operator of a <em>Start Stack</em>.  Start Stacks are used when we want to adjust the playback of the start of the sound. Start Stacks will play once, and will affect the sound when it is first called, but prior to it actually playing."
		},
		CHelpEntry
		{
			string m_Id = "Operator math_float"
			string m_FriendlyName = "Math Float"
			string m_TooltipOverride = "Apply floating point math operation.  Output = Input1 Operation Input2."
			string m_HelpText = "Apply a floating point math operation to input1 & input2.  <b>Output = Input1</b> <em>Operation</em> <b>Input2</b>.  The <b>Apply</b> field determines which specific operation to apply."
		},
		CHelpEntry
		{
			string m_Id = "Operator sys_start_entry"
			string m_FriendlyName = "System Start Entry"
			string m_TooltipOverride = "Start a sound event."
			string m_HelpText = "Start a sound event.  The <b>Entry Name</b> determines which sound event to start."
		},
		CHelpEntry
		{
			string m_Id = "Operator On Update"
			string m_FriendlyName = "On Update"
			string m_TooltipOverride = "This stack will execute once per frame."
			string m_HelpText = "The <b>On Update</b> operator is always the first operator of an <em>Update Stack</em>.  An Update Stack will be called once every frame while the sound event is playing. This can be used in a variety of ways: to affect the pitch, volume, occlusion, dsp settings and to define a specific mix group for the sound, among other things. Update stacks are especially useful for long duration or looping sounds."
		},
		CHelpEntry
		{
			string m_Id = "Operator import_stack"
			string m_FriendlyName = "Import"
			string m_TooltipOverride = "Import a stack from the stack library."
			string m_HelpText = "Import a stack from the stack library. "
		},
		CHelpEntry
		{
			string m_Id = "Operator operator_overwrite"
			string m_FriendlyName = "Overwrite"
			string m_TooltipOverride = "Overwrite parameters of the named operator within the preceding import stack."
			string m_HelpText = "Overwrite parameters of the named operator within the preceding import stack. "
		},
		CHelpEntry
		{
			string m_Id = "Operator On Stop"
			string m_FriendlyName = "On Stop"
			string m_TooltipOverride = "Execute this stack once, when the sound event is complete."
			string m_HelpText = "The <b>On Stop</b> operator is always the first operator of a <em>Stop Stack</em>.  A Stop Stack will execute once, when the sound event recieves a message to stop playing."
		},
		CHelpEntry
		{
			string m_Id = "Operator get_convar"
			string m_FriendlyName = "Get Convar"
			string m_TooltipOverride = ""
			string m_HelpText = "Get the value of the convar specified by the <b>Convar</b> parameter, and apply it to the Output."
		},
		CHelpEntry
		{
			string m_Id = "Stack CS_limit_bullet_impact"
			string m_FriendlyName = "CS_limit_bullet_impact"
			string m_TooltipOverride = ""
			string m_HelpText = "Limit the number of bullet impacts playing on this entity to 5."
		},
		CHelpEntry
		{
			string m_Id = "Operator On Prestart"
			string m_FriendlyName = ""
			string m_TooltipOverride = "This stack will execute once, before the start stack."
			string m_HelpText = "The <b>On Prestart</b> operator is always the first operator of a <em>Prestart Stack</em>.  Prestart stacks execute before Start Stacks, and may be used to cue up or precompute data required before playback of a sound begins."
		},
		CHelpEntry
		{
			string m_Id = "Operator calc_distant_dsp"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "<p>Used to determine the amount of environmental DSP effect to mix with the playing sound.  DSP mix is based on distance from this sound source to listener.</p>\n<p>\n<table border=\"0\" bgcolor=\"\">\n  <tr bgcolor=\"#405070\">\n    <th>Attribute</th>\n    <th>Usage</th>\n  </tr>\n  <tr>\n    <td>Input Distance</td>\n    <td>A float that is the distance between the source and the player</td>\n  </tr>\n  <tr>\n    <td>Input Level</td>\n    <td>A float that is the Sound Level of the source</td>\n  </tr>\n  <tr>\n    <td>Output</td>\n    <td>A float that is the amount of DSP to be used on the source</td>\n  </tr>\n</table>\n</p>\n"
		},
		CHelpEntry
		{
			string m_Id = "Operator calc_falloff"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "<p>Used to determine the volume falloff of the sound, based on distance.</p>\n<p>\n<table border=\"0\">\n  <tr bgcolor=\"#405070\">\n    <th>Attribute</th>\n    <th>Usage</th>\n  </tr>\n  <tr>\n    <td>Input Distance</td>\n    <td>A float that is the distance between the source and the player</td>\n  </tr>\n  <tr>\n    <td>Input Level</td>\n    <td>A float that is the Sound Level of the source</td>\n  </tr>\n  <tr>\n    <td>Output</td>\n    <td>A float multiplier based on distance.</td>\n  </tr>\n</table>\n</p>\n"
		},
		CHelpEntry
		{
			string m_Id = "Operator calc_occlusion"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "<p>Calculate an occlusion value between listener and a position. 1.0 is non-occluded, 0.0 is fully occluded.</p>\n<p>\n<table border=\"0\">\n  <tr bgcolor=\"#405070\">\n    <th>Attribute</th>\n    <th>Usage</th>\n  </tr>\n  <tr>\n    <td>Input Trace Interval</td>\n    <td>Controls how frequently occlusion is checked.</td>\n  </tr>\n  <tr>\n    <td>Input Scalar</td>\n    <td></td>\n  </tr>\n  <tr>\n    <td>Input Position</td>\n    <td>Position used for occlusion check.</td>\n  </tr>\n  <tr>\n    <td>Output</td>\n    <td>A float that is the occluded value (1.0 is non-occluded).</td>\n  </tr>\n</table>\n</p>\n"
		},
		CHelpEntry
		{
			string m_Id = "Operator calc_source_distance"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "<p>Output the distance between a listener and a target position.</p>\n<p>\n<table border=\"0\">\n  <tr bgcolor=\"#405070\">\n    <th>Attribute</th>\n    <th>Usage</th>\n  </tr>\n  <tr>\n    <td>Input Position</td>\n    <td>position of target, x y z.</td>\n  </tr>\n  <tr>\n    <td>Output</td>\n    <td>A float that is the distance between listener and target, in inches.</td>\n  </tr>\n</table>\n</p>"
		},
		CHelpEntry
		{
			string m_Id = "Operator calc_spatialize_speakers"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "<p>Determine a volume multiplier for each speaker surrounding a listener, for the sound source playing at a position and/or distance.</p>\n<p>\n<table border=\"0\">\n  <tr bgcolor=\"#405070\">\n    <th>Attribute</th>\n    <th>Usage</th>\n  </tr>\n  <tr>\n    <td>Input Radius</td>\n    <td>As listener moves within sound radius, sound is equally distributed to speakers.</td>\n  </tr>\n  <tr>\n    <td>Input Rear Stereo Scale</td>\n    <td>A float, when monitoring in stereo, how much of the signal of the rear speakers is summed into front stereo speakers.</td>\n  </tr>\n  <tr>\n    <td>Input Distance</td>\n    <td>Distance between sound source and listener.</td>\n  </tr>\n  <tr>\n    <td>Input Position</td>\n    <td>3D Position of the sound source.</td>\n  </tr>\n  <tr>\n    <td>Output</td>\n    <td>An array of floats multipliers, one for each speaker.</td>\n  </tr>\n</table>\n</p>"
		},
		CHelpEntry
		{
			string m_Id = "Stack CS_random_music_entry_start_2"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "This stack randomly plays one of three sound events.  Override operator <b>Play Variation 1</b>, field <b>Entry Name</b> to set the sound event you\'d like to play."
		},
		CHelpEntry
		{
			string m_Id = "Operator util_null"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "A null operator is a good place to define your own Operator Variables."
		},
		CHelpEntry
		{
			string m_Id = "Diagnostic.Bell.Center"
			string m_FriendlyName = ""
			string m_TooltipOverride = ""
			string m_HelpText = "NOBODY use this unless it\'s in dota\'s magical fountain room!"
		},
		CHelpEntry
		{
			string m_Id = "SndToolAppHelp"
			string m_FriendlyName = "Sound Tool Help"
			string m_TooltipOverride = ""
			string m_HelpText = "Enter an explanation of how this tool works here..."
		}
	]
}