Ambient soundscheme: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 24: Line 24:


== Inputs ==
== Inputs ==
{{I EnableDisable}}
{{IO|Kill|Removes this entity from the world.}}
{{IO|FadeIn|Fades the sound up to full volume over a specified number of seconds, with a range from 0 to 100 seconds.}}
{{IO|FadeIn|Fades the sound up to full volume over a specified number of seconds, with a range from 0 to 100 seconds.}}
{{IO|FadeOut|Fades the sound to silence over a specified number of seconds, with a range from 0 to 100 seconds.}}
{{IO|FadeOut|Fades the sound to silence over a specified number of seconds, with a range from 0 to 100 seconds.}}
{{IO|FadeOutKill|Fades entity during given time and then removes this from world.}}
{{IO|ScriptHide|Hide entity by specific python script.}}
{{IO|ScriptUnhide|Spawn entity by specific python script if it was hided.}}

Revision as of 13:34, 17 August 2023

Template:Entity This is an env_soundscape-similar entity to control sound in an area. The active soundscheme at any time is the last one that had line-of-sight to the player, and was within the radius.

Key Values

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Start Hidden (targetname) <choices>
Don't spawn the entity while the script command didn't sent.
Value Description
0 No
1 Yes
Start Enabled (start_enabled) <choices>
Value Description
0 No
1 Yes
Sound Scheme File (scheme_file) <vsndscheme>
The name of the Sound Scheme to use.
Corresponds to an entry in the 'sound/schemes/<name>.txt' file.
If you are using a custom scheme file (not presented in list) - please, use the full moddir-relative paths, like 'sound/Schemes/MyScheme.txt'.

Inputs

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
Kill
Removes this entity from the world.
FadeIn
Fades the sound up to full volume over a specified number of seconds, with a range from 0 to 100 seconds.
FadeOut
Fades the sound to silence over a specified number of seconds, with a range from 0 to 100 seconds.
FadeOutKill
Fades entity during given time and then removes this from world.
ScriptHide
Hide entity by specific python script.
ScriptUnhide
Spawn entity by specific python script if it was hided.