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 compiler for Left 4 Dead 2, Alien Swarm and Portal 2 only. [todo tested in ?]
m (Added Portal 2) |
(Some updates and corrections, removed unnecessary scrollboxes) |
||
| Line 1: | Line 1: | ||
{{ | {{point ent|func_instance|internal=1}} | ||
{{bug|Although found and working in the Hammer editor for all Source games, it is currently supported by the map compiler for [[Left 4 Dead 2]], [[Alien Swarm]] and [[Portal 2]] only.}} | |||
{{intent}} | {{intent}} | ||
==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== | ==KeyValues== | ||
{{KV Angles}} | |||
; Fix Up Name <code><target_source></code> | ; Fix Up Name <code><target_source></code> | ||
: The name that all entities will be fixed up with based upon the fix up style. | : The name that all entities will be fixed up with based upon the fix up style. | ||
; VMF Filename <code><instance_file></code> | ; VMF Filename <code><instance_file></code> | ||
: This indicates a map file relative to the map's file name. | : This indicates a map file relative to the map's file name. | ||
; Entity Name Fix Up <code><choices></code> | ; Entity Name Fix Up <code><choices></code> | ||
: Fixup style for instanced entity names. Uses the 'Fix Up Name' field. | : Fixup style for instanced entity names. Uses the 'Fix Up Name' field. | ||
:* Prefix (Default) | |||
:* Postfix | |||
:* None | :* None | ||
; Replace <code><instance_variable></code> | ; Replace <code><instance_variable></code> | ||
: 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 | : 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== | ==See also== | ||
*[[func_instance_parms]] - | *[[func_instance_parms]] - Entity to control parameters within instances. | ||
*[[L4D2 Level Design/VMF 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. | |||
[[Category:Left 4 Dead 2 Entities]] | |||
[[ | [[Category:Alien Swarm Entities]] | ||
[[ | [[Category:Portal 2 Entities]] | ||
Revision as of 12:00, 2 May 2011
Bug:Although found and working in the Hammer editor for all Source games, it is currently supported by the map compiler for Left 4 Dead 2, Alien Swarm and Portal 2 only. [todo tested in ?]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.