Func lookdoor: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (removed {{DISPLAYTITLE}}, covered by the hl2 brush template)
(updates)
Line 1: Line 1:
{{hl2 brush|func_lookdoor}}
{{lang|Func lookdoor}}
{{hl2 brush|func_lookdoor}} It's a door that moves, either when looked by a targeted object or when a target object comes near the door.  Behavior can be either based on viewing direction or proximity alone, or on a combination of both.


==Entity description==
{{FuncMoveLinear notes}}
A door that moves either when looked by a targeted object or when a target object comes near the door.  Behavior can be either based on viewing direction or proximity alone, or on a combination of both.  If inverted the doors behavior will be the opposite.
{{brushmodel}}
In code it is represented by class CLookDoor, defined in hl2_dll\look_door.cpp.


==Keyvalues==
{{code class|CLookDoor|look_door.cpp}}
{{KV Targetname}}
{{KV Parentname}}
{{KV Origin}}


{{KV|Target {{Not in FGD}}|target_destination|View cone switch for this door (Necessary to trigger it).}}  
==Flags==
{{Fl FuncMoveLinear}}
{{minititle|LookDoor}}
*8192: LookDoor Threshold
*16384: LookDoor Invert
*32768: LookDoor From Open


{{KV|Move Direction (Pitch Yaw Roll)|angle|The direction the brushes will move, when told to.}}
==Keyvalues==
 
{{KV|Target (target)|target_destination|nofgd=1|View cone switch for this door (Necessary to trigger it).{{clarify}}}}  
{{KV|Start Position|float|Position of brush when spawned. The range is a value between 0.0 and 1.0, where 0 is the starting position and 1 is the starting position + (move direction * move distance).}}
{{KV|Proximity Distance (ProximityDistance)|float|If non-zero, how close player must be for door to move.}}
 
{{KV|Proximity Offset (ProximityOffset)|float|Offset from the target object.}}
{{KV|Speed|int| The speed that the brush moves, in inches per second.}}
{{KV|Field of View (FieldOfView)|float|If non-zero, how far away from the door the player can look while still triggering it.}}
 
{{KV FuncMoveLinear}}
{{KV|Move Distance|float| The distance from the starting point that the brush should move, in inches.}}
{{KV BaseEntity|base=1}}
 
{{KV|Block Damage|float|The amount of damage to do to any entity that blocks the brushes, per frame.}}
 
{{KV|Sound played when the brush starts moving|sound|Sound played when the brush starts moving}}
 
{{KV|Sound played when the brush stops moving|sound|Sound played when the brush stops moving.}}
 
{{KV|Proximity Distance|float|If non-zero, proximity range over which door will move.}}
 
{{KV|Proximity Offset|float|Offset from the target object.}}
 
{{KV|FieldOfView|float|If non-zero, field of view over which door will move.}}
 
==Flags==
*8 : Not Solid
*8192 : LookDoor Threshold
*16384 : LookDoor Invert
*32768 : LookDoor From Open


==Inputs==
==Inputs==
{{I Targetname}}
{{IO|InvertOn|Make the door behave oppositely. Player has to be ''outside'' '''Proximity Distance''', and not looking at the door within '''Field of View'''.}}
{{I Parentname}}
{{IO|InvertOff|Turn door behavior back to the normal method.}}
 
{{I FuncMoveLinear}}
{{IO|Open|Move the brush to the end position (starting position + (move direction * move distance)).}}
{{I BaseEntity|base=1|prel4d=1}}
 
{{IO|Close|Move the brush to the starting position.}}
 
{{IO|SetPosition|Move the brush to a specific position defined by a value. This value modifies the movedistance like this (starting position + (move distance * set position)). Meaning a movedistance of 128 set positioned for 2 will move 256 units.|param=float}}
 
{{IO|InvertOn|InvertOn - when set behavior of door is inverted.}}
 
{{IO|InvertOff|InvertOff - when set behavior of door is normal.}}


==Outputs==
==Outputs==
{{O Targetname}}
{{O FuncMoveLinear}}
 
{{O BaseEntity}}
{{IO|OnFullyOpen|Fired when the brush reaches the end position (starting position + (move direction * move distance)).}}
 
