Player

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

Template:Base point The player itself. This entity still exists even if the player is dead.

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

Note:Keyvalues, inputs, outputs and Dimensions vary depending on game and engine version.

Tip:A pointer to the player can be acquired by using UTIL_GetLocalPlayer().

Note:NPCs are not players, whereas bots are.

Keyvalues

Note:These keyvalues should be changed on a player with AddOutput.

Health (health) ([todo internal name (i)]) <integer>

The player's health.

Maximum Health (max_health) ([todo internal name (i)]) <integer>

The value of "health" cannot exceed this.

Collisions (solid) ([todo internal name (i)]) <choices>

Method of collision for the player.

• 0: None
• 1: BSP (QPhysics) !FGD
• 2: Bounding Box
• 3: Oriented Bounding Box !FGD
• 4: Oriented Bounding Box, constrained to Yaw only !FGD
• 5: Custom/Test !FGD
• 6: VPhysics

Model Index (modelindex) ([todo internal name (i)]) <integer>

Changes the player's model to a precached model on the map. Not available in .

Lighting Origin (LightingOrigin) ([todo internal name (i)]) <targetname>

Select an entity (not info_lighting!) from which to sample lighting instead of the entity's origin.

Lighting Origin Offset (LightingOriginHack) ([todo internal name (i)]) <targetname>

The info_lighting_relative from which to sample lighting instead of the entity's origin. Not in .

Damage Filter Name (damagefilter) ([todo internal name (i)]) <targetname>

When this entity receives damage, it will filter by this entity.

Start Fade Distance (fademindist) ([todo internal name (i)]) <float>

Distance at which the entity starts fading. If <0, the entity will disappear instantly when end fade is hit. The value will scale appropriately if the entity is in a 3D Skybox.

End Fade Distance (fademaxdist) ([todo internal name (i)]) <float>

Distance at which the entity ends fading. If <0, the entity won't disappear at all. The value will scale appropriately if the entity is in a 3D Skybox.

Fade Scale (fadescale) ([todo internal name (i)]) <float>

If specified in the worldspawn, or if the engine is running below DirectX 8, entities will fade out even if the fade distances above aren't specified. This value gives more control over when this happens: numbers smaller than 1 cause the entity to fade out at further distances, and greater than 1 cause it to fade out at closer distances. Using 0 turns off the forced fade altogether. See also $noforcedfade.

Render Mode (rendermode) ([todo internal name (i)]) <choices>

Set a non-standard rendering mode on this entity.

• 0: Normal
• 1: Color
• 2: Texture
• 3: Glow
• 4: Solid/Alphatest
• 5: Additive
• 6: Removed, does nothing
• 7: Additive Fractional Frame
• 8: Alpha Add
• 9: World Space Glow
• 10: Don't Render

Render FX / Transparency (0 - 255) (renderamt) ([todo internal name (i)]) <integer>

Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.

Render Color (R G B) (rendercolor) ([todo internal name (i)]) <color255>

Color tint.

Render FX (renderfx) ([todo internal name (i)]) <choices>

Preset pattern of appearance effects.

• 0: None
• 1: Slow Pulse
• 2: Fast Pulse
• 3: Slow Wide Pulse
• 4: Fast Wide Pulse
• 5: Slow Fade Away
• 6: Fast Fade Away
• 7: Slow Become Solid
• 8: Fast Become Solid
• 9: Slow Strobe
• 10: Fast Strobe
• 11: Faster Strobe
• 12: Slow Flicker
• 13: Fast Flicker
• 14: Constant Glow
• 15: Distort
• 16: Hologram (Distort + fade)
• 17: Scale Up
• 22: Spotlight FX
• 23: Cull By Distance
• 24: Fade Wider Pulse
• 26: Fade Near

Todo: 18-21, 25

Shadow Cast Distance (shadowcastdist) ([todo internal name (i)]) <integer>

Sets how far the entity casts dynamic shadows. 0 means default distance from the shadow_control entity.

Disable Shadows (disableshadows) ([todo internal name (i)]) <boolean>

Prevent the entity from creating cheap render-to-texture shadows. Does not affect shadow mapping.

