env_projectedtexture

Projecting a colourful texture in Garry's Mod

Portal 2 uses projected textures extensively for world lighting.

env_projectedtexture is a point entity available in all Source games since Episode Two. It projects a texture as a dynamic light that affects all objects in the world, optionally with shadow mapping.

Caveats

• Valve's games only support one shadow map at a time. Mods can remove this limit.
• Shadows are only rendered when the user is running with "High" shadow detail.
• In multiplayer, mp_flashlight and mat_supportflashlight must be set to 1 for flashlights to work. By default these ConVars are disabled in Team Fortress 2, so this entity won't work there without special configuration.
• Viewmodels won't receive light or shadows from projected textures. See the code fix available.

Source 2007/2009 bugs

These have all been fixed in more recent engine builds.

 Bug: The configurable texture value from Hammer is not accepted - will always default to the flashlight. You must use the SpotlightTexture input or use the code fix available on the Bug Fixes page. This input doesn't work in Portal 2 Engine, and instead show an error message: "SetSpotlightTexture is disabled. If you need this feature reimplemented, tell a programmer."

 Bug: The entity cannot target another entity. See env_projectedtexture/fixes#Fixing targeting.

 Bug: Models will not receive their own shadows correctly unless using $bumpmap. Even a flat bump map is sufficient.

 Bug: Causes issues if it overlaps a portal in Portal 1.

Keyvalues

Target <targetname>

The entity will rotate to point at its target, no matter where it is in the world. Make sure you check the "Always update" flag if you set this.

FOV <float>

The field of view angle at which the texture is projected. The projection is square, but the texture can make it appear of any shape.
Remember the default Player FOV is 75°.

NearZ <float>

Near Z for projected texture. Default value is 4.0.
Objects closer than this will not receive the projection.

FarZ <float>

Far Z for projected texture. Default value is 750.0.
Objects beyond this distance will not receive the projection. Think of it as the range limit.

Enable Shadows <boolean>

Enables/disables shadows from this projected texture.

Shadow Quality <choices>

Quality of shadows. (To do: what's the difference?)

• 0 : Low
• 1 : High

Light Only Target <boolean>

Limit flashlight effect to only effect target entity. The world will still be lit.

Light World <boolean>

Control whether flashlight effects static world geometry.

Light Color <color255>

Light Color RGB-Intensity

Camera Space <integer>

Display relative to player's view. Breaks things horribly unless the entity moves with the player.

Brightness Scale <float> (in all games since )

Scale the light color by this brightness.

Color Transition Time <float> (in all games since )

Amount of time it takes for a color change to occur.

Texture Name <string> (in all games since )

The texture or material which this entity projects.

Appearance <choices> (in all games since )

Various Custom Appearance (see below) presets.

Custom Appearance <string> (in all games since )

Set a custom pattern of light brightness for this light. Pattern format is a string of characters, where a is total darkness, z fully bright. i.e. aaggnnttzz would be a steppy fade in from dark to light.

Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist> (in all games since )

Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.

Script think function (thinkfunction) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.

 Note: Try to avoid expensive operations in this function, as it may cause performance problems.

Parentname:

Parent (parentname) <targetname>

Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

 Bug: Does not work with stock SDK code. See Env_projectedtexture/fixes#Fixing Parenting.

Angles:

Pitch Yaw Roll (Y Z X) (angles) <angle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Appearances

Light Appearances

Literal Value	Description	Sequence	Preview
0	Normal	m
10	Fluorescent flicker	mmamammmmammamamaaamammma
2	Slow, strong pulse	abcdefghijklmnopqrstuvwxyzyxwvutsrqponmlkjihgfedcba
11	Slow pulse, noblack	abcdefghijklmnopqrrqponmlkjihgfedcba
5	Gentle pulse	jklmnopqrstuvwxyzyxwvutsrqponmlkj
1	Flicker A	mmnmmommommnonmmonqnmmo
6	Flicker B	nmonqnmomnmomomno
3	Candle A	mmmmmaaaaammmmmaaaaaabcdefgabcdefg
7	Candle B	mmmaaaabcdefgmmmmaaaammmaamm
8	Candle C	mmmaaammmaaammmabcdefaaaammmmabcdefmmmaaaa
4	Fast strobe	mamamamamama
9	Slow strobe	aaaaaaaazzzzzzzz
12 !FGD	Underwater light mutation	mmnnmmnnnmmnn

Flags

• 1 : Enabled
• 2 : Always Update (moving light) (in all games since )

Inputs

 Note: In Source 2007/2009, only TurnOn, TurnOff and SetFOV are known to Hammer.

TurnOn

Turn on the texture.

TurnOff

Turn off the texture.

SetFOV <float>

Set FOV. See lightfov keyvalue above.

SpotlightTexture <string>

Set the spotlight texture. Must be a VTF file (not VMT), relative to /materials.

Target <string>

Specify a new target entity to point at.

CameraSpace <boolean>

See above keyvalues.

LightOnlyTarget <boolean>

See above keyvalues.

 Bug: Non-functional.

LightWorld <boolean>

See above keyvalues.

 Bug: Cannot be re-enabled.

Ambient <boolean>

Allows for an ambiance light, much like the shadow color for it.

AlwaysUpdateOn  (in all games since )

Turn on per frame updating (for moving lights)

AlwaysUpdateOff  (in all games since )

Turn off per frame updating (for moving lights)

EnableShadows <boolean> (in all games since )

Set the if shadows are enabled

LightColor <color255> (in all games since )

Change the light color/brightness

SetLightStyle <integer> (in all games since )

Change the lightstyle. (see Appearance keyvalue above for possible values)

SetPattern <string> (in all games since )

Set a custom pattern of light brightness for this light. (see Custom Appearance keyvalue above)

SetNearZ <float> (in all games since )

Sets the near Z distance.

SetFarZ <float> (in all games since )

Sets the far Z distance.

Targetname:

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and its children from the world.

 Note: Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.

AddOutput <string>

Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O 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.

Use  !FGD

Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.

RunScriptFile <script> (in all games since )

Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode <string> (in all games since )

Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.

 Bug: In , the code is executed in the script scope of the entity that fires the output, not the one receiving the input.

 Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.

CallScriptFunction <string> (in all games since ) !FGD

Execute a VScript function in the scope of the receiving entity.

SetLocalOrigin <coordinates> (in all games since ) !FGD

Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.

SetLocalAngles <angles> (in all games since ) !FGD

Set this entity's angles.

Parentname:

SetParent <string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <string>

As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

ClearParent

Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

Targetname:

OnUser1 to OnUser4

These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.

OnKilled  (only in )

This output fires when the entity is killed and removed from the game.