env_cubemap_box

env_cubemap_box is a point entity available in SteamVR Home, Half-Life: Alyx, and Counter-Strike 2. It is a parallax corrected cubemap environment probe for sampling indirect specular reflection. The reflections are projected in a rectangular volume for materials with the Specular Cubemap Projection option enabled.

Keyvalues

Box Projection Mins (box_mins) <vector>

Minimum bounds. Set by dragging the controls of the entity with the Hammer Select tool.

Box Projection Maxs (box_maxs) <vector>

Maximum bounds. Set by dragging the controls of the entity with the Hammer Select tool.

Cubemap Texture (cubemaptexture) <string>

Name of the cubemap texture.

Tip:This is normally assigned by the light baker and does not need to be manually set.

Bake Near Z (bakenearz) <float>

Near clip plane used for the camera when baking the cubemap.

Bake Far Z (bakefarz) <float>

Far clip plane used for the camera when baking the cubemap.

Start Disabled (StartDisabled) <boolean>

Source 2 LPV and Cubemap:

Priority (indoor_outdoor_level) <integer>

If multiple volumes contain an object, the highest priority volume takes precedence.

• -2 - Lowest
• -1 - Low
• 0 - Normal
• 1 - High
• 2 - Highest

Light Group (lightgroup) <string>

Semicolon-delimited list of light groups to affect.

Moveable (moveable) <boolean>

Can be moved, parented, enabled, or disabled at runtime.

Source 2 Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist>

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.

Create Client-Only Entity (clientSideEntity) <choices>

• 0: No
• 1: Yes

Source 2 Hierarchy:

Parent (parentname) <targetname>

Specifies a movement parent. An entity will maintain its initial offset from its parent.

Parent Model Bone/Attachment Name (parentAttachmentName) <string>

The name of the bone or attachment to attach to on the entity's parent in the movement hierarchy. Use !bonemerge to use bone-merge style attachment.

Model Attachment position offset (local.origin) <coordinates>

Offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

Model Attachment angular offset (local.angles) <angles>

Angular offset in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

Model Attachment scale (local.scales) <vector>

Scale in the local space of the parent model's attachment/bone to use in hierarchy. Not used if you are not using parent attachment.

Use Model Attachment Offset (useLocalOffset) <boolean>

Whether to respect the specified local offset when doing the initial hierarchical attachment to its parent.

Source 2 Transform:

Origin (origin) <coordinates>

The world space origin of the entity.

Angles (angles) <angles>

The pitch, yaw, roll orientation of the entity.

Scale (scales) <vector>

The x, y, z scales of the entity. Not all entities can use this.

Transform Locked (transform locked) <boolean>

Lock the transform at its current value, preveting the transform of the node from being modified.

Force Hidden (force hidden) <boolean>

Visually hides the entity from the viewports. The Outliner pane will still list hidden entities.

Editor Only (editor only) <boolean>

Entity is only displayed in Hammer and will not appear in game.

Inputs

Enable

Enable this entity.

Disable

Disable this entity.

Source 2 Targetname:

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and all its children from the world.

AddOutput <string>

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

RunScriptFile <string>

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

RunScriptCode <string>

Execute a string of VScript source code in the scope of the entity receiving the input.

CallScriptFunction <string>

Call a script function.

CallPrivateScriptFunction <string>

Calls a script function from this entity's private script scope.

CallGlobalScriptFunction <string>

Calls a script function in the global script scope.

Source 2 Hierarchy:

SetParent <string>

Changes the entity's parent in the movement hierarchy.

SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.

SetParentAttachmentMaintainOffset <string>

Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the parent at the time it is attached.

ClearParent

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

Outputs

Source 2 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

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

See also

• Basic Lighting
• Adding Lighting