explain autobuilds
[xonotic/xonotic.wiki.git] / Mapping-entity-func_button.md
1 Mapping-entity-func button
2 ==========================
3
4 What Radiant Says
5 -----------------
6
7     When a button is touched by a player, it moves in the direction set by the "angle" key, triggers all its targets, stays pressed by an amount of time set by the "wait" key, then returns to it's original position where it can be operated again.
8     -------- KEYS --------
9     angle : determines the direction in which the button will move (up = -1, down = -2).
10     target : all entities with a matching targetname will be triggered.
11     target2 : all entities with a matching targetname will be triggered.
12     target3 : all entities with a matching targetname will be triggered.
13     target4 : all entities with a matching targetname will be triggered.
14     target_random : instead of triggering ALL matched entities, trigger ONE of them by random
15     speed : speed of button's displacement (default 40).
16     platmovetype : movement type (1 = linear, 2 = cosine [default])
17     wait : number of seconds button stays pressed (default 1, -1 = return immediately).
18     lip : lip remaining at end of move (default 4 units).
19     health : (default 0) if set to any non-zero value, the button must take damage (any amount) to activate.
20     -------- SPAWNFLAGS --------
21     NOSPLASH : if set, splash damage cannot activate the door, only direct damage can (requires health to be set)
22
23 What NetRadiant Means
24 ---------------------
25
26 A button entity is exactly as it sounds …  
27 A button …  
28 You push it …  
29 It does stuff …  
30
31 How to use it
32 -------------
33
34 -   Make a brush, with it selected, right click on the overview pane. Then go to func, and click on func\_button. Then hit [n] to bring up the entity editor, and pick a direction. Up is up and down is down. For z-axis, 0 degrees is east on the 2d view, so 90 is north, 180 is west, 270 is south. **NOTE :: it defaults to z-axiz when the radio button shows up. If you want up first select something else, then select up**
35
36 -   Then we need to link it so something. To do that select the button first, then select the tartget, and hit [ctrl]+[k]. You should see a line linking to the button and the object.
37
38 In the Wild
39 -----------
40
41 Currently none of the default xonotic maps have a button in them. However, warefare, a popular duel map uses a button to trigger the elevator.
42