Disable Receiving Shadows (disablereceiveshadows) ([todo internal name (i)]) <boolean>

Prevent the entity from receiving shadows on itself.

Model Scale (modelscale) ([todo internal name (i)]) <float> (in all games since OB)

A multiplier for the size of the model. Negative values are accepted. Does not alter the physics collisions in most cases, however. Not in , , , sdk 2013.

Warning:Negative or extremely high values can cause crashes!

Glow Backface Multiple (glowbackfacemult) ([todo internal name (i)]) <float> (in all games since ) !FGD

If this object has a glow effect, multiply the effect by this much on the sides of the object that are facing away from the viewer.

Move Type (MoveType) ([todo internal name (i)]) <choices> (in all games since ) !FGD

Sets a movetype for this entity, which changes its movement behavior.

• 0: None, don't move
• 1: Isometric
• 2: Walk, player only, moving on ground
• 3: NPC, movement
• 4: Fly, no gravity
• 5: Fly, with gravity
• 6: Physics
• 7: Push
• 8: Noclip
• 9: Ladder, for players on ladders
• 10: Spectator
• 11: Custom

Collision Group (CollisionGroup) ([todo internal name (i)]) <choices> (in all games since ) !FGD

Sets a collision group for this entity, which changes its collision behavior.

• 0: None
• 1: Debris, collides only with the world and static props
• 2: Debris, with trigger interaction
• 3: Interactive Debris, doesn't collide with other debris
• 4: Interactive, collides with everything except debris
• 5: Player
• 6: Breakable Glass
• 7: Vehicle
• 8: Player Movement
• 9: In-Vehicle
• 10: Weapon
• 11: Vehicle Clip
• 12: Projectile
• 13: Door blocker, not permitted to go near doors
• 14: Passable Door
• 15: Dissolving
• 16: Pushaway
• 17: NPC Actor, NPCs ignore the player
• 18: NPC Scripted, NPCs do not collide with each other

Base Velocity (BaseVelocity) ([todo internal name (i)]) <vector> !FGD

Adds to the velocity of the player.
Format: <x> <y> <z>

Todo: Test for games other than , and

Disable ShadowDepth (disableshadowdepth) ([todo internal name (i)]) <boolean> (in all games since )

Makes this entity not cast a shadow from env_projectedtextures.

Projected Texture Cache (shadowdepthnocache) ([todo internal name (i)]) <choices> (in all games since )

Used to hint projected texture system whether it is sufficient to cache shadow volume of this entity or to force render it every frame instead.

• 0: Default
• 1: No cache - render every frame
• 2: Cache it - render only once

Disable Flashlight (disableflashlight) ([todo internal name (i)]) <boolean> (in all games since )

Used to disable projected texture lighting and shadows on this entity.

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. Not available in series.

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

Bug:In and , 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>

Sets the fog controller to use for the !activator. Not available in series.

SpeakResponseConcept <stringRedirectInput/string>

Speak the specified response concept immediately. Not available in series.

IgnoreFallDamage <floatRedirectInput/float>

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>

Absolutely prevent the player from taking fall damage for [n] seconds.

OnSquadMemberKilled

Notification of a player's NPC ally in the players squad being killed.

DisableFlashlight

Disables the player's flashlight.

EnableFlashlight

Enables the player's flashlight.

ForceDropPhysObjects

Force the player to drop any physics objects they are carrying.

OnRescueZoneTouch

Fired when a hostage is rescued. This input is also available in the code for and .

SetCommentaryStatueMode

^[Todo].

DisableLedgeHang

Disable ledge hanging by player.

EnableLedgeHang

Enable ledge hanging by player.

TeleportToSurvivorPosition <stringRedirectInput/string>

Teleport a player to an info_survivor_position entity, then freezes them. To unfreeze them, use the ReleaseSurvivorPositions input from info_director.

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, only initiates 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.

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.

TriggerLootIslandAchievement

^[Todo].

TriggerLootIslandAchievement2

^[Todo].

RoundSpawn

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

Note:Content moved to Rendering and studio model related KIO/Inputs for continuation of page history

Outputs

Note:Content moved to Rendering and studio model related KIO/Outputs for continuation of page history