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
(?No need for {{Underlinked|date=January 2024}} now? You can always return it if you still see issue with "needs more".)
(-added class hierarchy, cleanup)
Line 1: Line 1:
{{stub|section=1}}
{{stub|section=1}}
{{lang|Env credits}}
{{LanguageBar}}
[[File:env_credits.png|left]]{{this is a|point entity|engine=Source|name=env_credits}} 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>.
{{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>.


{{note|In {{l4ds}}, this entity is drastically different and has ''nothing'' except one input; <code>Start</code>.}}
{{note|In {{l4ds}}, this entity is drastically different and has ''nothing'' except one input; <code>Start</code>.}}


{{code class|CCredits|EnvMessage.cpp}}


== Bugs/Limitations ==
== Bugs/Limitations ==
Line 15: Line 15:
==Inputs==
==Inputs==
{{IO|RollCredits|Start the intro credits rolling.
{{IO|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}}}}
{{IO|RollOutroCredits|Start the outro credits rolling.|not={{bms}}}}
{{IO|RollEndCredits|Start the end credits rolling.|only={{bms}}}}
{{IO|ShowLogo|Show logo.}}
{{IO|ShowLogo|Show logo.}}
{{IO|Start|since=L4D|Start rolling credits.}}
{{IO|SetLogoLength|Sets the amount of time the logo is displayed. Default is 5.0.|only={{bms}}}}
{{IO|SetLogoLength|Sets the amount of time the logo is displayed. Default is 5.0.|only={{bms}}}}
{{IO|Start|since=L4D|Start rolling credits.}}
{{IO|RollEndCredits|Start the end credits rolling.|only={{bms}}}}


==Outputs==
==Outputs==
Line 28: Line 27:


==File format==
==File format==
{{Empty section|date=January 2024}}
{{Empty section|date=January 2024}}


Line 36: Line 34:
[[Category:GUI Entities|env_credits]]
[[Category:GUI Entities|env_credits]]
[[Category:Plain text formats|credits.txt]]
[[Category:Plain text formats|credits.txt]]


==See also==
==See also==

Revision as of 07:21, 7 August 2024

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 point 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, 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  (only in Black Mesa)
Sets the amount of time the logo is displayed. Default is 5.0.
RollEndCredits  (only in Black Mesa)
Start the end credits rolling.

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