func_button_timed
func_button_timed
is a brush entity available in the Left 4 Dead series.
It is a button that takes time to use.
Contents
Keyvalues
- Use String
(use_string)
<string> - The text/string that appears on the progress bar while the player is holding down use.
- Use Sub-String
(use_sub_string)
<string> - A sub-string that appears below the Use String.
- Glow Entity
(glow)
<targetname> - The name of an entity that will get the +use glow for this button.
- Auto-Disable On Time Up
(auto_disable)
<boolean> - When the use timer is up, disable the button. (Can be enabled with an input)
- Locked Sound
(locked_sound)
<choices> - Sound played when the player tries to use the button, and fails because it's locked.
- 0: None
- 2: Access Denied
- 8: Small zap
- 10: Buzz
- 11: Buzz Off
- 12: Latch Locked
Targetname:
- Name
(targetname)
<string> - The targetname that other entities refer to this entity by.
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.
Origin:
- Origin (X Y Z)
(origin)
<origin> - The position of this entity's center in the world. Rotating entities typically rotate around their origin.
RenderFields:
- Render Mode
(rendermode)
<choices> - Set a non-standard rendering mode on this entity.
- Render FX
(renderfx)
<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render FX / Transparency (0 - 255)
(renderamt)
<integer> - 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.
- Disable Receiving Shadows
(disablereceiveshadows)
<boolean> - Prevent the entity from receiving shadows on itself.
DamageFilter:
- Damage Filter
(damagefilter)
<targetname> - Name of the
filter_damage_type
entity that controls which entities can damage us.
Flags
- 2048 : Starts locked
Inputs
Lock
- Lock the button, preventing it from functioning and playing a locked sound.
Unlock
- Unlock the button, allowing it to function.
Enable
- Enable the button, so it glows and can be used.
Disable
- Disable the button, so it can't be used and doesn't glow.
Base:
AddContext
<string>- Adds to the entity's list of response contexts. See Context.
AddOutput
<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext
- Removes all contexts from this entity's list.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1
toFireUser4
- Fires the respective
OnUser
outputs; see User Inputs and Outputs.
Kill
- Removes this entity and any entities parented to it from the world.
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
input.
RemoveContext
<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent
<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<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
<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
DispatchResponse
<string> !FGD- Dispatches a response to the entity. See Response and Concept.
DispatchEffect
<string> (removed since ) !FGD- Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .
RunScriptFile
<script> (in all games since ) (also in )- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode
<string> (in all games since ) (also in )- Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console. Bug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.Fix:Remove the string argument manually with a text editor.
CallScriptFunction
<string> (in all games since ) (also in ) !FGD- Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope
(only in ) !FGD- Destroys the script scope of the receving entity.
SetLocalOrigin
<coordinates> (in all games since ) !FGD- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
Parentname:
SetParent
<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<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
<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.
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 than0
.
Color
<color255>- Sets an RGB color for the entity.
DamageFilter:
SetDamageFilter
<string>- Sets the entity to use as damage filter. Pass in an empty string (no parameter) to clear the damage filter.
Outputs
OnPressed
- Fired when the button is pressed.
OnUnPressed
- Fired when the button is unpressed.
OnTimeUp
- Fired when the button has been held more than the required amount of time.
OnUseLocked
- Fired when the button is used while locked.
Targetname:
OnUser1
toOnUser4
- These outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
Input; see User Inputs and Outputs.