Env speaker: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
No edit summary
 
(23 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_speaker}}
{{tabsBar|main=Speaker}}
{{LanguageBar}}
{{CD|CSpeaker|file1=env_speaker.cpp}}
{{this is a|point entity|game=Half-Life 2 series|game1=Portal|name=env_speaker}} It randomly emits announcements using the [[response rules]] system.


== Entity description ==
{{stray ent|{{as|2.bold}} and {{portal2|2.bold}}}}
[[Image:ambient_generic.png|left]]
Announcement Speaker, used in several maps it uses the NPC response context system. You can specify time between announcements. When it makes an announcement, it looks at its Context rule script, chooses the best rule (Response Contexts and Concept name are used here.), then dispatches a response which could be a .vcd scene that controls an NPC, a sentence, or just a sound. See [[Response System]] for more information about context rule script grammar.


== Keyvalues ==
==Flags==
* {{KV Targetname}}
{{fl|1|Start Silent}}
* {{KV ResponseContext}}
{{fl|2|Play Everywhere}}
* '''delaymin'''
: <string> Minimum Delay Between Announcements
* '''delaymax'''
: <string> Maximum Delay Between Announcements
* '''rulescript'''
: <string> Script file containing rules for playing appropriate sounds.
* '''Concept'''
: <string> High level concept name used as primary search key.


== Flags ==
==Keyvalues==
* Start Silent : 0
{{KV Targetname}}
* Play Everywhere : 0
{{KV|Min Delay Between Announcements|intn=delaymin|float|Minimum time between announcements in seconds.}}
{{KV|Max Delay Between Announcements|intn=delaymax|float|Maximum time between announcements in seconds.}}
{{KV|Context rule script|intn=rulescript|string|The response rules script file to load.}}
{{KV|Concept name|intn=concept|string|The [[Response rules#Concepts|concept]] to speak.}}


== Inputs ==
==Inputs==
* {{I Targetname}}
{{I|TurnOn|Start random announcements.}}
* {{I ResponseContext}}
{{I|TurnOff|Stop random announcements.}}
* '''TurnOn'''
{{I|Toggle|If on, turn off. If off, turn on.}}
: Turn on the random announcements.
 
* '''TurnOff'''
==See also==
: Turn off the random announcements.
*{{ent|func_monitor}}
* '''Toggle'''
*{{ent|env_microphone}}
: Toggle the random announcements off and on.


== Outputs ==
* {{o targetname}}


[[Category:Sound System]]
[[Category:Sound System]]
[[Category:Entities]]

Latest revision as of 18:49, 29 April 2025

edit
English (en)Translate (Translate)
C++ Class hierarchy
CSpeaker
↳CPointEntity
↳CBaseEntity
C++ env_speaker.cpp

env_speaker is a point entity available in Half-Life 2 series Half-Life 2 series and Portal Portal. It randomly emits announcements using the response rules system.

Note.pngNote:This entity is also in the code for Alien Swarm Alien Swarm and Portal 2 Portal 2. Its functionality is not guaranteed.


Flags

Start Silent : [1]
Play Everywhere : [2]

Keyvalues

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

Min Delay Between Announcements (delaymin) <float>
Minimum time between announcements in seconds.
Max Delay Between Announcements (delaymax) <float>
Maximum time between announcements in seconds.
Context rule script (rulescript) <string>
The response rules script file to load.
Concept name (concept) <string>
The concept to speak.

Inputs

TurnOn
Start random announcements.
TurnOff
Stop random announcements.
Toggle
If on, turn off. If off, turn on.

See also

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