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

player

From Valve Developer Community
Jump to navigation Jump to search
Icon-NotInFGD.png
This entity is not in the FGD by default.
It should not be put directly in a map.

player is a point entity available in all Source Source games. The player itself or a bot. NPCs are not players. This entity still exists even if the player is dead.

Note.pngNote:Keyvalues, inputs, outputs and Dimensions vary depending on game and engine version.[Clarify]

Split-arrows.png Split

It has been suggested that this article or section be split into multiple articles. (Discuss)

Tip.pngTip:In singleplayer, a pointer to the player can be acquired by using UTIL_GetLocalPlayer().
Icon-Important.pngImportant:This is a preserved entity in Counter-Strike: SourceHalf-Life 2: DeathmatchDay of Defeat: SourceTeam Fortress 2Left 4 DeadLeft 4 Dead 2Alien SwarmAlien Swarm: Reactive DropPortal 2Counter-Strike: Global Offensive.
If the game has round restart mechanics this entity may not behave as expected:
More info
  • On a new round entities with this classname will intentionally not reset. You can use logic_auto to emulate resetting it.
  • Killing it removes it forever, as it is not respawned on a new round.
  • It cannot be spawned with a point_template.
  • Parenting this with non-preserved entities may have undesirable effects.

Limitations/Bugs

Icon-Important.pngImportant:This entity is not intended to be placed in a map manually. Doing so will result in an instant fatal error on map load!

Keyvalues

Note.pngNote:Keyvalues can be changed on a player with AddOutput.
Health (health) <integer>
The player's health.
Maximum Health (max_health) <integer>
The value of "health" cannot exceed this.
Base Velocity (BaseVelocity) <vector> !FGD
Adds to the velocity of the player.
Format: <x> <y> <z>
Todo: Test for games other than PortalPortal 2Team Fortress 2

Inputs

SetHealth <integerRedirectInput/integer>
Sets the player's health. Values clamped between 0 and max_health.
HandleMapEvent <stringRedirectInput/string>
Tells the game to perform a function, such as unlock an achievement. Hardcoded for specific map names.
SetHUDVisibility <booleanRedirectInput/boolean> (not in Half-Life 2Half-Life 2: DeathmatchHalf-Life 2 (Xbox)Half-Life 2: Episode One Half-Life 2: Episode Two)
Hides or displays the HUD.
Note.pngNote:The menu can still be accessed, and some HUD elements such as kill-icons may still be visible.
Icon-Bug.pngBug:In Team Fortress 2 and Counter-Strike: Global Offensive, using this input with a parameter override of 0 will disable any weapon-switching of the target.
Todo: Test in other games.
  [todo tested in ?]
