Func instance

From Valve Developer Community
Revision as of 09:54, 23 May 2011 by TheLazyPanda (talk | contribs) ('@' operator for naming. (need confirmation for other game titles))
Jump to navigation Jump to search

Template:Point ent It inserts an instance of another VMF file into the current one. You can translate and rotate the instance without breaking anything or creating an off-grid editing nightmare.

By default, instances are drawn with an orange tint.

Note.pngNote:Instances will only compile correctly in Left 4 Dead 2 or later. If you would like to use instances in TF2 or HL2 you can work around this by saving your vmf as a clone, and collapsing the instances in that clone vmf.
Icon-Bug.pngBug:Nested instances with relative file names don't work correctly in Alien Swarm, because they are handled differently in Hammer and VBSP.  [todo tested in ?]

Template:Intent

Input through an instance

  1. Define a Fix Up Name.
  2. Define a value for the input or output you want to use (if there is one).
  3. Send an input to the targetname "fixupname-value", e.g. MyInstance-Start. Hammer's UI won't recognise the name, but don't worry.

KeyValues

VMF Filename <string>
The VMF file to insert as an instance.
Fix Up Name <string>
Essentially the name of the instance. All entities within it will have this string added to them based upon the fix up style.
Note.pngNote:Entity names that start with the @ symbol e.g. @exit_door will not be changed by the instance name fix up.
Todo: only confirmed for Portal 2
Entity Name Fix Up <choices>
How to apply the fix up name.
  • Prefix (Default)
  • Postfix
  • None
Replace <string $variable> <string value>
This is a replacement parameter. Any usage of $variable inside the instance will be replaced with value.
Example: $color 255 0 0
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
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.

See also