player

This entity is not in the FGD by default.
It should not be put directly in a map.

Source Engine

Team Fortress 2

Portal 2

Left 4 Dead series

Half-Life series

Counter-Strike series

Class hierarchy
CTFPlayer ↳CBaseMultiplayerPlayer ↳CBasePlayer ↳CBaseCombatCharacter ↳CBaseFlex ↳CBaseAnimatingOverlay ↳CBaseAnimating ↳CBaseEntity

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

Important:This is a preserved entity in .
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

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

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>

Hides or displays the HUD.

Note:The menu can still be accessed, and some HUD elements such as kill-icons may still be visible.

Warning:Will disable any weapon-switching of the target

SetFogController <stringRedirectInput/string>

Sets the env_fog_controller to use.

SpeakResponseConcept <stringRedirectInput/string>

Speak the specified response concept immediately.

IgnitePlayer <integerRedirectInput/integer>

Ignites the player with a specified lifetime and causes a reaction (sound and speech).

Note:Does not fire the OnIgnite output.

Bug:Broken since the Jungle Inferno update, initiating sound and speech but no actual fire. Use trigger_ignite as a workaround.  [todo tested in ?]

ExtinguishPlayer

Extinguishes the player.

BleedPlayer <integerRedirectInput/integer>

Bleeds the player with a specified length.

RollRareSpell

Forces the player to roll a rare spell. Only available if spells are enabled on the map.

SetCustomModel <stringRedirectInput/string>

Set a custom player model without animations.

Note:Using "" as the model argument will instead clear the target's custom model, returning the player to normal.

SetCustomModelWithClassAnimations <stringRedirectInput/string>

Set a custom player model with animations.

SetCustomModelOffset <vectorRedirectInput/Vector>

Set a custom player model position on the player.

SetCustomModelRotation <vectorRedirectInput/Vector>

Set a custom player model rotation on the player.

ClearCustomModelRotation

Clears the custom player model rotation.

SetCustomModelRotates <booleanRedirectInput/boolean>

Set if the custom model rotates or not to the player's angles.

SetCustomModelVisibleToSelf <booleanRedirectInput/boolean>

Set if the custom model is visible to the player, in thirdperson.

SetForcedTauntCam <booleanRedirectInput/boolean>

Forces the player into thirdperson mode.

SpeakResponseConcept <stringRedirectInput/string>

Forces the player to speak the specified response concept, an example being halloweenlongfall.

SetScriptOverlayMaterial

Sets a custom overlay material. This overlay is separate from normal overlays (e.g. burning or env_screenoverlay) and will not get overriden.

TriggerLootIslandAchievement

^[Todo].

TriggerLootIslandAchievement2

^[Todo].

RoundSpawn

Clears any magic spell within the player's current spell book.

See Also

• CTerrorPlayer vscript functions