player

From Valve Developer Community
Jump to navigation Jump to search
English (en)Translate (Translate)
edit
Icon-NotInFGD.png
This entity is not in the FGD by default.
It should not be put directly in a map because it can only be configured through code.
Recycle-warning.png
This is a preserved entity.
If the game has round restart mechanics this entity may not behave as expected.
Class hierarchy
CTFPlayer
CBaseMultiplayerPlayer
CBasePlayer
CBaseCombatCharacter
CBaseFlex
CBaseAnimatingOverlay
CBaseAnimating
CBaseEntity
tf_player.cpp

player is an entity available in Team Fortress 2 Team Fortress 2. The player itself or a bot. NPCs are not players. This entity still exists even if the player is dead.

Inputs

SetHealth <integerRedirectInput/integer>
Sets the player's health. Values clamped between 0 and max_health (the latter being normally set up for each individual class in scripts/playerclasses).
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.pngNote:The menu can still be accessed, and some HUD elements such as kill-icons may still be visible.
Warning.pngWarning: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. This is what's used to make players scream when falling into pits (using HalloweenLongFall response). Additional context can be passed using space-delimited key:value pairs. Example: TLK_MVM_TANK_CALLOUT IsMvMDefender:1 randomnum:100. For a list of response rules, see the txt files in scripts/talker/ located in tf2_misc VPK.
List of Responses 
IgnitePlayer <integerRedirectInput/integer>
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.
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.pngNote: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.
SetScriptOverlayMaterial
Sets a custom screen overlay material. This overlay is separate from normal screen 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