SetFogController <stringRedirectInput/string> (not in Half-Life 2Half-Life 2: DeathmatchHalf-Life 2 (Xbox)Half-Life 2: Episode One Half-Life 2: Episode Two)
Sets the env_fog_controller to use.
SpeakResponseConcept <stringRedirectInput/string> (not in Half-Life 2Half-Life 2: DeathmatchHalf-Life 2 (Xbox)Half-Life 2: Episode One Half-Life 2: Episode Two)
Speak the specified response concept immediately.
IgnoreFallDamage <floatRedirectInput/float> (only in Half-Life 2)
Prevent the player from taking fall damage for [n] seconds, but reset back to taking fall damage after the first impact (so players will be hurt if they bounce off what they hit).
IgnoreFallDamageWithoutReset <floatRedirectInput/float> (only in Half-Life 2and Left 4 Dead 2)
Absolutely prevent the player from taking fall damage for [n] seconds.
Note.pngNote:Should use "OnStartTouch - !activator - IgnoreFallDamageWithoutReset - 5 - Delay of 0". To disable fall damage for five seconds. Don't give it too much time, else players can exploit it to continue falling nearby areas without taking any damage.
OnSquadMemberKilled  (only in Half-Life 2)
Notification of a player's NPC ally in the players squad being killed.
DisableFlashlight  (only in Half-Life 2)
Disables the player's flashlight.
EnableFlashlight  (only in Half-Life 2)
Enables the player's flashlight.
ForceDropPhysObjects  (only in Half-Life 2)
Force the player to drop any physics objects they are carrying.
OnRescueZoneTouch  (only in Counter-Strike: SourceCounter-Strike: Global Offensive)
Fired when a hostage is rescued. This input is also available in the code for Left 4 Dead and Left 4 Dead 2.
SetCommentaryStatueMode  (only in Left 4 Dead 2)
[Todo].
DisableLedgeHang  (only in Left 4 Dead 2)
Disable ledge hanging by player.
EnableLedgeHang  (only in Left 4 Dead 2)
Enable ledge hanging by player.
TeleportToSurvivorPosition <stringRedirectInput/string> (only in Left 4 Dead 2)
Teleport a player to an info_survivor_position entity, then freezes them. To unfreeze them, use the ReleaseSurvivorPositions input from info_director or the player's ReleaseFromSurvivorPosition input.
ReleaseFromSurvivorPosition  (only in Left 4 Dead 2)
Unfreezes and releases the player from an info_survivor_position entity if they are at one.
SetGlowEnabled <booleanRedirectInput/boolean> (only in Left 4 Dead 2)
Sets if this player is allowed to glow through walls if not visible.
RemoveWeaponUpgrades  (only in Left 4 Dead 2)
Removes laser sights from guns.
CancelCurrentScene  (only in Left 4 Dead 2)
Makes the player's character quit talking immediately.
IgnitePlayer <integerRedirectInput/integer> (only in Team Fortress 2)
Ignites the player with a specified lifetime and causes a reaction (sound and speech).
Note.pngNote:Does not fire the OnIgnite output.
Icon-Bug.pngBug:Broken since the Jungle Inferno update, initiating sound and speech but no actual fire. Use trigger_ignite as a workaround.  [todo tested in ?]
ExtinguishPlayer  (only in Team Fortress 2)
Extinguishes the player.
BleedPlayer <integerRedirectInput/integer> (only in Team Fortress 2)
Bleeds the player with a specified length.
RollRareSpell  (only in Team Fortress 2)
Forces the player to roll a rare spell. Only available if spells are enabled on the map.
SetCustomModel <stringRedirectInput/string> (only in Team Fortress 2)
Set a custom player model without animations.
Note.pngNote:Using "" as the model argument will instead clear the target's custom model, returning the player to normal.
SetCustomModelWithClassAnimations <stringRedirectInput/string> (only in Team Fortress 2)
Set a custom player model with animations.
SetCustomModelOffset <vectorRedirectInput/Vector> (only in Team Fortress 2)
Set a custom player model position on the player.
SetCustomModelRotation <vectorRedirectInput/Vector> (only in Team Fortress 2)
Set a custom player model rotation on the player.
ClearCustomModelRotation  (only in Team Fortress 2)
Clears the custom player model rotation.
SetCustomModelRotates <booleanRedirectInput/boolean> (only in Team Fortress 2)
Set if the custom model rotates or not to the player's angles.
SetCustomModelVisibleToSelf <booleanRedirectInput/boolean> (only in Team Fortress 2)
Set if the custom model is visible to the player, in thirdperson.
SetForcedTauntCam <booleanRedirectInput/boolean> (only in Team Fortress 2)
Forces the player into thirdperson mode.
SpeakResponseConcept <stringRedirectInput/string> (only in Team Fortress 2)
Forces the player to speak the specified response concept, an example being halloweenlongfall.
SetScriptOverlayMaterial  (only in Team Fortress 2)
Sets a custom overlay material. This overlay is separate from normal overlays (e.g. burning or env_screenoverlay) and will not get overriden.
TriggerLootIslandAchievement  (only in Team Fortress 2)
[Todo].
TriggerLootIslandAchievement2  (only in Team Fortress 2)
[Todo].
RoundSpawn  (only in Team Fortress 2)
Clears any magic spell within the player's current spell book.
PerformForcedWeaponDeploy <stringRedirectInput/string> (only in Black Mesa) !FGD
Forces the player to use specified weapon with pickup animation.
Note.pngNote:Pickup animation doesn't always work, this somehow depends on player's ammo and other weapons.

See also

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