Env message: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=env_message}}
{{base point|ai_speechfilter}}
{{base_point}}[[Category:GUI Entities]]


==Entity Description==
==Entity description==
[[Image:{{PAGENAME}}.png|left]]
[[File:{{PAGENAME}}.png|left]]
An entity that draws a text message on player's HUD (or players' HUD's), predefined in the <code>hl2/scripts/titles.txt</code> file, packed inside the <code>Steam/SteamApps/source engine.gcf</code>.
An entity that draws a text message on player's HUD (or players' HUD's), predefined in the <code>hl2/scripts/titles.txt</code> file, packed inside the <code>Steam/SteamApps/source engine.gcf</code>.
{{clr}}
{{clr}}
Line 13: Line 12:
If you make a standalone modification, you can of course alter this file, but as default, titles.txt contains 23 messages. Some of these tokens seems to contain pointers to any <code>hl2/resource/hl2_[[%language%]].txt</code> file packed inside the <code>Steam/SteamApps/source engine.gcf</code> file.
If you make a standalone modification, you can of course alter this file, but as default, titles.txt contains 23 messages. Some of these tokens seems to contain pointers to any <code>hl2/resource/hl2_[[%language%]].txt</code> file packed inside the <code>Steam/SteamApps/source engine.gcf</code> file.


{| border="1" cellspacing="0"
{| class="standard-table"
! Message Value !! Printed Text  
! Message Value !! Printed Text  
|-
|-
|valign="top"|CR1||Testing 1
|CR1 || Testing 1
|-
|-
|valign="top"|CR2||Testing 2
|CR2 || Testing 2
|-
|-
|valign="top"|CR3||Testing 3
|CR3 || Testing 3
|-
|-
|valign="top"|GAMEOVER_ALLY||ASSIGNMENT: TERMINATED
|GAMEOVER_ALLY || ASSIGNMENT: TERMINATED


SUBJECT: FREEMAN
SUBJECT: FREEMAN
Line 28: Line 27:
REASON: FAILURE TO PRESERVE MISSION-CRITICAL PERSONNEL
REASON: FAILURE TO PRESERVE MISSION-CRITICAL PERSONNEL
|-
|-
|valign="top"|GAMEOVER_OBJECT||ASSIGNMENT: TERMINATED
|GAMEOVER_OBJECT || ASSIGNMENT: TERMINATED


SUBJECT: FREEMAN
SUBJECT: FREEMAN
Line 34: Line 33:
REASON: FAILURE TO PRESERVE MISSION-CRITICAL RESOURCES
REASON: FAILURE TO PRESERVE MISSION-CRITICAL RESOURCES
|-
|-
|valign="top"|GAMEOVER_TIMER||ASSIGNMENT: TERMINATED
|GAMEOVER_TIMER || ASSIGNMENT: TERMINATED


SUBJECT: FREEMAN
SUBJECT: FREEMAN
Line 40: Line 39:
REASON: FAILURE TO PREVENT TIME-CRITICAL SEQUENCE
REASON: FAILURE TO PREVENT TIME-CRITICAL SEQUENCE
|-
|-
|valign="top"|GAMEOVER_STUCK||ASSIGNMENT: TERMINATED
|GAMEOVER_STUCK || ASSIGNMENT: TERMINATED


SUBJECT: FREEMAN
SUBJECT: FREEMAN
Line 46: Line 45:
REASON: DEMONSTRATION OF EXCEEDINGLY POOR JUDGMENT
REASON: DEMONSTRATION OF EXCEEDINGLY POOR JUDGMENT
|-
|-
|valign="top"|CHAPTER1_TITLE||POINT INSERTION
|CHAPTER1_TITLE || POINT INSERTION
|-
|-
|valign="top"|CHAPTER2_TITLE||"A RED LETTER DAY"
|CHAPTER2_TITLE || "A RED LETTER DAY"
|-
|-
|valign="top"|CHAPTER3_TITLE||ROUTE KANAL
|CHAPTER3_TITLE || ROUTE KANAL
|-
|-
|valign="top"|CHAPTER4_TITLE||WATER HAZARD
|CHAPTER4_TITLE || WATER HAZARD
|-
|-
|valign="top"|CHAPTER5_TITLE||BLACK MESA EAST
|CHAPTER5_TITLE || BLACK MESA EAST
|-
|-
|valign="top"|CHAPTER6_TITLE||"WE DON'T GO TO RAVENHOLM..."
|CHAPTER6_TITLE || "WE DON'T GO TO RAVENHOLM..."
|-
|-
|valign="top"|CHAPTER7_TITLE||HIGHWAY 17
|CHAPTER7_TITLE || HIGHWAY 17
|-
|-
|valign="top"|CHAPTER8_TITLE||SANDTRAPS
|CHAPTER8_TITLE || SANDTRAPS
|-
|-
|valign="top"|CHAPTER9_TITLE||NOVA PROSPEKT
|CHAPTER9_TITLE || NOVA PROSPEKT
|-
|-
|valign="top"|CHAPTER9A_TITLE||ENTANGLEMENT
|CHAPTER9A_TITLE || ENTANGLEMENT
|-
|-
|valign="top"|CHAPTER10_TITLE||ANTICITIZEN ONE
|CHAPTER10_TITLE || ANTICITIZEN ONE
|-
|-
|valign="top"|CHAPTER11_TITLE||"FOLLOW FREEMAN!"
|CHAPTER11_TITLE || "FOLLOW FREEMAN!"
|-
|-
|valign="top"|CHAPTER12_TITLE||OUR BENEFACTORS
|CHAPTER12_TITLE || OUR BENEFACTORS
|-
|-
|valign="top"|CHAPTER13_TITLE||DARK ENERGY
|CHAPTER13_TITLE || DARK ENERGY
|-
|-
|valign="top"|GAMESAVED||Saved...
|GAMESAVED || Saved...
|-
|-
|valign="top"|GAMETITLE||Half-Life
|GAMETITLE || Half-Life
|}
|}


