Func elevator: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(major update)
(Made the page actually describe the entity)
Line 1: Line 1:
{{wrongtitle|title=func_elevator}}
{{brushmodel}}
{{brushmodel}}
''This [[brush entity]] is only available in [[Left4Dead]].''[[Category:Entities]][[Category:Left 4 Dead Entities]]''


== Entity description==
==Entity description==
A brush entity that moves vertically.
A brush entity that moves vertically.
For an example of a <code>func_elevator</code>, refer to <code>"sdk_content\mapsrc\No Mercy\l4d_hospital04_interior.vmf"</code>.


For an example of a <code>func_elevator</code>, refer to a decompiled copy of Valve's 4th level of the No Mercy campaign.
==Keyvalues==
*{{KV Targetname}}
*{{KV Origin}}
*{{KV Parentname}}
*{{KV RenderFields}}
*{{ScrollBox|title=Postions|
*'''Top''' <code><[[vector]]></code>
:The position of this brush while at the top floor.
*'''Bottom''' <code><[[vector]]></code>
:The position of this brush while at the bottom floor.}}


== Keyvalues ==
==Inputs==
* {{KV Targetname}}
* '''MoveToFloor'''<code><[[targetname]]></code>
* {{KV Origin}}
:Moves to the specified [[info_elevator_floor]]
* '''top'''
* '''Disable'''
* '''bottom'''
:Disables the entity
* {{I Targetname}}
* {{I RenderFields}}
* {{I Parentname}}


== Inputs ==
==Outputs==
* '''MoveToFloor''' Moves to the specified [[info_elevator_floor]]
* {{O Targetname}}
* '''input Disable'''
*<code>OnReachedTop</code>
 
:Fired when the brush reaches the top.
== Outputs ==
*<code>OnReachedBottom</code>
* '''OnReachedTop''' Fired when the brush reaches the top.
:Fired when the brush reaches the bottom.
* '''OnReachedBottom''' Fired when the brush reaches the bottom.

Revision as of 14:34, 19 July 2009

Template:Wrongtitle Template:Brushmodel This brush entity is only available in Left4Dead.''

Entity description

A brush entity that moves vertically. For an example of a func_elevator, refer to "sdk_content\mapsrc\No Mercy\l4d_hospital04_interior.vmf".

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

  • Origin:
Origin (X Y Z) (origin) <origin>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
  • RenderFields:


Render Mode (rendermode) <byte choices>
Set a non-standard rendering mode on this entity.
Render Modes
  • 0: Normal
  • 1: Color
  • 2: Texture
  • 3: Glow
  • 4: Solid/Alphatest Obsolete
  • 5: Additive
  • 6: Removed, does nothing Obsolete
  • 7: Additive Fractional Frame
  • 8: Alpha Add
  • 9: World Space Glow
  • 10: Don't Render
Render FX (renderfx) <byte choices>
Various somewhat legacy alpha effects. See render effects.
Render Amount / Transparency (renderamt) <byte>
Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
Render Color (R G B) (rendercolor) <color255>
Color tint.
The position of this brush while at the top floor.
The position of this brush while at the bottom floor.

Inputs

Moves to the specified info_elevator_floor
  • Disable
Disables the entity
  • RenderFields:
Alpha <integer 0–255>
Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its rendermode set to a number other than 0.
Color <color255RedirectInput/color32>
Sets an RGB color for the entity.
Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <stringRedirectInput/string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

  • OnReachedTop
Fired when the brush reaches the top.
  • OnReachedBottom
Fired when the brush reaches the bottom.