prop_under_button

From Valve Developer Community
Jump to navigation Jump to search
Class hierarchy
CPropUnderButton
CPropButton
CBaseAnimating
CBaseEntity
portal2/prop_button.cpp
The Old Aperture pillar button

prop_under_button is a point entity available in Portal 2 Portal 2. It is a button which is activated by player use or by game inputs, for use in underground test chambers. It has the exact same function as prop_button, but with a different model and sound.

Keyvalues

Note.pngNote:See Rendering and studio model related KIO for keyvalues and inputs that affect model rendering. Note that the following keyvalues are unavailable due to being overridden by game code:
model, sequence, solid, fademindist, fademaxdist, fadescale
It may still be possible to use their associated inputs or AddOutput them.
Name (targetname) <string>
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

Delay Before Reset (delay) <float>
Amount of time, in seconds, after the button has been pressed before it returns to the starting position. Once it has returned, it can be used again.
Play timer sound? (istimer) <boolean>
If set, this button will play timer sounds while button is depressed. This allows fast reset by default - use Prevent fast reset to stop this.
Prevent fast reset? (preventfastreset) <boolean>
Buttons that are timer's allow you to reset early - use this to make the button stick for the entire duration.
Skin (skin) <choices>
Affects the pillar skin. Same as a prop entity's Skin KV.
  • 0 : Clean
  • 1 : Rusted
Note.pngNote:This appears to be a holdover from prop_button and has no actual effect because the model used by prop_under_button only has one skin.
Solid ([todo internal name (i)]) <boolean> !FGD
Makes the button non-solid to objects and the player. It can still be pressed like normal.

Inputs

Press
Cause the button to be pressed.
Lock
Locks the button.
UnLock
UnLocks the button.
CancelPress
Causes the button to reset quietly and without firing OnButtonReset outputs.

Outputs

OnPressed
Called when the button has been pressed.
OnPressedBlue
Called in Coop when the button has been pressed by the Blue player.
OnPressedOrange
Called in Coop when the button has been pressed by the Orange player.
OnButtonReset
Called when the button has reset after being pressed.

See also