func_door Last edited 4 months ago2024-08-07 10:48:30 UTC

func_door - Brush Entity

Attributes

• Name (targetname) - Property used to identify entities. Leave empty to make it usable by players; otherwise named doors must be triggered by other entities to operate.
• Render FX (renderfx) - Gives objects special render effects. Think of it as modifying whatever the Render Mode puts out. The options are as follows:
  • 0 = Normal
  • 1 = Slow Pulse
  • 2 = Fast Pulse
  • 3 = Slow Wide Pulse
  • 4 = Fast Wide Pulse
  • 5 = Slow Fade Away
  • 6 = Fast Fade Away
  • 7 = Slow Become Solid
  • 8 = Fast Become Solid
  • 9 = Slow Strobe
  • 10 = Fast Strobe
  • 11 = Faster Strobe
  • 12 = Slow Flicker
  • 13 = Fast Flicker
  • 14 = Constant Glow
  • 15 = Distort
  • 16 = Hologram (Distort and Fade)
• Render Mode (rendermode) - Controls the type of rendering that is used for an object. Options are:
  • 0 = Normal
  • 1 = Color
  • 2 = Texture
  • 3 = Glow
  • 4 = Solid
  • 5 = Additive
• KillTarget (killtarget) - When the door is triggered, it will remove the entity specified by this property from the game.
• Master (master) - The name of a multisource (or game_team_master) entity. A master must usually be active in order for the entity to work. Thus they act almost like an on/off switch, in their simplest form, and like an AND gate in the case of the multisource.
• Move Sound (movesnd) - The sound that is played when the door opens. Options are:
  • 0 = No Sound (common/null.wav)
  • 1 = Servo (Sliding) (doors/doormove1.wav)
  • 2 = Pneumatic (Sliding) (doors/doormove2.wav)
  • 3 = Pneumatic (Rolling) (doors/doormove3.wav)
  • 4 = Vacuum (doors/doormove4.wav)
  • 5 = Power Hydraulic (doors/doormove5.wav)
  • 6 = Large Rollers (doors/doormove6.wav)
  • 7 = Track Door (doors/doormove7.wav)
  • 8 = Snappy Metal Door (doors/doormove8.wav)
  • 9 = Squeaky 1 (doors/doormove9.wav)
  • 10 = Squeaky 2 (doors/doormove10.wav)
• Stop Sound (stopsnd) - The sound that is played after the door closes. Options are:
  • 0 = No Sound (common/null.wav)
  • 1 = Clang with brake (doors/doorstop1.wav)
  • 2 = Clang reverb (doors/doorstop2.wav)
  • 3 = Ratchet Stop (doors/doorstop3.wav)
  • 4 = Chunk (doors/doorstop4.wav)
  • 5 = Light airbrake (doors/doorstop5.wav)
  • 6 = Metal Slide Stop (doors/doorstop6.wav)
  • 7 = Metal Lock Stop (doors/doorstop7.wav)
  • 8 = Snappy Metal Stop (doors/doorstop8.wav)
• Target (target) - When the door is opened, it triggers the entity with the name specified by Target.
• Locked Sound (locked_sound) - Sounds to play when the door is 'locked'. Options are:
  • 0 = None (common/null.wav)
  • 2 = Access Denied (buttons/button2.wav)
  • 8 = Small zap (buttons/button8.wav)
  • 10 = Buzz (buttons/button10.wav)
  • 11 = Buzz Off (buttons/button11.wav)
  • 12 = Latch Locked (buttons/latchlocked1.wav)
• Unlocked Sound (unlocked_sound) - Sound to play when the door is 'unlocked'. Options are:
  • 0 = None (common/null.wav)
  • 1 = Big zap & Warmup (buttons/button1.wav)
  • 3 = Access Granted (buttons/button3.wav)
  • 4 = Quick Combolock (buttons/button4.wav)
  • 5 = Power Deadbolt 1 (buttons/button5.wav)
  • 6 = Power Deadbolt 2 (buttons/button6.wav)
  • 7 = Plunger (buttons/button7.wav)
  • 8 = Small zap (buttons/button8.wav)
  • 9 = Keycard Sound (buttons/button9.wav)
  • 10 = Buzz (buttons/button10.wav)
  • 13 = Latch Unlocked (buttons/latchunlocked1.wav)
  • 14 = Light Switch (buttons/lightswitch2.wav)
