Env tonemap controller

Env tonemap controller

env_tonemap_controller is a point entity available in all Source games. It controls the HDR tonemapping for the player. Think of it as a method of controlling the exposure of the player's eyes. Tonemapping affect all players in multiplayer. HDR settings should normally be changed through triggers, whenever transitioning between environments of different light levels.

In code, it is represented by theCEnvTonemapControllerclass, defined in theenv_tonemap_controller.cppfile.

Flags

• 1: Master (Has priority if multiple env_tonemap_controllers exist) (in all games since )

Keyvalues

Base:

Name (targetname) <string>

The name that other entities use to refer to this entity.

Parent (parentname) <targetname>

Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (parentname [targetname],[attachment])

 Tip: Entities transition to the next map with their parents

 Tip: phys_constraint can be used as a workaround if parenting fails.

Origin (X Y Z) (origin) <coordinates>

The position of this entity's center in the world. Rotating entities typically rotate around their origin.

 Note: Hammer does not move the entities accordingly only in the editor.

Pitch Yaw Roll (X Y Z) (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.

 Note: This works on brush entities, although Hammer doesn't show the new angles.

Classname (classname) <string> !FGD

Determines the characteristics of the entity before it spawns.

 Tip: Changing this on runtime still has use, like making matching an entry in S_PreserveEnts will persist the entity on new rounds!

Flags (spawnflags) <integer> !FGD

Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.

Effects (effects) <integer> !FGD

Combination of effect flags to use.

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

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.

Think function (thinkfunction) <string> (in all games since ) (also in )

Name of the function within this entity's script that'll be called automatically every 100 milliseconds, or a user-defined interval if the function returns a number. Avoid expensive operations in this function, as it may cause performance problems.

Lag Compensation (LagCompensate) <boolean> (in all games since ) !FGD

Set to Yes to lag compensate this entity. Should be used very sparingly!

Is Automatic-Aim Target (is_autoaim_target) <boolean> (in all games since ) !FGD

If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.

Inputs

SetTonemapScale <float> (not in )

Sets the player's tonemap scale. It should be a value between 0 and 2, where 0 is the eyes fully closed, 1 is use the unchanged autoexposure (default), and 2 is the eye fully wide open.

BlendTonemapScale <string> (not in )

Blends from the player's current tonemap scale to a new one. The parameter syntax is as follows: <target tonemap scale> <blend duration>. For example: 0.5 10 would blend from the current tonemap scale to 0.5 over a period of 10 seconds.

UseDefaultAutoExposure

Reverts to using the default tonemap auto exposure.

UseDefaultBloomScale  !FGD

Reverts to using the default bloom scale.

SetAutoExposureMin <float>

Sets a custom tonemap auto exposure minimum.

SetAutoExposureMax <float>

Sets a custom tonemap auto exposure maximum.

SetBloomScale <float>

Sets a custom bloom scale.

SetBloomScaleRange <vector> !FGD

Sets a range for the bloom scale. First number is the maximum, second number is the minimum.

 Bug: Broken. The code that processes this input has its formatting and source reversed.

SetTonemapRate <float>

Sets the rate for autoexposure adjustment (mat_hdr_manual_tonemap_rate).

SetBloomExponent <float> (in all games since )

Sets a custom bloom exponent.

SetBloomSaturation <float> (in all games since )

Sets a custom bloom saturation.

SetTonemapPercentBrightPixels <float> (only in )

Sets a target percentage of pixels to maintain above a certain brightness. (default: 1)

SetTonemapPercentTarget <float> (only in )

Sets the brightness that the percentage of pixels defined by SetTonemapPercentBrightPixels should be kept above. (default: 45)

SetTonemapMinAvgLum <float> (only in )

Sets custom tonemapping param (default: 3).^[Clarify]

Base:

AddContext <string>

Adds to the entity's list of response contexts. Format is <key>:<value>.

AddOutput <string>

Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:

Syntax: 

// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"

// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"

ClearContext

Removes all contexts from this entity's list.

ClearParent

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

FireUser1 to FireUser4

Fires the respectiveOnUseroutputs; see User Inputs and Outputs.

Kill

Removes this entity and any entities parented to it from the world.

KillHierarchy

Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.

RemoveContext <string>

Remove a context from this entity's list. The name should match the key of an existing context.

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.

Use  !FGD

Same as a player invoking +use; no effect in most cases.

DispatchResponse <string> !FGD

Dispatches a response to the entity. See Response and Concept.

DispatchEffect <string> (removed since ) !FGD

Dispatches a special effect from the entity's origin; see also List of Client Effects. Replaced by the particle system since .

RunScriptFile <script> (in all games since ) (also in )

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 ) (also in )

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 Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.

Fix: Remove the string argument manually with a text editor.

 Note:  Backtick characters ` are replaced with quotation marks at runtime, allowing quotation marks to be used when normally not possible.

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

Calls a VScript function defined in the scope of the receiving entity.

TerminateScriptScope  (only in ) !FGD

Destroys the script scope of the receving 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.

Outputs

Base:

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.

See also

• HDR Lighting Settings