Func instance: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
Bug:Although found and working in the Hammer editor for all Source games, it is currently supported by the map compilers for Left 4 Dead 2, Alien Swarm and Portal 2 only.  [todo tested in ?]
Bug: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 ?]
		
	
mNo edit summary  | 
				 (Added note about a bug that is fixed in L4D2, but not in AS.)  | 
				||
| Line 2: | Line 2: | ||
{{bug|Although found and working in the Hammer editor for all Source games, it is currently supported by the map compilers for [[Left 4 Dead 2]], [[Alien Swarm]] and [[Portal 2]] only.}}  | {{bug|Although found and working in the Hammer editor for all Source games, it is currently supported by the map compilers for [[Left 4 Dead 2]], [[Alien Swarm]] and [[Portal 2]] only.}}  | ||
{{bug|Nested instances with relative file names don't work correctly in Alien Swarm, because they are handled differently in Hammer and VBSP.}}  | |||
{{intent}}  | {{intent}}  | ||
Revision as of 17:51, 2 May 2011
Entity Description
An entity for placing an instance of a map file. You may translate and rotate this entity. You can use the replace keys to do parameter changes on the instance contents. In a $ at the beginning of a variable name. Then just use the $variable name inside of the instance contents on any value portion of a key/value pair.
KeyValues
- 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.
 - Fix Up Name 
<target_source> - The name that all entities will be fixed up with based upon the fix up style.
 - VMF Filename 
<instance_file> - This indicates a map file relative to the map's file name.
 - Entity Name Fix Up 
<choices> - Fixup style for instanced entity names.  Uses the 'Fix Up Name' field.
- Prefix (Default)
 - Postfix
 - None
 
 
- Replace 
<instance_variable> - This is a replacement parameter. It goes in the form of $variable value. All entities inside of that instance that have $variable somewhere will be replaced with the value contents. Example: $color 255 0 0
 
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.
 - L4D2 Level Design/VMF Instances - A tutorial on how to use this entity in Left 4 Dead 2.