• Locked Sentence (locked_sentence) - Sentence that is spoken when the door is 'locked'. Options are:
  • 1 = Gen. Access Denied (NA)
  • 2 = Security Lockout (ND)
  • 3 = Blast Door (NF)
  • 4 = Fire Door (NFIRE)
  • 5 = Chemical Door (NCHEM)
  • 6 = Radiation Door (NRAD)
  • 7 = Gen. Containment (NCON)
  • 8 = Maintenance Door (NH)
  • 9 = Broken Shut Door (NG)
• Unlocked Sentence (unlocked_sentence) - Sentence that is spoken when the door is 'unlocked'. Options are:
  • 1 = Gen. Access Granted (EA)
  • 2 = Security Disengaged (ED)
  • 3 = Blast Door (EF)
  • 4 = Fire Door (EFIRE)
  • 5 = Chemical Door (ECHEM)
  • 6 = Radiation Door (ERAD)
  • 7 = General Containment (ECON)
  • 8 = Maintenance area (EH)
• FX Amount (renderamt)
• FX Color (rendercolor)
• Global Entity Name (globalname)
• Pitch Yaw Roll (angles) - Sets the pitch (up / down), yaw (left / right) and roll (bank) respectively. For func_door, it sets the direction the door will move when opening.
• Speed (speed) - Speed of movement.
• Delay before close (wait) - Time to wait before the door closes after opening (-1 or 0 makes it stay open, or else use >0.1)
• Lip (lip) - Number of units left after move (the lip value is subtracted from the move distance).
• Damage inflicted when blocked (dmg) - How much damage the player receives if he gets stuck between the door and something solid.
• Message if triggered (message)
• Delay before fire (delay)
• Fire on Close (netname)
• Health (health) - With a non-zero value here, the door will have to be damaged to this extent to open. Bogus entry and not implemented.
• Minimum light level (_minlight)
• Light Origin Target (light_origin)
• ZHLT Lightflags (zhlt_lightflags)
• Give health on use (healthvalue) - [undocumented] Gives this much health to players when they open the door. Used as wall-mounted medkits in the early development of Half-Life.

Flags

• Starts open (1) - Door starts in its 'open' position.
• Don't link (4) - Restricts the door from being linked to a door with the same name (preventing it from opening as part of a pair).
• Passable (8)
• Toggle (32)
• Use only (256) - Player must "use" to open. Enabling this prevents the entity being triggered any other way.
• Monsters can't (512) - Monsters with arms (e.g. zombies, grunts) can't use the door.

Notes

• Giving func_door entity a name will make it locked. In other words, it will only operate when triggered by other entities such as a func_button and the absence of any entity targeting this named door effectively makes it permanently locked.
• To instead temporarily lock a door (and unlock it later) set its master to a multisource entity. Of course both can be combined e.g. a door cannot be operated with the button until the master is enabled.
• In addition to speed, the door will move relative to angles and according to its brush size (or more correctly its bounding box); the larger the brush, the longer the time until it reaches the other edge (time can be reduced by lip).
• While moving, it can get blocked by monsters, players, func_pushable and some satchels, but not by any other thing. If the wait value is >0, the door will return to its closed position, otherwise it will keep crushing the entities in its way.
• It can be pressed 64 units away from its edge by the player, regardless of anything surrounding it.
• Turning smart edit off and adding "Contents (skin)" key with value "`-16" to func_doors allows you to create a moving ladder. The ladder will behave strangely in it's open position, so it's best to keep its open position somewhere the player can't reach. Also, doors with custom skin value is silent.
• Deathmatch Classic handles door sounds slightly differently than other games/mods (likely to behave Quake's behavior).

Related pages

• Tutorial: Doors
• Tutorial: Adding Glass to Doors / VERC: Doors With Glass
• Tutorial: Perfect Timing with Doors
• Tutorial: Permanently locked doors
• Vlatitude: Basic Doors
• Vlatitude: Advanced Doors Tutorial