func_button

Modified

12-Jul-2023

A brush entity, which can be triggered by the player by issuing his 'Use'-command on it while standing next to it and looking at it. The func_button then triggers its target. This is the most common entity for players interacting with other map entities or entity systems.

Keyvalues

Global Entity Name globalname : Global name of entity, allows to have one entity in the multiple maps (e.g. elevator in map1 and map2 have the same "Global Entity Name" which tells the engine to treat those entities as a one single entity, so all elevator settings, positions, actions e.t.c. are copied to another map in a moment of map transitions.

OnDestroy Function ondestroyfn : Name of the function to use from already parsed .as script files when entity is destroyed (killed) in any way. If the function belongs to namespace, you must use prefix with the namespace name (e.g. mynamespace::MyFunction) for the keyvalue.

Name targetname : Set name of func_button so other entities can trigger it to press/toggle it. Every trigger use-type works uniformly. Can be kill-targeted.

Target target : Entity to trigger when func_button gets pressed. Trigger use-type is defined in "Use Type" keyvalue.

Delay Before Trigger delay : Delay before trigger entity specified in "Target".

Kill Target killtarget : Entity to remove when func_button gets pressed.

Inventory: Need item(s) item_name_required : Item(s) (names separated by spaces) required to use this entity. Refers to "Item name" value of item_inventory.

Inventory: Need item(s) from group(s) item_group_required : Groups (separated by spaces), in which carried items belong to, required to use this entity. Refers to "Item group name" value of item_inventory.

Inventory: Item count in group need have (0 = all) item_group_required_num : Minimal number of items, that belong to specified group, required to use this entity. Use with "Inventory: Need item(s) from group(s)" keyvalue. Value of '0' means that all items from current group are required.

Inventory: CAN'T have item item_name_canthave : Items in player inventory that will fail the test, and disallow usage of this entity. Refers to "Item name" value of item_inventory.

Inventory: CAN'T have item from group item_group_canthave : Items in player inventory, which belong to specified group, that will fail the test, and disallow usage of this entity. Refers to "Item group name" value of item_inventory.

Inventory: Item count in group CAN'T have (0 = all) item_group_canthave_num : Minimal number of items in player inventory, which belong to specified group, that will fail the test, and disallow usage of this entity. Refers to "Item group name" value of item_inventory. Value of '0' means no single item from current group should be equipped to pass the test.

On pass: Ignore item's on use triggers? pass_ignore_use_triggers : If set to 'Yes' item's trigger targets from 'Target: On use (by trigger)' will not be triggered when item is used by this entity.

  • 0 : No
  • 1 : Yes

On pass: Drop item(s) pass_drop_item_name : Items to force-drop when the test result is positive, and entity is used successfully. Refers to "Item name" value of item_inventory. Multiple item names are separated by spaces.

On pass: Drop item(s) from group(s) pass_drop_item_group : Items to force-drop, that belong to specified group, when the test result is positive and entity is used successfully. All items from this group will be dropped. Refers to "Item group name" value of item_inventory. Multiple item names are separated by spaces.

On pass: Ignore item's on drop triggers? pass_ignore_drop_triggers : If set to 'Yes' item's trigger targets from "Target: On drop" will not be triggered when item is dropped by this entity with "Drop items(s)" events above.

  • 0 : No
  • 1 : Yes

On pass: Return item(s) pass_return_item_name : Items to return to their starting positions when test result is positive. Refers to "Item name" value of item_inventory. Multiple item names are separated by spaces.

On pass: Return item(s) from group(s) pass_return_item_group : Items, that belong to specified group, to return to their starting positions when test result is positive. All items from this group will be returned. Refers to "Item group name" value of item_inventory. Multiple group names are separated by spaces.

On pass: Ignore item's on return triggers? pass_ignore_return_triggers : If set to 'Yes' item's trigger targets from "Target: On return" will not be triggered when item is returned by this entity with "Return items(s)" events above.

  • 0 : No
  • 1 : Yes

On pass: Destroy item(s) pass_destroy_item_name : Items to remove when test result is positive. Refers to "Item name" value of item_inventory. Multiple item names are separated by spaces.

On pass: Destroy item(s) from group(s) pass_destroy_item_group : Items, that belong to specified group, to remove when test result is positive. All items from this group will be removed. Refers to "Item group name" value of item_inventory. Multiple group names are separated by spaces.

On pass: Ignore item's on destroy triggers? pass_ignore_destroy_triggers : If set to 'Yes' item's trigger targets from "Target: On Destroy" will not be triggered when item is destroyed by this entity with "Destroy items(s)" events above.

  • 0 : No
  • 1 : Yes

Target: Inventory rules failed target_on_fail : Entity to trigger whenever test result is negative.

Classification classify : Set the class of the spawned func_button. Think of how even though zombies and human grunts, by default, both are the players' enemies, yet have a dislike for and attack each other as well. This relation is created through the respective classes of the two entity types. For a complete table of how different classes react to each other, see monster class relation table.

  • -1 : None
  • 0 : Object Default : Keep default classification.
  • 1 : Machine
  • 2 : Player
  • 3 : Human Passive
  • 4 : Human Military
  • 5 : Alien Military
  • 6 : Alien Passive
  • 7 : Alien Monster
  • 8 : Alien Prey
  • 9 : Alien Predator
  • 10 : Insect
  • 11 : Player Ally
  • 12 : Player Hornet/Snark
  • 13 : Alien Hornet/Snark
  • 14 : X-Race
  • 15 : X-Race: Shocktrooper/Voltigore
  • 16 : Team 1 : Use it to classify to custom team.
  • 17 : Team 2 : Use it to classify to custom team.
  • 18 : Team 3 : Use it to classify to custom team.
  • 19 : Team 4 : Use it to classify to custom team.

Render FX renderfx : Set custom render FX effect. Only works when "Render Mode" is set to different than 'Normal'

  • 0 : Normal : Default rendering.
  • 1 : Slow Pulse : Transparency slow fading in and out in a loop.
  • 2 : Fast Pulse : Transparency fast fading in and out in a loop.
  • 3 : Slow Wide Pulse : Transparency slow fading in and out widely in a loop.
  • 4 : Fast Wide Pulse : Transparency fast fading in and out widely in a loop.
  • 9 : Slow Strobe : Regular slow appearing/dissapearing.
  • 10 : Fast Strobe : Regular fast appearing/dissapearing.
  • 11 : Faster Strobe : Regular very fast appearing/dissapearing.
  • 12 : Slow Flicker : Random slow appearing/dissapearing.
  • 13 : Fast Flicker : Random fast appearing/dissapearing.
  • 5 : Slow Fade Away : Not working. Fading out slowly until reaching invisibility. Works once when entity spawns or have changed it's "Render FX" at a runtime (e.g. through env_render). Requires high "FX Amount"
  • 6 : Fast Fade Away : Not working. Fading out quickly until reaching invisibility. Works once when entity spawns or have changed it's "Render FX" at a runtime (e.g. through env_render). Requires high "FX Amount"
  • 7 : Slow Become Solid : Not working. Fading in slowly from invisible to fully visible. Works once when entity spawns or have changed it's "Render FX" at a runtime (e.g. through env_render). Requires low or zero "FX Amount"
  • 8 : Fast Become Solid : Not working. Fading in quickly from invisible to fully visible. Works once when entity spawns or have changed it's "Render FX" at a runtime (e.g. through env_render). Requires low or zero "FX Amount"
  • 14 : Constant Glow : Sprites with 'Glow' render mode only. Disables sprite resizing.
  • 15 : Distort : Random distortion, looped.
  • 16 : Hologram (Distort + fade) : 'Random distortion' + 'Pulse' applied, looped.
  • 17 : Dead Player (DONT USE!)
  • 18 : Explode (Garg Like)
  • 19 : Glow Shell : Applies nice animated glowing shell on model. Color can be applied. "FX Amount" manipulates glow shell size.
  • 20 : ClampMinScale (Sprites)

Render Mode rendermode : Render mode determines how this entity is rendered.

  • 0 : Normal : Normal rendering. Entity will receive light, except if it is a sprite. "FX Amount" is obsolete when this is used.
  • 1 : Color : Brush entities only: Instead of rendering the texture, the whole entity will appear in one color, set by "FX Color". "FX Amount" sets the transparency. 0 means invisible. 255 means fully opaque.
  • 2 : Texture : Texture-only rendering. Entity will not receive light. Instead, only the texture will be rendered as is. "FX Amount" sets the transparency. 0 means invisible. 255 means fully opaque. This is used for transparent things such as windows. Tip: If you have a window separating a dark and a bright room using only one entity, you can apply a brighter glass texture to the side of the window seen from within the dark room than to the side seen from the bright room. That way, the window's brightness will look realistic from both sides, instead of from just one. Generally, darker rooms require the render amount to be lower, making the glass more transparent, or it would look illogically bright.
  • 3 : Glow : Sprites only. The sprite will appear in the same size regardless of your distance to it. In addition to that, the further away you are from it, the less visible it will be. (It's only barely visible at about 500 units far away) Good for light coronas. This renders the sprite in additive mode.
  • 4 : Solid : Brush entities only. All textures of the brush entity starting with '{' will have the last color of their palette (usually blue, black or purple) be rendered fully transparent. This is used for textures with see-through parts, such as grates and railings. Requires "FX Amount" to be set to a value greater than 0, commonly 255.
  • 5 : Additive : Works just as the "Render Mode" 'Texture', except that the entity's appearance will be added to the background instead of forming a mean. This means, black pixels of textures will be fully transparent, while full-bright pixels are added with a factor of "FX Amount" divided by 255. This is often used for sprites indicating a glowing light, as well as for overlay func_illusionaries to give a computer texture the appearance of having many small, glowing lights, screens and whatever other elements. Render-amount of 255 makes it bright. 0 makes it invisible.

FX Amount (1 - 255) renderamt : Render amount to use when other than "Render Mode" 'Normal' is used.

FX Color (R G B) rendercolor : Used with "Render Mode" 'Color' and 'Glow' to set color. Also sets color of 'Glow Shell' "Render Mode".

Pitch Yaw Roll (X Y Z) angles : Where Z means Y and Y means Z, that is, when you're thinking Hammer-grid. (Hammer uses Z for height and Y for depth, while every other sane 3D-application does this the other way round; nonetheless this keyvalue description has the letters in the conventional order) This, technically, is a 3D-vector containing Euler-angles to describe either the entity's rotation or direction of effect. E.g. a func_door_rotating will use this as its initial rotation, while a trigger_push will keep its original alignment and use this for the direction of its push-effect instead. Euler-angles are a hierarchical system to determine an object's orientation in 3D-space. A yaw-value of 0 would mean the entity would face east. (right in top-down view) 90 would mean it would face north. (up in top-down-view) After yaw, pitch is applied. Think aiming up/down with your character in first person. At last, the roll-value is applied. Think your character falling over sideways in first person. Some entities, mostly point entities, do not use the angles keyvalue for any purpose.

ZHLT Template Model Target zhlt_usemodel : For Brush entities: sets brush model template of this entity. Set it to the name of other brush entity (now called a template) and it's brush model will be used instead. Templates might save server resources by "copying" single brush entity (template identified by name) and using it in multiple places (can be used for entities like tables, columns, barrels, cars e.t.c.). Also one template occupies only one entity slot when compiling a map, no matter how many entities refers to it. For model-based point entities: copy display model of specified entity, to use it's model instead. Using "Custom model" is more appropriate in most cases, however, when it's not possible, use "ZHLT Copy Lighting From Target".

ZHLT Copy Lighting From Target zhlt_copylight : For Brush entities: copies light info from specified entity. This can be useful when we want this entity to be light up in a similar way the other entity of the map is, e.g. we have few func_pushables on map, and they are lit differently, tough they can be moved (and lightning is not updated on dynamic entities), it may looks shabby. With this keyvalue we can prevent this making all func_pushables received light in a same way. Another example: we have few windows in corridor (e.g. func_breakables), all of them receive a light in acceptable way, but the last window receive part of the light from another room and breaking whole atmosphere. We can set this window "Copy Lightning From Target" to any other window to fix this. Note that this can be also used for completely different entities, so we copy lightning from func_door to func_breakable as well. For model-based point entities: if model lightning does not satisfy you (e.g. it's too dark) you can specify a name of entity here to copy it's lightning values- it can be other model-based entity or simply info_target.

ZHLT Disable Clipping zhlt_noclip : Enable or disable collision of entity.

  • 0 : Default : Keep default collision.
  • 1 : Always non-solid : This makes entity non-solid- all collision info from this entity will be ignored. Use it in case when entity have no build-in collision disabling ability (e.g. by selecting "Passable" flag in func_door) and you much desire to disable collision for this entity.

ZHLT Invisible zhlt_invisible : Brush entities only. Determines if entity should be visible.

  • 0 : Visible (default)
  • 1 : Invisible

ZHLT Custom Shadow (when opaque) zhlt_customshadow : Opaque brush entities only. If "ZHLT Ligth Flags" of this entity uses any of the option with 'Opaque' word, this will allow to customize shadow dropped by this entity. Value format: [0 - 1.0] [0 - 1.0] [0 - 1.0], use three values for color or only one for transparency.

ZHLT Embed Light Map (when translucent) zhlt_embedlightmap : Transparent brush entities only. Set it to 'Yes' and this transparent entity will take a light from environment making it looks much more natural. Use it when entities (e.g. glass represented by func_wall) omits lightning from surrounding. Note that this is expensive so shouldn't be used too often, but resolution of those lightmaps can be controlled by keyvalue explained below.

  • 0 : No (default)
  • 1 : Yes

ZHLT Embed Light Map Resolution zhlt_embedlightmapresolution : Value of power of two that controls the resolution of embedded lightmaps of transparent textures (see keyvalue above). Higher value for better optimization. Default and recommended value is 4.

ZHLT Light Flags zhlt_lightflags : Brush entities only. Changes light casting or receiving setting.

  • 0 : Default : Let the entity decide about lightning setting.
  • 1 : Embedded Fix : Disables bleed fix on given entity. Sometimes when entity gets trough the wall, it may get wrong lighting in one of the site. Use this flag when this problem appear.
  • 2 : Opaque (blocks light) : May be useful for func_door or func_illusionary to generate shadows. Can also generate shadows on transparent '{' textures with 'Solid' Render Mode (amount: 255). Note that shadow sharpness depends on '-blur' compile value. The blur value of map above is 0.5 (it's 1.5 by default).
  • 3 : Opaque + Embedded fix : both 'Opaque' and 'Embedded Fix' settings.
  • 6 : Opaque + Concave Fix : Instead of using 'Embedded Fix' you can use 'Concave Fix'. It's generally used for curved entities, use it when you spot a black seems on curved (arched) entities.

ZHLT Light Origin Target light_origin : Set it to the name of info_target, this entity will receive lights from specified info_target position instead of it's own position. As a lot of entites can moves and lightning is not updated dynamically you can choose how your entity will be lit in game (e.g. elevators, pushables e.t.c.). Now you don't need to put the whole entity in the well-lit room at map start to make them look desirable.

Locked Sound locked_sound : Sound to play when a player tries to use the func_button but it's locked because it has a targetname or uses a multisource entity.

  • 0 : None
  • 2 : Access Denied

  • 8 : Small zap

  • 10 : Buzz

  • 11 : Buzz Off

  • 12 : Latch Locked

Unlocked Sound unlocked_sound : Sound to play if func_button is pressed/touched while not locked.

  • 0 : None
  • 1 : Big zap & Warmup

  • 3 : Access Granted

  • 4 : Quick Combolock

  • 5 : Power Deadbolt 1

  • 6 : Power Deadbolt 2

  • 7 : Plunger

  • 8 : Small zap

  • 9 : Keycard Sound

  • 10 : Buzz

  • 13 : Latch Unlocked

  • 14 : Lightswitch

Locked Sentence locked_sentence : Sentence to play when a player tries to use func_button but it's locked because it has a targetname or uses a multisource entity. Sentences are picked from sound/default_sentences.txt file.

  • 0 : None
  • 1 : Gen. Access Denied : Play one out of 18(!) announcements subsequently. Check NA0-NA18 sentences from "default_sentences.txt" for detailed list.
  • 2 : Security Lockout : Play one of the following announcements subsequently: "security lock is engaged", "secure area, no entry", "security lockout, no entry", "secure door, no entry", "security system in force", "security system armed, no entry", "door is secured" and "illegal access, move away".
  • 3 : Blast Door : Play one of the following announcements subsequently: "emergency blast door activated", "emergency blast shield activated" and "the blast containment shield is down".
  • 4 : Fire Door : Play "fire containment door is down" announcement.
  • 5 : Chemical Door : Play "chemical leak containment door activated" announcement.
  • 6 : Radiation Door : Play "radiation containment door activated" announcement.
  • 7 : Gen. Containment : Play "emergency containment door engaged" announcement.
  • 8 : Maintenance Door : Play one of the following announcements subsequently: "no access, maintenance area" and "no personnel permitted in maintenance area".
  • 9 : Broken Shut Door : Play one of the following announcements subsequently: "sorry, this door is inoperative", "sorry, door out of service" and "door damage detected, please call service personnel".

Unlocked Sentence unlocked_sentence : Sentence to play when the door is opened. Plays only few times.

  • 0 : None
  • 1 : Gen. Access Granted : Play one of the following announcements subsequently: "access granted", "access permitted", "entry granted", "entry permitted", "access authorized", "entry is permitted", "access authorized", "access to facility, granted" and "access granted".
  • 2 : Security Disengaged : Play one of the following announcements subsequently: "security lock disengaged", "security clear, proceed", "security lockout, released", "secure override accepted", "security access acknowledged", "security system disengaged" and "door security disengaged".
  • 3 : Blast Door : Play one of the following announcements subsequently: "emergency blast door, open", "emergency blast shield, deactivated" and "blast containment shield is, open".
  • 4 : Fire Door : Play "fire containment door, open" announcement.
  • 5 : Chemical Door : Play "chemical leak containment door, open" announcement.
  • 6 : Radiation Door : Play "radiation containment door, open" announcement.
  • 7 : Gen. Containment : Play "emergency containment door disengaged" announcement.
  • 8 : Maintenance area : Play one of the following announcements subsequently: "maintenance area access granted" and "maintenance area door open".

Locked Sound Override locked_sound_override : Sound file to use when attempting to open locked func_button. Useful when you don't want to use sound from default sound list. This overrides default "Locked Sound" sound. Note that other sounds format (AIFF, ASF, DLS, FLAC, IT, M3U, MID, MOD, MP2, MP3, OGG, S3M, VAG, WMA, XM) can be used, even if editor sound browser allows to pick only WAV files.

Unlocked Sound Override unlocked_sound_override : Sound file to use when func_button opens. Useful when you don't want to use sound from default sound list. This overrides default "Unlocked Sound" sound. Note that other sounds format (AIFF, ASF, DLS, FLAC, IT, M3U, MID, MOD, MP2, MP3, OGG, S3M, VAG, WMA, XM) can be used, even if editor sound browser allows to pick only WAV files.

Locked Sentence Override locked_sentence_override : Sentence from "default_sentences.txt" or custom sentences file (which can be added in map properties) to use when attempting to open locked func_button. Useful when you want to override locked sentence with your own sentence.

Unlocked Sentence Override unlocked_sentence_override : Sentence from "default_sentences.txt" or custom sentences file (which can be added in map properties) to use when func_button opens. Useful when you want to override locked sentence with your own sentence.

Speed speed : Speed at which the button moves when pressed, unless "Don't move" keyvalue is set. The button moves for its width in the move direction, specified by "Pitch Yaw Roll".

Health (shootable if > 0) health : If you enter here value higher than 0 the button becomes shootable only and can be activated when it's out of health.

Lip lip : This value will be deducted from the buttons move distance. Negative values are allowed.

Master master : Name of the multisource entity that (temporary) disables this func_button. If master is specified the func_button won't work. When multisource entity is triggered/being triggering by all possible inputs, the func_button will be enabled and ready to be pressed. When multisource lost at least one input signal, the entities becomes disabled again.

Sounds sounds : Set the sound to be played when the button is pressed. It will play when the button is locked, too.

  • 0 : None

  • 1 : Big zap & Warmup

  • 2 : Access Denied

  • 3 : Access Granted

  • 4 : Quick Combolock

  • 5 : Power Deadbolt 1

  • 6 : Power Deadbolt 2

  • 7 : Plunger

  • 8 : Small zap

  • 9 : Keycard Sound

  • 10 : Buzz

  • 11 : Buzz Off

  • 14 : Lightswitch

Sound Override noise : Custom sound, that overrides default sound from "Sounds" list to play when the button is pressed. It will play when the button is locked, too.

delay before reset (-1 stay) wait : When the button is pressed, it will remain in its pressed state for this amount of time. This also affects any toggleable textures on it. If set to '-1', the button can be pressed only once, and will then remain in its pressed state forever. If a multisource entity is among the func_button's targets, that multisource entity will recognize the button's input to be active only for this amount of time.

Minimum light level _minlight : Sets the minimum light level. Set this value if entity is too dark on compiled map. Also useful for things like computer screens or holograms. Default is 0, max 1.

Use Type use_type : Set the use-type with which the button will trigger its targets. Default is 'Toggle'.

  • 0 : Off
  • 1 : On
  • 2 : Set
  • 3 : Toggle

Flags

  • 1 : Don't move : If set, this func_button won't move when pressed and be activated instantly instead.

  • 32 : Toggle : If set, this func_button will ignore its delay before reset and be toggleable instead, switching between the texture states whenever pressed, if such a texture is assigned on one of its faces. The delay before reset still needs to be greater than zero in order for this to work, though.

  • 64 : Sparks : If set, the func_breakable occasionally emits sparks. You can use this for easily creating buttons which appear to be broken.

  • 256 : Touch Activates : If set, this func_button can be activated by touching it. This disables activating per use-key.

  • 2048 : Not in Deathmatch : Obsolete in Sven Co-op. Makes the entity don't appear in Multiplayer Games.