For the entity to work, its target material must have the
MaterialModifyAnimated proxy installed, and must be applied to an entity.
Instances of the Material to Modify on world geometry are controlled by the lowest-ID (first created in Hammer) material_modify_control, in addition to instances of the material on the material_modify_control's parent.
- Material to modify
- Path to the VMT file you want to modify, relative to
.vmtsuffix.Bug: Does not work if the VMT is just in
materials/. Should be in a subfolder, like
materials/effects/for example.Bug: (Confirmed to be the case in ) When a Material has a $envmap with
env_cubemapas the value this entity will appear to not work for that material. This is because VBSP will patch the original material and give it a different name that corresponds to the position of the closest cubemap to the brush face that has that material. This happens for every occurrence of the material. In order to make it work you can replace the
env_cubemapin your material with the path to the generated image of the closest cubemap for example:
env_cubemap "maps/yourmap/c124_28_-60"} (however that means you will have to do it for every occurrence of the material you want to change especially when you want them to use different cubemap images). This will make it so that VBSP will not try to patch the material and thus leave the original name. Another way is to just to directly specify the patched material name that is generated by VBSP which you can find after unpacking the map file.
- Material variable to modify
- Name of the shader parameter you want to modify. Include
$symbol like how they are written in the VMT
- Entity Scripts
- 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
- 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.
- Sets the chosen material parameter to the specified value.
- This sets the material variable to the current time on the server.
- Force an animated material with the MaterialModifyAnimated proxy to play a set of animation frames.
<Frame Start> <Frame End> <Frame Rate> <Loop>
<Loop>should be 1 or 0.Tip: Setting "Frame End" to -1 uses the last frame of the texture.
- Force a material with the MaterialModifyAnimated proxy to linearly interpolate a material var between two floating point values.
<Start Value> <End Value> <Transition Time> <Loop>
<Loop>should be 1 or 0.
To do: There are some clarifications needed to be done about some quirks of this Input.
- 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.
- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
- Removes this entity from the world.
- 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
- Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
- Fire the
OnUseroutputs; see User Inputs and Outputs.
- 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.
- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
- 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.
- 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.
- These outputs each fire in response to the firing of the like-numbered
FireUser4Input; see User Inputs and Outputs.
- This output fires when the entity is killed and removed from the game.