==Keyvalues==
== Keyvalues ==
{{KV|Message Text|string|Message to be shown. See above.}}
{{KV|Sound Effect|sound|When the message is shown, this sound effect will be played, originating from this entity.}}
{{KV|Volume 0-10|string|Volume of the sound effect.}}
{{KV|Sound Radius|choices}}
:* 0 : Small Radius
:* 1 : Medium Radius
:* 2 : Large  Radius
:* 3 : Play Everywhere
{{KV Targetname}}


* {{KV Targetname}}
== Flags ==
:* 1 : Play Once
:* 2 : All Clients


* '''message'''
== Inputs ==
: <string>
{{IO|ShowMessage|Shows the message and plays the sound.}}
{{I Targetname}}


* '''messagesound'''
== Outputs ==
: <sound> When the message is shown, this sound effect will be played, originating from this entity.
{{IO|OnShowMessage|Fired when the message is activated.}}
 
{{O Targetname}}
* '''messagevolume'''
: <string> Volume of the sound effect.
 
* '''messageattenuation'''
: <choices>
:{| class=standard-table
! Literal Value || Description
|-
| 0 || Small Radius
|-
| 1 || Medium Radius
|-
| 2 || Large Radius
|-
| 3 || Play Everywhere
|}
 
==Flags==
 
* 1 : Play Once
 
* 2 : All Clients
 
==Inputs==
 
* {{I Targetname}}
 
*'''ShowMessage'''
:Shows the message and plays the sound.
 
==Outputs==
 
* {{O Targetname}}
 
*'''OnShowMessage'''
:Fired when the message is activated. {{activator|activator}}
 
==Also See==


==See also==
* [[game_text]] - Similar entity that lets you define a text directly in the Hammer editor.
* [[game_text]] - Similar entity that lets you define a text directly in the Hammer editor.
* [[env_hudhint]] - Similar entity that displays predefined HUD hints about controls and other things.
* [[env_hudhint]] - Similar entity that displays predefined HUD hints about controls and other things.
[[Category:GUI Entities]]

Revision as of 01:30, 17 June 2011

Template:Base point

Entity description

Env message.png

An entity that draws a text message on player's HUD (or players' HUD's), predefined in the hl2/scripts/titles.txt file, packed inside the Steam/SteamApps/source engine.gcf.

This text can be formatted in many different ways, according to the syntax provided in the titles.txt file. The resource/chlientscheme.res is responsible for the font family, size and weight of the message. To change the size find CenterPrintText in the res file.

Todo: Explain this syntax.

If you make a standalone modification, you can of course alter this file, but as default, titles.txt contains 23 messages. Some of these tokens seems to contain pointers to any hl2/resource/hl2_%language%.txt file packed inside the Steam/SteamApps/source engine.gcf file.

Message Value Printed Text
CR1 Testing 1
CR2 Testing 2
CR3 Testing 3
GAMEOVER_ALLY ASSIGNMENT: TERMINATED

SUBJECT: FREEMAN

REASON: FAILURE TO PRESERVE MISSION-CRITICAL PERSONNEL

GAMEOVER_OBJECT ASSIGNMENT: TERMINATED

SUBJECT: FREEMAN

REASON: FAILURE TO PRESERVE MISSION-CRITICAL RESOURCES

GAMEOVER_TIMER ASSIGNMENT: TERMINATED

SUBJECT: FREEMAN

REASON: FAILURE TO PREVENT TIME-CRITICAL SEQUENCE

GAMEOVER_STUCK ASSIGNMENT: TERMINATED

SUBJECT: FREEMAN

REASON: DEMONSTRATION OF EXCEEDINGLY POOR JUDGMENT

CHAPTER1_TITLE POINT INSERTION
CHAPTER2_TITLE "A RED LETTER DAY"
CHAPTER3_TITLE ROUTE KANAL
CHAPTER4_TITLE WATER HAZARD
CHAPTER5_TITLE BLACK MESA EAST
CHAPTER6_TITLE "WE DON'T GO TO RAVENHOLM..."
CHAPTER7_TITLE HIGHWAY 17
CHAPTER8_TITLE SANDTRAPS
CHAPTER9_TITLE NOVA PROSPEKT
CHAPTER9A_TITLE ENTANGLEMENT
CHAPTER10_TITLE ANTICITIZEN ONE
CHAPTER11_TITLE "FOLLOW FREEMAN!"
CHAPTER12_TITLE OUR BENEFACTORS
CHAPTER13_TITLE DARK ENERGY
GAMESAVED Saved...
GAMETITLE Half-Life

Keyvalues

Message Text ([todo internal name (i)]) <string>
Message to be shown. See above.
Sound Effect ([todo internal name (i)]) <sound>
When the message is shown, this sound effect will be played, originating from this entity.
Volume 0-10 ([todo internal name (i)]) <string>
Volume of the sound effect.
Sound Radius ([todo internal name (i)]) <choices>
  • 0 : Small Radius
  • 1 : Medium Radius
  • 2 : Large Radius
  • 3 : Play Everywhere
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

Flags

  • 1 : Play Once
  • 2 : All Clients

Inputs

ShowMessage
Shows the message and plays the sound.


Outputs

OnShowMessage
Fired when the message is activated.


See also

  • game_text - Similar entity that lets you define a text directly in the Hammer editor.
  • env_hudhint - Similar entity that displays predefined HUD hints about controls and other things.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_message&oldid=153140"