env_credits

From Valve Developer Community

Jump to: navigation, search

This is a point entity available in all Source games.

Contents

Entity Description

An entity to control the rolling credits. The credis text that's displayed is determined inside credits.txt located in the scripts folder of the game/mod. See source engine.gcf/hl2/scripts/credits.txt for an example of how the script should be layed out.


Availability

This point-based entity is available in: all Source games. In code it is represented by class CCredits, defined in EnvMessage.cpp.

Keyvalues

  • Targetname:

Name <string>
The targetname other entities refer to this entity by.

Inputs

  • Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and all its children from the world.
AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
  • RollCredits
Start the intro credits rolling.
  • RollOutroCredits
Start the outro credits rolling.
  • ShowLogo
Show the HL2 logo.

Outputs

  • Targetname:

OnUser1 to OnUser4
Fired in response to the FireUser inputs; see User Inputs and Outputs.
OnKilled (New with Left 4 Dead)
Fired when the entity is killed and removed from the game.
  • OnCreditsDone
Fired when the credits having finished rolling.
Personal tools