Hosting and domain costs until October 2024 have been generously sponsored by dumptruck_ds. Thank you!

Editing func button

From Quake Wiki

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
 
{{DISPLAYTITLE:func_button}}
 
{{DISPLAYTITLE:func_button}}
 
{{Infobox_entity
 
| classname = func_button
 
| commonname = Button
 
| type = solid
 
| class = [[Func (entity class)|func]]
 
| dimensions = variable
 
| quakec = [[buttons.qc]]
 
| precaches =
 
* buttons/airbut1.wav
 
* buttons/switch21.wav
 
* buttons/switch02.wav
 
* buttons/switch04.wav
 
}}
 
  
 
The '''func_button''' is a solid entity that is used to create a physical button in the level that triggers events when the player touches it. Unlike the trigger_once and trigger_multiple entities, the func_button is visible and normally used in situations where the designer wants the player to see the button, such as for an elevator button. However, func_button is sometimes used in places that it's difficult for the player to see, such as on the floor to trigger [[traps]], or quite commonly as a means to open a [[secret area]] where it must be shot.
 
The '''func_button''' is a solid entity that is used to create a physical button in the level that triggers events when the player touches it. Unlike the trigger_once and trigger_multiple entities, the func_button is visible and normally used in situations where the designer wants the player to see the button, such as for an elevator button. However, func_button is sometimes used in places that it's difficult for the player to see, such as on the floor to trigger [[traps]], or quite commonly as a means to open a [[secret area]] where it must be shot.
Line 19: Line 5:
 
==Usage==
 
==Usage==
 
The [[Button tutorial]] has some examples of the creation and use of the func_button entity.
 
The [[Button tutorial]] has some examples of the creation and use of the func_button entity.
{{todo|user=Gorgsenegger|todo=Create a func_button tutorial!}}
+
{{todo}}
 
 
 
==Attributes==
 
==Attributes==
 
In addition to the settings listed below, the func_button can be made to move up or down by setting its angle to -1 (up) or -2 (down).
 
In addition to the settings listed below, the func_button can be made to move up or down by setting its angle to -1 (up) or -2 (down).
  
 
===Keys===
 
===Keys===
 +
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
| ! bgcolor="#eeeeee" width="100" | ''targetname''
+
| ! bgcolor="#eeeeee" width="80px" | ''targetname'' || The name of the button. Since the button is a trigger itself, this is generally used for killing the button from another trigger.
| The targetname of the button. Since the button is a trigger itself, this is generally used for killing the button from another trigger.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''target''  
+
| ! bgcolor="#eeeeee" | ''target'' || The targetname of the entity that will be triggered when the button is pressed.
| The targetname of the entity that will be triggered when the button is pressed.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''killtarget''
+
| ! bgcolor="#eeeeee" | ''killtarget'' || The targetname of the entity that will be killed when the button is pressed.
| The targetname of the entity that will be killed when the button is pressed.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''wait''  
+
| ! bgcolor="#eeeeee" | ''wait'' || Time after pressing the button for it to reset and be pushable again. Setting this to -1 will cause the button to stay pressed.
| Time after pressing the button for it to reset and be pushable again. Setting this to -1 will cause the button to stay pressed.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''delay''
+
| ! bgcolor="#eeeeee" | ''delay'' || Time after pressing the button before triggering its targets.
| Time after pressing the button before triggering its targets.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''speed''
+
| ! bgcolor="#eeeeee" | ''speed'' || The movement speed of the button.
| The movement speed of the button.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''lip''
+
| ! bgcolor="#eeeeee" | ''lip'' || An offset added to the default movement distance that allows the designer to adjust the amount the button sticks in or out after being pressed.
| An offset added to the default movement distance that allows the designer to adjust the amount the button sticks in or out after being pressed.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''health''
+
| ! bgcolor="#eeeeee" | ''health'' || If set to any value above 0, the button will only be activated by shooting it or hitting it with the axe. Often used for buttons that open secrets.
| If set to any value above 0, the button will only be activated by shooting it or hitting it with the axe. Often used for buttons that open secrets.
 
 
|-
 
|-
| ! bgcolor="#eeeeee" | ''message''
+
| ! bgcolor="#eeeeee" | ''message'' || A message to display when the button triggers.
| A message to display when the button triggers.
 
 
|}
 
|}
  
 
===Spawnflags===
 
===Spawnflags===
func_button supports standard [[Entity#Spawnflags|spawnflags]] for difficulty and deathmatch presence.
+
The button supports [[Entity#Spawnflags|standard spawnflags]] for difficulty and deathmatch presence.
{{Template:Mode_spawnflags
+
{| class="wikitable collapsible collapsed"
| entity = The button
+
|-
}}
+
! Flag !! Common Name
 
+
|-
==Definitions==
+
| 256 || Not on Easy
 
+
|-
===FGD Definition===
+
| 512 || Not on Normal
This is the format used by [[TrenchBroom]] and [[Worldcraft]]. Note that the model(...) parameter is not supported by Worldcraft. This does not include the base class definition, which may also be required.
+
|-
<pre>
+
| 1024 || Not on Hard
[ code from entity entry in an .fgd file goes in here ]
+
|-
</pre>
+
| 2048 || Not in Deathmatch
===DEF Definition===
+
|}
This is the definition format used for most old Quake editors, including the original [[QuakeEd]].
 
<pre>
 
[ code from entity entry in a .def file goes in here ]
 
</pre>
 
  
 
[[Category:Quake entities]]
 
[[Category:Quake entities]]

Please note that all contributions to Quake Wiki are considered to be released under the GNU Free Documentation License 1.3 or later (see Quake Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)