Latest revision |
Your text |
Line 1: |
Line 1: |
| {{DISPLAYTITLE:func_button}} | | {{DISPLAYTITLE:func_button}} |
| | | |
− | {{Infobox_entity
| + | The '''func_button''' is a button that can be used to trigger events in a level and is operated by the player on touch. |
− | | 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.
| + | ==Settings== |
− | | + | In addition to the settings listed below, the func_button can be made to move up or down by setting angle to -1 (up) or -2 (down). |
− | ==Usage==
| |
− | 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!}}
| |
− | | |
− | ==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). | |
| | | |
| ===Keys=== | | ===Keys=== |
− | {| class="wikitable"
| + | targetname : The name of the button. Since the button is a trigger itself, this is generally used for killing the button from another trigger. |
− | |-
| + | target : The targetname of the entity that will be triggered when the button is pressed. |
− | | ! bgcolor="#eeeeee" width="100" | ''targetname''
| + | killtarget : The targetname of the entity that will be killed when the button is pressed. |
− | | The targetname of the button. Since the button is a trigger itself, this is generally used for killing the button from another trigger.
| + | 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. |
− | |-
| + | delay : Time after pressing the button before triggering its targets. |
− | | ! bgcolor="#eeeeee" | ''target''
| + | speed : The movement speed of the button. |
− | | The targetname of the entity that will be triggered when the button is pressed.
| + | 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. |
− | |-
| + | 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. |
− | | ! bgcolor="#eeeeee" | ''killtarget''
| + | message : A message to display when the button triggers. |
− | | The targetname of the entity that will be killed when the button is pressed.
| |
− | |-
| |
− | | ! 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.
| |
− | |-
| |
− | | ! bgcolor="#eeeeee" | ''delay''
| |
− | | Time after pressing the button before triggering its targets.
| |
− | |-
| |
− | | ! bgcolor="#eeeeee" | ''speed''
| |
− | | The movement speed of the button.
| |
− | |-
| |
− | | ! 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.
| |
− | |-
| |
− | | ! 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.
| |
− | |-
| |
− | | ! bgcolor="#eeeeee" | ''message''
| |
− | | 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
| |
− | | entity = The button
| |
− | }}
| |
− | | |
− | ==Definitions==
| |
− | | |
− | ===FGD Definition===
| |
− | 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>
| |
− | [ code from entity entry in an .fgd file goes in here ]
| |
− | </pre>
| |
− | ===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]]
| |