Prop under button: Difference between revisions
Jump to navigation
Jump to search
Note: See Model entity/Generic Keyvalues, Inputs and Outputs 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.
(→Keyvalues: description for skin keyvalue) |
m (→Keyvalues) |
||
| (13 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{CD|CPropUnderButton|base=CPropButton|file1=portal2/prop_button.cpp}} | |||
[[File:Prop under button.png|thumb|right|100px|The Old Aperture pillar button]] | [[File:Prop under button.png|thumb|right|100px|The Old Aperture pillar button]] | ||
{{this is a|model entity|game=Portal 2|name=prop_under_button}} | |||
{{ | 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== | ==Keyvalues== | ||
{{KV|Delay Before Reset|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.}} | {{studio rendering note|model, sequence, solid, fademindist, fademaxdist, fadescale}} | ||
{{KV|Play timer sound?|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.}} | {{KV Targetname}} | ||
{{KV|Prevent fast reset?|boolean|Buttons that are timer's allow you to reset early - use this to make the button stick for the entire duration.}} | {{KV|Delay Before Reset|intn=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.}} | ||
{{KV|Skin|choices|Affects the pillar skin. Same as a prop entity's Skin KV. }} | {{KV|Play timer sound?|intn=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.}} | ||
{{KV|Prevent fast reset?|intn=preventfastreset|boolean|Buttons that are timer's allow you to reset early - use this to make the button stick for the entire duration.}} | |||
{{KV|Skin|intn=skin|choices|Affects the pillar skin. Same as a prop entity's Skin KV. }} | |||
:* 0 : Clean | :* 0 : Clean | ||
:* 1 : Rusted | :* 1 : Rusted | ||
:{{note|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.}} | :{{note|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.}} | ||
==Inputs== | ==Inputs== | ||
{{ | {{I|Press|Cause the button to be pressed.}} | ||
{{ | {{I|Lock|Locks the button.}} | ||
{{ | {{I|UnLock|UnLocks the button.}} | ||
{{ | {{I|CancelPress|Causes the button to reset quietly and without firing OnButtonReset outputs.}} | ||
==Outputs== | ==Outputs== | ||
{{ | {{O|OnPressed|Called when the button has been pressed.}} | ||
{{ | {{O|OnPressedBlue|Called in Coop when the button has been pressed by the Blue player.}} | ||
{{ | {{O|OnPressedOrange|Called in Coop when the button has been pressed by the Orange player.}} | ||
{{ | {{O|OnButtonReset|Called when the button has reset after being pressed.}} | ||
== See also == | == See also == | ||
*[[Button (Portal 2)]] | *[[Button (Portal 2)]] | ||
[[Category:Prop entities|under button]] | |||
Latest revision as of 16:00, 1 September 2025
 Class hierarchy
|
|---|
| CPropUnderButton |
| portal2/prop_button.cpp
|
prop_under_button is a model entity available in 
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: See Model entity/Generic Keyvalues, Inputs and Outputs 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>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
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: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.
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.