This article's documentation is for anything that uses the Source engine. Click here for more information.

Env credits: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(raw; needs cleanup)
 
(position irrelevant so it's logical entity)
 
(41 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{cleanup}}
{{stub|section=1}}
env_credits
{{LanguageBar}}
{{CD|CCredits|file1=EnvMessage.cpp}}
{{This is a|logical entity|engine=Source|name=env_credits|sprite=1}} This entity is used to control the rolling [[credits]]. The text that will be displayed is determined inside the file <code>scripts/credits.txt</code>.


An entity to control the rolling credits.
{{note|In {{l4ds}} use {{ent|env_outtro_stats}}. This entity is drastically different and has ''nothing'' except one input; <code>Start</code>.}}


KEYS


Name targetname <target_source> The name that other entities refer to this entity by.
== Bugs/Limitations ==
{{Important|the {{tf2|4}} will crash if an env_credits is attempted to be used without a registered <code>scripts/credits.txt</code> file. {{clarify|which games suffer from this other than {{tf2|4}}?}} }}


==Keyvalues==
{{KV Targetname}}


INPUTS
==Inputs==
{{I|RollCredits|Start the intro credits rolling.
:{{note|Replaced with {{ent|env_introcredits}} entity in {{bms|4}}.
}}|not={{bms}}}}
{{I|RollOutroCredits|Start the outro credits rolling.|not={{bms}}}}
{{I|ShowLogo|Show logo.}}
{{I|Start|since=L4D|Start rolling credits.}}
{{I|SetLogoLength|param=float|Sets the amount of time the logo is displayed. Default is 5.0.}}
{{I|RollEndCredits|Start the end credits rolling.|only={{bms}}}}
{{I|RollJokeOutroCredits|Start a joke version of the outro credits rolling quickly past.|only={{hdtf}}}}


Kill Removes this entity from the world.
==Outputs==
{{O|OnCreditsDone|Fired when the credits having finished rolling.}}


KillHierarchy Removes this entity and all its children from the world.
==File format==
{{Empty section|date=January 2024}}


AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
==Files==
# <code>scripts/credits[[.txt]]</code>


FireUser1 Causes this entity's OnUser1 output to be fired.
[[Category:GUI Entities|env_credits]]
[[Category:Plain text formats|credits.txt]]


FireUser2 Causes this entity's OnUser2 output to be fired.
==See also==
 
* {{ent|env_message}}
FireUser3 Causes this entity's OnUser3 output to be fired.
* {{ent|env_hudhint}}
 
* {{ent|point_message}}
FireUser4 Causes this entity's OnUser4 output to be fired.
* {{ent|game_text}}
 
* {{ent|env_introcredits}}
RollCredits Start the intro credits rolling.
 
RollOutroCredits Start the outro credits rolling.
 
ShowLogo Show the HL2 logo.
 
 
OUTPUTS
 
OnUser1 Fired in response to FireUser1 input.
 
OnUser2 Fired in response to FireUser2 input.
 
OnUser3 Fired in response to FireUser3 input.
 
OnUser4 Fired in response to FireUser4 input.
 
OnCreditsDone Fired when the credits having finished rolling.

Latest revision as of 04:21, 29 April 2025

Stub

This article or section is a stub. You can help by expanding it.

English (en)Русский (ru)中文 (zh)Translate (Translate)
C++ Class hierarchy
CCredits
↳CPointEntity
↳CBaseEntity
C++ EnvMessage.cpp
Env credits.png

env_credits is a logical entity available in all Source Source games. This entity is used to control the rolling credits. The text that will be displayed is determined inside the file scripts/credits.txt.

Note.pngNote:In Left 4 Dead seriesLeft 4 Dead series use env_outtro_stats. This entity is drastically different and has nothing except one input; Start.


Bugs/Limitations

Icon-Important.pngImportant:the Team Fortress 2 Team Fortress 2 will crash if an env_credits is attempted to be used without a registered scripts/credits.txt file.
Clarify: which games suffer from this other than Team Fortress 2 Team Fortress 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

Inputs

RollCredits  (not in Black Mesa)
Start the intro credits rolling.
Note.pngNote:Replaced with env_introcredits entity in Black Mesa Black Mesa.
RollOutroCredits  (not in Black Mesa)
Start the outro credits rolling.
ShowLogo
Show logo.
Start  (in all games since Left 4 Dead)
Start rolling credits.
SetLogoLength <floatRedirectInput/float>
Sets the amount of time the logo is displayed. Default is 5.0.
RollEndCredits  (only in Black Mesa)
Start the end credits rolling.
RollJokeOutroCredits  (only in Hunt Down the Freeman)
Start a joke version of the outro credits rolling quickly past.

Outputs

OnCreditsDone
Fired when the credits having finished rolling.

File format

Empty

This article or section is empty. You can help by adding it.

Files

  1. scripts/credits.txt

See also

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