This article's documentation is for anything that uses the Source engine. Click here for more information.

Func weight button: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Added FGD Code)
 
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{portal series point|func_weight_button}}  
{{LanguageBar}}
 
{{Ent not in fgd|none|except={{portal}}{{portal2}}}}
==Entity description==
{{CD|CWeightButton|file1=weight_button.cpp}}
It is a 'Button' which activates after a specified amount of weight is touching it.
{{this is a|brush entity|name=func_weight_button|except=Source SDK Base 2006}} It is a 'Button' which activates after a specified amount of weight is touching it.


== Keyvalues ==
== Keyvalues ==
{{KV|Amount of weight required before this button activates.|float|Amount of weight required before this button activates.}}
{{KV Targetname}}
{{KV Targetname}}
{{KV|Amount of weight required before this button activates.|intn=WeightToActivate|float|Amount of weight required before this button activates.}}
== Outputs ==
{{O|OnPressed|ac-is-this=1|Fired when the button is touching enough weight.}}
{{O|OnReleased|ac-is-this=1|Fired when the button was pressed, but weight was removed.}}


== Inputs ==
== FGD Code ==
{{I Targetname}}
<pre>@SolidClass base(Targetname) = func_weight_button : "A button which activates after a specified amount of weight is applied"
[
WeightToActivate(float) : "Amount of weight required before this button activates."


== Outputs ==
//Outputs
{{IO|OnPressed|Fired when the button is touching enough weight.}}
output OnPressed(void) : "Fired when the button is touching enough weight."
{{IO|OnReleased|Fired when the button was pressed, but weight was removed.}}
output OnReleased(void) : "Fired when the button was pressed, but weight was removed."
{{O Targetname}}
]</pre>

Latest revision as of 10:18, 13 June 2025

English (en)Translate (Translate)
Icon-NotInFGD.png
This entity is not in the FGD by default, except in PortalPortal 2.
See below for instructions on making it available.
C++ Class hierarchy
CWeightButton
CBaseEntity
C++ weight_button.cpp

func_weight_button is a brush entity available in all Source Source games except Source SDK Base 2006 Source SDK Base 2006. It is a 'Button' which activates after a specified amount of weight is touching it.

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

Amount of weight required before this button activates. (WeightToActivate) <float>
Amount of weight required before this button activates.

Outputs

OnPressed
!activator = !caller = this entity
Fired when the button is touching enough weight.
OnReleased
!activator = !caller = this entity
Fired when the button was pressed, but weight was removed.

FGD Code

@SolidClass base(Targetname) = func_weight_button : "A button which activates after a specified amount of weight is applied"
[
	WeightToActivate(float) 	: "Amount of weight required before this button activates."

	//Outputs
	output OnPressed(void)		: "Fired when the button is touching enough weight."
	output OnReleased(void)		: "Fired when the button was pressed, but weight was removed."
]