Env soundscape triggerable: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Added icon.)
m (Added keyvalue types, and stuff.)
Line 16: Line 16:
* {{kv enabledisable}}
* {{kv enabledisable}}
* '''radius'''
* '''radius'''
: <?> Radius - If set to <code>-1</code>, then the player can hear the soundscape as long as he can see it (regardless of distance to it).
: <integer> Radius - If set to <code>-1</code>, then the player can hear the soundscape as long as he can see it (regardless of distance to it).
* '''soundscape'''
* '''soundscape'''
: <?> Soundscape - The name of the soundscape to use. Corresponds to an entry in the ''soundscapes*.txt'' file in the ''hl2acripts'' directory.
: <string> Soundscape - The name of the soundscape to use. Corresponds to an entry in the ''soundscapes_*.txt'' file in the ''hl2/scripts'' directory (normally packed into the ''source engine.gcf'' file).
:{|
:{|
! Literal Value || Description
! Literal Value || Description
Line 33: Line 33:
|}
|}
* '''position''0-7'''''
* '''position''0-7'''''
: <?> Sound Position ''0-7'' - A sound position that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.
: <target_destination> Sound Position ''0-7'' - Sound positions that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.


<!--This entity doesn't have any flags.-->
<!--This entity doesn't have any flags.-->
Line 39: Line 39:
* {{i targetname}}
* {{i targetname}}
* {{i parentname}}
* {{i parentname}}
* '''Disable'''
* {{i enabledisable}}
:
* '''Enable'''
:
* '''Disabled'''
* '''Disabled'''
:
: {{todo|Write description. (It's not a typo - both ''Disable'' and ''Disabled'' exists.)}}
* '''ToggleEnabled'''
* '''ToggleEnabled'''
:
: Toggle the soundscape enabled state.


==Outputs==
==Outputs==
* {{o targetname}}
* {{o targetname}}
* '''OnPlay'''
* '''OnPlay'''
:
: Fired when this soundscape becomes the active one.


[[Category:Entities]]
[[Category:Entities]]

Revision as of 01:33, 12 April 2006

Template:Wrongtitle

Entity Description

Env soundscape.png

A point entity that works like the env_soundscape entity except that it works in conjunction with the trigger_soundscape entity to determine when a player hears it.

Note.pngNote:This entity has the same keyvalues, (non-existant) flags, inputs, and outputs as env_soundscape.

Availability

Template:In game Template:Game-base Template:In code

Keyvalues

<integer> Radius - If set to -1, then the player can hear the soundscape as long as he can see it (regardless of distance to it).
  • soundscape
<string> Soundscape - The name of the soundscape to use. Corresponds to an entry in the soundscapes_*.txt file in the hl2/scripts directory (normally packed into the source engine.gcf file).
Literal Value Description
Nothing Nothing
Automatic Automatic
Automatic_Dialog Automatic (dialog)
GenericIndoor Indoor
GenericOutdoor Outdoor
  • position0-7
<target_destination> Sound Position 0-7 - Sound positions that will be referenced inside the soundscape text file. Usually used to position a set of sounds within the world.

Inputs

Todo: Write description. (It's not a typo - both Disable and Disabled exists.)
  • ToggleEnabled
Toggle the soundscape enabled state.

Outputs

Fired when this soundscape becomes the active one.