View source for Func door

{{Entity_Infobox
| title=
| type=b
}}

Simple entity for objects moving in a straight line. Mostly used for plain sliding doors. Func_doors are triggered on touch, unless they have a name, in which's case they require to be triggered manually. The movement-direction is set by the angles keyvalue. The distance traveled is computed by the extents of the door's hull into the set direction. If your door is 64 units in width (X-axis) and set to move east, it will move 64 units east when triggered. If your door is 96 units in length (Y-axis) and set to move north, it will move 96 units north. If your angle is not a multiple of 90, it gets weird and complicated; couldn't figure out what's the maths behind that. When the door is blocked while moving, it will apply its damage and, by default, move back into the position it came from and idle without further action. An exception is when the door has already been opened and its movement is a result of automatic delayed closing; it will then attempt to close every time the delay runs out, till it closes without getting blocked. The door can be blocked multiple times as it moves forth/back, changing its direction and goal-position every time - also applying damage every time - till it reaches the goal-position.

== Keyvalues ==

{{Entity_keyvalue|Speed|speed|Movement-speed in units per second.}}
{{Entity_keyvalue|Master|master|Put the name of a multisource entity to lock this door.}}
{{Entity_keyvalue|Move Sound|movesnd|Sound that is played while the door is moving.}}
{{Entity_keyvalue|Move Sound Loops?|movesnd_loop|Sets if Move Sound should be looped during brush movement until it stops.}}
{{Entity_keyvalue|Stop Sound|stopsnd|Sound which is played once as the door stops moving.}}
{{Entity_keyvalue|Delay before close; -1 stay open|wait|Delay till the door will automatically close after having opened. Setting this to -1 makes the door never close again. When the door is toggleable, this is obsolete.}}
{{Entity_keyvalue|Lip|lip|Length in units to subtract from the precomputed movement-distance of the door. Negative values increase the movement-distance.}}
{{Entity_keyvalue|Damage inflicted when blocked|dmg|Damage to apply to whatever blocks the door.}}
{{Entity_keyvalue|Fire on open (obsolete)|fireonopen|Target to trigger when the door finishes opening.}}
{{Entity_keyvalue|Fire on close (obsolete)|netname|Target to trigger when the door finishes closing.}}
{{Entity_keyvalue|Fire On Open Start|fireonopening|Entity to trigger when door starts opening.}}
{{Entity_keyvalue|Fire On Open Start Trigger State|fireonopening_triggerstate|Set the use-type with which the entity specified above will be fired.}}
{{Entity_keyvalue|Fire On Close Start|fireonclosing|Entity to trigger when door starts closing.}}
{{Entity_keyvalue|Fire On Close Start Trigger State|fireonclosing_triggerstate|Set the use-type with which the entity specified above will be fired.}}
{{Entity_keyvalue|Fire On Open End|fireonopened|Entity to trigger when door ends opening.}}
{{Entity_keyvalue|Fire On Open End Trigger State|fireonopened_triggerstate|Set the use-type with which the entity specified above will be fired.}}
{{Entity_keyvalue|Fire On Close End|fireonclosed|Entity to trigger when door end closing.}}
{{Entity_keyvalue|Fire On Close End Trigger State|fireoncloed_triggerstate|Set the use-type with which the entity specified above will be fired.}}
{{Entity_keyvalue|Strength|health|It used to be damage amount for door to be opened, it is not supported anymore. Now it's amount of damage to take before they gets destroyed (when "Breakable" is set to 'Yes').}}
{{Entity_keyvalue|Locked Sound|locked_sound|Sound to play when a player tries to open the door but it's locked because it has a targetname or uses a multisource entity.}}
{{Entity_keyvalue|Unlocked Sound|unlocked_sound|Another sound to play when the door is opened.}}
{{Entity_keyvalue|Locked Sentence|locked_sentence|Sentence to play when a player tries to open the door but it's locked because it has a targetname or uses a multisource entity. (Only works a few times, probably because it'd be weird if the announcer was spamming all the time)}}
{{Entity_keyvalue|Unlocked Sentence|unlocked_sentence|Sentence to play when the door is opened. (Only works a few times, probably because it'd be weird if the announcer was spamming all the time)}}
{{Entity_keyvalue|Sound Replacement File|soundlist|Allows you to setup a sound replacement file for the func_door sounds. The path begins in 'svencoop/sound/mapname', whereas 'mapname' would be your map's name. You can go to the parent directory using '../'. A valid sound replacement file contains one or more lines with two sound-paths, which are separated by a space and wrapped into quotes. The first sound is the sound to be replaced. The second sound is the new sound. Sound-paths start in the sound directory. You cannot go to the parent directory using '../' in that case. These sounds do not need to be precached using a custom_precache point entity.}}
{{Entity_keyvalue|Who can open this|m_iOpenFlags|Specify who can open this door by touching/using it (if it has no targetname, or targetname is set to be ignored (see below)). If set to something other than default, this will cause the old spawnflags which are usually used to keep track of this to be ignored and causes the door to only orient using this setting instead.}}
{{Entity_keyvalue|Ignore Targetname|m_fIgnoreTargetname|Set whether the door should ignore its targetname or not. This is useful when you need to reference the func_door in another entity but still want the door to open on touch.}}
{{Entity_keyvalue|Obey Trigger Mode|m_iObeyTriggerMode|Originally, func_door would not interpret use-types "Off" and "On" as "Toggle". This keyvalue allows you to use "On" to open the door and "Off" to close the door. You can also set this to have the door react to "On"- and "Off"-triggering while it is moving, and go closing when it is currently opening and vice versa.}}
{{Entity_keyvalue|Move Sound Override|noise1|Custom sound file that is playing when entity is moving. Overrides default "Move Sound" sound.}}
{{Entity_keyvalue|Stop Sound Override|noise2|Custom sound file to play when the entity ends movement. Overrides default "Stop Sound" sound.}}
{{Entity_keyvalue|Locked Sound Override|locked_sound_override|Sound file to use when attempting to open locked entity. Useful when you don't want to use sound from default sound list.
This overrides default "Locked Sound" sound.}}
{{Entity_keyvalue|Unlocked Sound Override|unlocked_sound_override|Sound file to use when entity is unlocked. Useful when you don't want to use sound from default sound list.
This overrides default "Locked Sound" sound.}}
{{Entity_keyvalue|Locked Sentence Override|locked_sentence_override|Sentence from sentences.txt to use when attempting to open locked entity. Useful when you want to override locked sentence with your own sentence.}}
{{Entity_keyvalue|Unlocked Sentence Override|unlocked_sentence_override|Sentence from sentences.txt to use when entity is unlocked. Useful when you want to override unlocked sentence with your own sentence.}}

{{Entity_breakable_keyvalues}}

{{Entity_item_inventory_keyvalues}}

== Flags ==

{{Entity_flag|1|Starts Open|If set, the door will treat its predetermined open- and close-position as swapped, meaning it will start in its open position, but treat it as its closed position. This is useful when you want your door to start open and still receive proper lighting, or the node-graph to generate properly before closing the door manually (if it is a toggleable door).}}
{{Entity_flag|4|Don't link|If set, this door won't synchronize its movement with identically named doors. This is useful when triggering many doors with different speeds or different movement-lengths by the same name. If not set, doors with the same name will adjust their individual speeds to open/close simultaneously, orienting at how the first related door the game engine finds would behave timing-wise.}}
{{Entity_flag|8|Passable|If set, the door is entirely non-solid. It also cannot be triggered on-touch anymore then.}}
{{Entity_flag|32|Toggle|If set, this door ignores its delay before closing; nonetheless, it must not be 0 then for some reason.}}
{{Entity_flag|256|Use Only|If set, this door can be triggered by using it but not by touching it anymore. This does not outrule activation by triggering, though.}}
{{Entity_flag|512|Monsters Can't|If set, monsters cannot cause this door to move. They can, otherwise, even if it is a use-only- or trigger-only-door, so don't forget to set this when you need it!}}
{{Entity_flag|1024|No Link-Checking|If set, the door won't check for doors to link with, causing this door to not be considered for link-orientation by the game engine; it can still be caused to be linked by other func_doors.}}

== Notes ==

* If the func_door kills something which blocked it, it will proceed instead of returning (behavior was changed to this in SC 4.5).

== Issues ==

* The "Message if triggered"-keyvalue does nothing.

== Changes ==

* 5.0 Steam Release: Added 'Inventory Rules', 'Sound Override', 'Locked Sound Override', 'Unlocked Sound Override', 'Locked Sentence Override', 'Unlocked Sentence Override', 'Move Sound Override' and 'Stop Sound Override' keyvalues.

{{entity_title}}

[[Category:Entities]]
[[Category:Brush entities]]