{{IO|OnFullyClosed|Fired when the brush reaches the starting position.}}
 
==See also==
* [[func_door]]
 
[[Category:Entities]]
[[Category:Brush Entities]]

Revision as of 02:48, 9 September 2018

English (en)Translate (Translate)

Template:Hl2 brush It's a door that moves, either when looked by a targeted object or when a target object comes near the door. Behavior can be either based on viewing direction or proximity alone, or on a combination of both.

Note.pngNote:The SetPosition input and Start Position keyvalue do not perform any bounds checking, so values less than 0 and greater than 1 can be used. Negative values will move in the opposite direction to the movement direction, and values greater than 1 will move it in multiples of the set Move Distance. Moving past the opened/closed position does not trigger the OnFullyOpen and OnFullyClosed outputs.
Icon-Bug.pngBug:There are bugs that may arise when parenting this entity to any of these: func_movelinear, func_lookdoor, func_water_analog. A func_door (or for func_water_analog, func_water) can be used as a workaround. (see here for a code fix)[ Code Fix]
Confirm:Might be fixed in Portal 2? Parented movelinears are used extensively for this game's piston platforms.
C++ In code, it is represented by theCLookDoorclass, defined in thelook_door.cppfile.

Flags

FuncMoveLinear:

Not Solid : [8]
Icon-Bug.pngBug:Physics objects cannot be constrained to this entity when this flag is enabled.  [todo tested in ?]

LookDoor:

  • 8192: LookDoor Threshold
  • 16384: LookDoor Invert
  • 32768: LookDoor From Open

Keyvalues

Target (target) ([todo internal name (i)]) <targetname> !FGD
View cone switch for this door (Necessary to trigger it).[Clarify]
Proximity Distance (ProximityDistance) ([todo internal name (i)]) <float>
If non-zero, how close player must be for door to move.
Proximity Offset (ProximityOffset) ([todo internal name (i)]) <float>
Offset from the target object.
Field of View (FieldOfView) ([todo internal name (i)]) <float>
If non-zero, how far away from the door the player can look while still triggering it.

FuncMoveLinear:

Move Direction (Pitch Yaw Roll) (movedir) <angle>
The direction the entity will move in.
Start Position (startposition) <float>
Position of brush when spawned, where 0 is the starting position and 1 is starting position + (move direction * move distance).
Speed (speed) <integer>
The speed that the brush moves, in inches per second.
Move Distance (movedistance) <float>
The distance from the starting point that the brush should move, in inches.
Block Damage (blockdamage) <float>
The amount of damage to do to any entity that blocks the brushes, per frame.
Icon-Bug.pngBug:Block damage doesn't function on players who passed through a trigger_teleport using noclip, though it will have effect again if the the player goes through a trigger_teleport without noclip.  [todo tested in ?]
Sound played when the brush starts moving. (startsound) <sound>
The sound to play when the brush starts moving.
Sound played when the brush stops moving. (stopsound) <sound>
The sound to play when the brush stops moving.


Inputs

InvertOn
Make the door behave oppositely. Player has to be outside Proximity Distance, and not looking at the door within Field of View.
InvertOff
Turn door behavior back to the normal method.

FuncMoveLinear:

Open
Move the brush to the end position (starting position + (move direction * move distance)).
Close
Move the brush to the starting position.
SetPosition <floatRedirectInput/float>
Move the brush to a specific position, where 0 is the starting position and 1 is the starting position + (move direction * move distance).
SetSpeed <floatRedirectInput/float>
Set the speed and update immediately.
TeleportToTarget <targetnameRedirectInput/string> (only in Left 4 Dead 2)
Teleport to the origin of a given entity.
ResetPosition <floatRedirectInput/float> (only in Left 4 Dead 2)
Set a new start position, parameter relative to wherever the current one is.
Todo: Parameter might actually be optional?


Outputs

FuncMoveLinear:

OnFullyOpen
!activator = !caller = this entity
Fired when the brush reaches the end position (starting position + (move direction * move distance)).
OnFullyClosed
!activator = !caller = this entity
Fired when the brush reaches the starting position.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Func_lookdoor&oldid=218961"