Env message: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
{{base point|env_message}}
[[File:env_message.png|left|link=]]


==Entity description==
{{base point|env_message}} It 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>.
[[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>.
{{clr}}
{{clr}}


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



Revision as of 06:24, 24 July 2011

Env message.png

Template:Base point It 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.

Syntax

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.