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
m (Added hdtf only credits input.)
(position irrelevant so it's logical entity)
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
{{LanguageBar}}
{{LanguageBar}}
{{CD|CCredits|file1=EnvMessage.cpp}}
{{CD|CCredits|file1=EnvMessage.cpp}}
{{this is a|point 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>.
{{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>.


{{note|In {{l4ds}} use {{ent|env_outtro_stats}}. This entity is drastically different and has ''nothing'' except one input; <code>Start</code>.}}
{{note|In {{l4ds}} use {{ent|env_outtro_stats}}. This entity is drastically different and has ''nothing'' except one input; <code>Start</code>.}}
Line 14: Line 14:


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


==Outputs==
==Outputs==
{{IO|OnCreditsDone|Fired when the credits having finished rolling.}}
{{O|OnCreditsDone|Fired when the credits having finished rolling.}}


==File format==
==File format==

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