List of Portal 2 Instances
A main feature of Portal 2 is its use of instances. In short, instances (placed in Hammer with the func_instance entity) allow for the placement of VMFs inside other VMFs. They are similar to prefabs, but when the source file of an instance is modified the changes take effect in all maps containing them. For more information see Instance.
Below is a list of the instances provided with the Portal 2 Authoring Tools. They are categorized by the folder structure in which they are packaged and I've tried to make a short description for each one; any help is greatly appreciated.
Instances are stored in
C:\Program Files\Steam\steamapps\common\portal 2\sdk_content\maps\instances\.
Note: the terms "powerup" and "powerdown" refer to the activation and deactivation of the facility, respectively, as this is the terminology Valve uses in the animations.
- 1 Instances
- 1.1 animated_panels
- 1.2 bts
- 1.3 buttons
- 1.4 chamber_hallways
- 1.5 choreo
- 1.6 coop
- 1.7 destruction
- 1.8 door
- 1.9 elevator_scenes
- 1.10 gameplay
- 1.11 labs
- 1.12 lights
- 1.13 monitors
- 1.14 multiplayer
- 1.15 signs
- 1.16 test_chambers
- 1.17 transitions
- 1.18 tube_elevator
- 1.19 turbine_elevator
- 1.20 underground
- 1.21 p2editor
- Environment and campaign entities. Recommended in all maps. global_ents.vmf (Portal 2) contains a list of the HDR preset settings available in the instance.
- Basic set of environment and singleplayer entities. Useful for test maps.
- A horizontal row of four panels that can be triggered to use powerup and powerdown animations.
- A horizontal row of two panels that can be trigger to use powerup animations.
- Two columns of four panels that can be triggerd to use powerup animations. Slighty more "bendy" and organic as the name suggests.
- Same as above only using a slightly different animation.
- A dirty ceiling panel below a clean ceiling panel; the dirty one hinges and falls, replaced by the clean one. Does not use models but instead a func_physbox and func_door.
- Same as above but without the clean ceiling panel replacing the dirty one. Dirty panel hinges and falls.
- A 2x2 square of panels that can move back and forth from vertical to horizontal to form a ramp from a wall.
- Identical to 128x128_ceiling_panel_fall_01.vmf but vertical for a wall.
- A wall panel that moves slightly forward and rotates.
- Same as above only rotates in the opposite direction.
- A 2x2 square of vertical panels that can open into and close back into the wall of a chamber to allow a "peek" effect. Seen when Wheatly pops his head in to a chamber.
- A large section/ramp that can be rotated into and out of a wall.
- Various pipe structures for use in destroyed-themed maps
- A prop_static set to models/props_bts/truss_512_cheap.mdl
- A piece of testchamber wall with lights for use in Wheatley-themed test chambers
- A prop_floor_button on a clean black button base.
- Clean button bases with black or white panels.
- Ruined button bases with black or white panels.
- A static hallway with a bulging floor. Random stuff (cubes, turrets, etc.) can be seen below causing the bulge.
- A nodraw box containing the generic_actor set to GLaDOS. Presumably for use with in-game scenes, lines, etc.
- The disassembly machine for Atlas.
- The disassembly machine for P-Body.
- Disassembler/exit room, clean theme.
- Disassembler/exit room, underground theme.
- The 4-panel airlock doorway.
- Like global_ents.vmf but for co-op.
- Co-op entrance room, clean theme.
- Co-op entrance room, destroyed theme.
- Co-op entrance room, underground theme.
- A testchamber door specialized for co-op.
- Same as above, underground theme.
- A detailed co-op entrance room, underground theme.
- A prop instance for use with destroyed-themed test chambers.
- Several entities including an ambient_generic, env_shake, a logic_timer, and the other logic entites that make them work. All entities are parented to a func_tracktrain that moves around a very large square, which is used to give the impression that distant explosions are coming from different directions. For use with Wheatley-themed test chambers.
To be added soon.
- A "junk stacked in elevator" scene. Used in sp_a2_column_blocker.
To be added soon.
- An empty observation room with a window 256 by 128, without lighting or furniture.
- An observation room with a window 64 by 128. The room turns to the right. It contains two stools, a desk, and two monitors. The latter seems to be the same as the former, with the addition of an overhead light.
- An observation room with a window 64 by 128. It produces no light, and the room turns to the left. It has no furniture.
- A room similar to observation_room_64x128_1b.vmf, except it lacks monitors and doesn't give off light.
- An observation room that looks similar to observation_room_64x128_1off.vmf, but the room is smaller, and it lacks an entry door.
A room with a window that's 128 by 128. It contains two lab chairs and a desk, but lacks a door. The latter adds an overhead light.
A duplicate room of observation_room_128x128_1.vmf, but it lacks chairs, lighting, and the window is broken.
A room similar to observation_room_128x128_1off.vmf, but the window isn't broken. It still gives off no light.
A room with a window that's 192 by 128. The former only contains a desk, and lacks chairs or a door. The latter is exact same, with the inclusion of a single monitor, and overhead light.
An exact duplicate of observation_room_192x128_1.vmf, but without the lighting.
A room similar to observation_room_192x128_1b.vmf, but for some reason has a glass cover light inside the window, and the lighting is misplaced.
The former is a room that matches observation_room_256x128_1off.vmf, but with lighting. The latter has the inclusion of a ceiling light.
An exact duplicate of observation_room_256x128_1off.vmf.
A duplicate of observation_room_256x128_1.vmf, but the inside window texture is incorrectly rendered.
Cool in filename means cool light (more blue), warm means warm light (more red) and neutral means white light (like sunlight).
off/low/med/high gives the intensity of light.
- bts_light_fluorescent _01_128a.vmf
- bts_light_fluorescent _01_128a_nolight.vmf
- bts_light_fluorescent _01_128a_off.vmf
- bts_light_fluorescent _01_128b.vmf
- bts_light_fluorescent _01_128b_background.vmf
- bts_light_fluorescent _01_128b_warm.vmf
- bts_light_fluorescent _01_128c.vmf
- A wheatley monitor. Position flush into the wall, then trigger inputs to extend it. The instance contains logic to break the screen when cubes or players impact at high speeds,
- A room containing a Wheatley actor and camera to display on monitors. Place one in every map, and send inputs to cause him to enter/leave the view or change the zoom. Wheatley will automatically perform animations in sync with any A4 choreo_scenes.
To be added soon.
- The test chamber sign, clean theme.
- The test chamber sign, destroyed/reconstructing themes.
- The 'surprise' room from the game.
- An underground light-pylon.
- A wall in the Wheatly style, with a monster box and ledge-forimg panels.
- A large piece of func_detail, in the destroyed style.
- Contains entities for spawning in or transitioning between levels. Recommended for test chamber maps. To do: Page describing Portal 2 transition entities.
- Nested in arrival_departure_transition_ents.vmf. Entities for transitioning into a test chamber. Contains info_player_start.
- Nested in arrival_departure_transition_ents.vmf. Entities for transitioning from a test chamber.
To be added soon.
there are two type of instance the departure and the arrival
- the XX_base.vmf is the structure of tube elevator, there are some different skin of the room (destroyed,clean,...) with 42 vgui_movie_display entities
- the XX_logic.vmf is the motion of tube elevator, there are two version (come from up or down) contains some trigger to activate elevator sound or open first door of the map. there is a logic_script to call the video script for the vgui_movie_display in the XX_base.vmf
all this instance (logic and base) can be stick with the long block behind the structure of elevator
- Simple player_loadsaved instance, used to load the last saved game when falling into the goo.
- Underground test chamber door.
- 4096x4096 underground testing dome with surrounding sealing.
- Underground entrance lift.
- Underground exit lift.
- Underground cube dropper.
Instances used for the Puzzlemaker. These instances are quite complex and are not recommended for use outside of the Puzzlemaker's generated maps.
- Room containing the level start and exit triggers, for Portal 2's level start/stop system.
- AND logic to control fizzler enabling/disabling. The fizzler/laserfield brushes themselves are generated by the PeTI.
- An instanced version of the fizzler model, controled by the base instance.
- Modified versions of the Coop disassemblers used inside the coop_exit instance.
- Instanced version of Hard Light Bridges.
- Player respawn dropper, with instance vsriables to set the team. Used inside the door_entrance_coop_1 instance.
- Cooperative disassembly room, including worldportals to connect to the main level.
- Instances to spawn the various dropperless cubes. Point_templates are used to allow the cubes to spawn in late, when the @relay_spawn_3 relay is triggered. This allows angled panels and light bridges to initialise without affecting the cubes.
- A exit door with camera, and associated logic to lock it until both players are standing in front of it. Used by the door_exit_coop_*.vmf instances.
- door_entrance_1.vmf - door_entrance_7.vmf
- Various entry corridors randomly chosen for singleplayer maps. Use worldportals to connect to the elevator.
- The entry spawn room for coop maps. There is no worldportal in this instance, unlike the other entry/exit rooms.
- door_exit_1.vmf - door_exit_4.vmf
- Various exit corridors randomly chosen for singleplayer maps. Use worldportals to connect to the elevator. If $no_player_start is set to 0, the map will restart after reaching the corridor.
- door_exit_coop_1.vmf - door_exit_coop_4.vmf
- Various exit corridors randomly chosen for coop maps. Use worldportals to connect to the disassembler. If $no_player_start is set to 0, the map will restart after reaching the corridor.
- Door cutouts used with the entry/exit corridors to allow them to match the main map.
- Logic used in the singleplayer elevators.
- Singleplayer mode entry elevator. It contains the global_ents and global_pti_ents instances, and uses worldportals to connect to the main map. If $no_player_start is set to 0, the player will be teleported to just behind the entry door.
- Singleplayer mode exit elevator. It contains the arrival_departure instances, and triggers the Workshop vote page when the player enters the elevator. It also uses worldportals to connect to the main map.
- Aerial Faith Plate instance. Trigger inputs to cause it to fire angled or straight up.
- Instance containing the bullseye decal used at the end of catapult trajectories.
- floor_ball_button_black.vmf and floor_ball_button_white.vmf
- floor_button_black_intact.vmf and floor_button_white_intact.vmf
- floor_cube_button_white.vmf and floor_cube_button_black.vmf
- The various weighted buttons placed on white/black raised sections.
- Dispite the name, used for both glass and gratings. Contains player and physics clips for use with gratings.
- Frame instances used to create the borders. These use the '
props_ingame/window_frame_system*' models. Two instances are used per edge.
- Modified version of the normal global_ents instance, containing various global entities like fog and lighting controllers. The music ambient_generic is located here.
- Instance used to control Workshop support. Required for all uploaded maps. It plays the random Cave quote at map spawn, and is used to trigger the vote screen at the end of levels. Set $disable_pti_audio to 1 to prevent the Cave line from playing, and trigger the @relay_pti_level_end to display the vote screen. The @relay_play_pti_audio relay can be enabled and triggered to play the audio at a later time if needed.
- Unused instance containing triggers to hurt players and destroy physics objects.
- Instance version of prop_indicator_panels. The entity is placed to appear 0.1 units above the mounted surface.
- Instance version of env_texturetoggles. The $indicator_name variable must use a @targetname to work correctly.
- Duplicate of signs/info_sign_sp_clean
- Unused cubedropper instance that spawns Frankenturrets.
- Cubedropper instance customised for PeTI. If $disable_autodrop is set to 0, it will dispense a cube when the @relay_spawn_on_entrance relay is triggered. The $indicator_lights variable is unused by the PeTI, but will function if given an @targetname value. $Cube_type values:
- 0: Standard
- 1: Companion
- 2: Reflection
- 3: Sphere
- 4: Antique (Not recommended)
- 6: FrankenTurret
- laser_catcher_center.vmf and laser_catcher_offset.vmf
- laser_emitter_center.vmf and laser_emitter_offset.vmf
- laser_relay_center.vmf and laser_relay_offset.vmf
- Versions of the Thermal Discouragement Beam devices. The offset versions are positioned inside the instance to appear on the side of the 128x128 block.
- lift_platform.vmf and lift_platform_oscillate.vmf
- Track platform instances. Set $travel_direction and $travel_speed to define the distance moved.
- Instance used for piston platforms. Very complex. Set $top_level and $bottom_level to between 0-5 to define the distance it moves in increments of 128 units.
- Instances used to create the track platform track. The grate instance is used when the platform has the bottom section fully enclosed.
- Version of the light strips for PeTI maps. The model is positioned to appear 0.1 units above the surface, allowing it to be placed without wall cutouts.
- The small and large observation rooms. When the @relay_lights_on relay is triggered these will light up. The large room contains an env_projectedtexture.
- Gel Dispensers. The PeTI creates a trigger_catapult in front of the paint bomb variant to target it onto the endpoint.
- Instance for pre-placed gel. The info_paint_sprayer is named @pre_paint_sprayer, and is activated for 1 second during map start. In coop, this is activated by a trigger hidden inside ATLAS's player spawner.
- panel_black*.vmf and panel_white*.vmf
- Unused angled panel instances, likely originating before the angled surface was implemented as a PeTI-generated brush.
- Instances for regular and glass-covered angled panels. The $animation variable should be set to one of the 'ramp_##_deg_open' animations, where ## = 30,45,60 or 90 degrees. The regular panel's brush is generated by the PeTI in addition to a logic_auto to set the parent attachment.
- Logic to control flip panels. The func_door_rotating is generated by the PeTI.
- Unused instance, appearing as a panel extended outward on a piston.
- Instanced version of prop_buttons. The small platform the button is placed on is generated by the PeTI. If set to infinite time the $timer_delay variable will be set to '99999999999'.
- An info_placement_helper, which is used for Gel Droppers. This is not connected propertly to the dropper inputs, so much of the logic is unnecessary.
- Ambient lighting instance placed randomly throughout the map.
- The instance used for stair panels.
- tbeam_frame_black.vmf and tbeam_frame_white.vmf
- Used to allow the Excursion funnel to match the wall surface.
- The instance for Excursion Funnels.
- Instances used for the arrival/departure transition instance.