Func instance: Difference between revisions
Jump to navigation
Jump to search
Note:Entity names that start with the
Note:There are 10 Replace key-value pairs with the keys following replace{number} for names: replace01, replace02, ..., replace10
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
Instances allow you to edit the vmf of the instance and have every used instance on your main map be changed as well. But unfortunately many instances will lag hammer quite alot. | Instances allow you to edit the vmf of the instance and have every used instance on your main map be changed as well. But unfortunately many instances will lag hammer quite alot. | ||
{{ | {{ModernWarning|Self recursive instances (i.e. instances which include themselves) will crash Hammer.}} | ||
{{ModernNote|Instances are disabled by default in pre-[[Left 4 Dead 2]] games (except Team Fortress 2). To enable them, add a <code>GameData</code> key to [[gameinfo.txt]], pointing to the game's FGD file.}} | {{ModernNote|Instances are disabled by default in pre-[[Left 4 Dead 2]] games (except Team Fortress 2). To enable them, add a <code>GameData</code> key to [[gameinfo.txt]], pointing to the game's FGD file.}} | ||
Revision as of 10:54, 26 July 2022
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 in Hammer with an orange tint, though this can be disabled in Instancing > View Instances.
Instances allow you to edit the vmf of the instance and have every used instance on your main map be changed as well. But unfortunately many instances will lag hammer quite alot.
Template:ModernNote Template:ModernNote
Template:ModernBug Template:ModernBug Template:ModernBug Template:ModernBug Template:ModernBug
Input through an instance
- Define a Fix Up Name.
- Define a value for the input or output you want to use (if there is one).
- 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 (file) <string>
- The VMF file to insert as an instance.
- Fix Up Name (propagate_fixup) <string>
- Essentially the name of the instance. All entities within it will have this string added to them based upon the fix up style. If no name is provided,
InstanceAutoXorAutoInstanceXwill be used, where X is a number that is incremented with each instance.
Note: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 (fixup_style) <choices>
- How to apply the fix up name.
- 0: Prefix (Default)
- 1: Postfix
- 2: None
- Replace (replace01) <instance_variable>
- This is a replacement parameter. Any usage of
$variableinside the instance will be replaced withvalue. Replace<string $variable> <string value>. Example: $color 255 0 0.
Note:There are 10 Replace key-value pairs with the keys following replace{number} for names: replace01, replace02, ..., replace10
- 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
- func_instance_parms - Entity to control parameters within instances.
- func_instance_io_proxy - Entity that is used as a proxy for entity I/O within instances.
- func_instance_origin - Helper entity that defines the center point of an instance.
- L4D2 Level Design/VMF Instances - A tutorial on how to use this entity in Left 4 Dead 2.