RNA: review of commits in the past days, check the diffs for the
[blender.git] / source / blender / makesrna / intern / rna_sensor.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_access.h"
28 #include "RNA_define.h"
29 #include "RNA_types.h"
30
31 #include "rna_internal.h"
32
33 #include "DNA_sensor_types.h"
34
35 #ifdef RNA_RUNTIME
36
37 static StructRNA* rna_Sensor_refine(struct PointerRNA *ptr)
38 {
39         bSensor *sensor= (bSensor*)ptr->data;
40
41         switch(sensor->type) {
42                 case SENS_ALWAYS:
43                         return &RNA_AlwaysSensor;
44                 case SENS_TOUCH:
45                         return &RNA_TouchSensor;
46                 case SENS_NEAR:
47                         return &RNA_NearSensor;
48                 case SENS_KEYBOARD:
49                         return &RNA_KeyboardSensor;
50                 case SENS_PROPERTY:
51                         return &RNA_PropertySensor;
52                 case SENS_MOUSE:
53                         return &RNA_MouseSensor;
54                 case SENS_COLLISION:
55                         return &RNA_CollisionSensor;
56                 case SENS_RADAR:
57                         return &RNA_RadarSensor;
58                 case SENS_RANDOM:
59                         return &RNA_RandomSensor;
60                 case SENS_RAY:
61                         return &RNA_RaySensor;
62                 case SENS_MESSAGE:
63                         return &RNA_MessageSensor;
64                 case SENS_JOYSTICK:
65                         return &RNA_JoystickSensor;
66                 case SENS_ACTUATOR:
67                         return &RNA_ActuatorSensor;
68                 case SENS_DELAY:
69                         return &RNA_DelaySensor;
70                 default:
71                         return &RNA_Sensor;
72         }
73 }
74
75 #else
76
77 void rna_def_sensor(BlenderRNA *brna)
78 {
79         StructRNA *srna;
80         PropertyRNA *prop;
81         static EnumPropertyItem sensor_type_items[] ={
82                 {SENS_ALWAYS, "ALWAYS", "Always", ""},
83                 {SENS_TOUCH, "TOUCH", "Touch", ""},
84                 {SENS_NEAR, "NEAR", "Near", ""},
85                 {SENS_KEYBOARD, "KEYBOARD", "Keyboard", ""},
86                 {SENS_PROPERTY, "PROPERTY", "Property", ""},
87                 {SENS_MOUSE, "MOUSE", "Mouse", ""},
88                 {SENS_COLLISION, "COLLISION", "Collision", ""},
89                 {SENS_RADAR, "RADAR", "Radar", ""},
90                 {SENS_RANDOM, "RANDOM", "Random", ""},
91                 {SENS_RAY, "RAY", "Ray", ""},
92                 {SENS_MESSAGE, "MESSAGE", "Message", ""},
93                 {SENS_JOYSTICK, "JOYSTICK", "joystick", ""},
94                 {SENS_ACTUATOR, "ACTUATOR", "Actuator", ""},
95                 {SENS_DELAY, "DELAY", "Delay", ""},
96                 {0, NULL, NULL, NULL}};
97
98         srna= RNA_def_struct(brna, "Sensor", NULL, "Sensor");
99         RNA_def_struct_sdna(srna, "bSensor");
100         RNA_def_struct_funcs(srna, NULL, "rna_Sensor_refine");
101
102         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
103         RNA_def_property_ui_text(prop, "Name", "Sensor name.");
104         RNA_def_struct_name_property(srna, prop);
105
106         /* type is not editable, would need to do proper data free/alloc */
107         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
108         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
109         RNA_def_property_enum_items(prop, sensor_type_items);
110         RNA_def_property_ui_text(prop, "Type", "");
111
112         prop= RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
113         RNA_def_property_ui_text(prop, "Invert Output", "Invert the level(output) of this sensor.");
114
115         prop= RNA_def_property(srna, "level", PROP_BOOLEAN, PROP_NONE);
116         RNA_def_property_ui_text(prop, "Level", "Level detector, trigger controllers of new states(only applicable upon logic state transition).");
117
118         prop= RNA_def_property(srna, "pulse_true_level", PROP_BOOLEAN, PROP_NONE);
119         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_PULSE_REPEAT);
120         RNA_def_property_ui_text(prop, "Pulse True Level", "Activate TRUE level triggering (pulse mode).");
121
122         prop= RNA_def_property(srna, "pulse_false_level", PROP_BOOLEAN, PROP_NONE);
123         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_NEG_PULSE_MODE);
124         RNA_def_property_ui_text(prop, "Pulse False Level", "Activate FALSE level triggering (pulse mode).");
125         
126         prop= RNA_def_property(srna, "freq", PROP_INT, PROP_NONE);
127         RNA_def_property_ui_text(prop, "Frequency", "Delay between repeated pulses(in logic tics, 0=no delay).");
128         RNA_def_property_range(prop, 0, 10000);
129 }
130
131 void rna_def_always_sensor(BlenderRNA *brna)
132 {
133         RNA_def_struct(brna, "AlwaysSensor", "Sensor", "Always Sensor");
134 }
135
136 void rna_def_near_sensor(BlenderRNA *brna)
137 {
138         StructRNA *srna;
139         PropertyRNA *prop;
140
141         srna= RNA_def_struct(brna, "NearSensor", "Sensor" , "Near Sensor");
142         RNA_def_struct_sdna_from(srna, "bNearSensor", "data");
143
144         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
145         RNA_def_property_string_sdna(prop, NULL, "name");
146         RNA_def_property_ui_text(prop, "Property", "Only look for objects with this property.");
147
148         prop= RNA_def_property(srna, "distance", PROP_INT, PROP_NONE);
149         RNA_def_property_int_sdna(prop, NULL, "dist");
150         RNA_def_property_ui_text(prop, "Distance", "Trigger distance.");
151         RNA_def_property_range(prop, 0, 10000);
152
153         prop= RNA_def_property(srna, "reset_distance", PROP_INT, PROP_NONE);
154         RNA_def_property_int_sdna(prop, NULL, "resetdist");
155         RNA_def_property_ui_text(prop, "Reset Distance", "");
156         RNA_def_property_range(prop, 0, 10000);
157 }
158
159 void rna_def_mouse_sensor(BlenderRNA *brna)
160 {
161         StructRNA *srna;
162         PropertyRNA *prop;
163
164         static EnumPropertyItem mouse_event_items[] ={
165                 {BL_SENS_MOUSE_LEFT_BUTTON, "LEFTCLICK", "Left Button", ""},
166                 {BL_SENS_MOUSE_MIDDLE_BUTTON, "MIDDLECLICK", "Middle Button", ""},
167                 {BL_SENS_MOUSE_RIGHT_BUTTON, "RIGHTCLICK", "Right Button", ""},
168                 {BL_SENS_MOUSE_WHEEL_UP, "WHEELUP", "Wheel Up", ""},
169                 {BL_SENS_MOUSE_WHEEL_DOWN, "WHEELDOWN", "Wheel Down", ""},
170                 {BL_SENS_MOUSE_MOVEMENT, "MOVEMENT", "Movement", ""},
171                 {BL_SENS_MOUSE_MOUSEOVER, "MOUSEOVER", "Mouse Over", ""},
172                 {BL_SENS_MOUSE_MOUSEOVER_ANY, "MOUSEOVERANY", "Mouse Over Any", ""},
173                 {0, NULL, NULL, NULL}};
174
175         srna= RNA_def_struct(brna, "MouseSensor", "Sensor", "Mouse Sensor");
176         RNA_def_struct_sdna_from(srna, "bMouseSensor", "data");
177
178         prop= RNA_def_property(srna, "mouse_event", PROP_ENUM, PROP_NONE);
179         RNA_def_property_enum_sdna(prop, NULL, "type", 0);
180         RNA_def_property_enum_items(prop, mouse_event_items);
181         RNA_def_property_ui_text(prop, "Mouse Event", "Specify the type of event this mouse sensor should trigger on.");
182 }
183
184 void rna_def_touch_sensor(BlenderRNA *brna)
185 {
186         StructRNA *srna;
187         PropertyRNA *prop;
188
189         srna= RNA_def_struct(brna, "TouchSensor", "Sensor", "Touch Sensor");
190         RNA_def_struct_sdna_from(srna, "bTouchSensor", "data");
191
192         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
193         RNA_def_property_pointer_sdna(prop, NULL, "ma");
194         RNA_def_property_struct_type(prop, "Material");
195         RNA_def_property_ui_text(prop, "Material", "Only look for floors with this material.");
196 }
197
198 void rna_def_keyboard_sensor(BlenderRNA *brna)
199 {
200         StructRNA *srna;
201         PropertyRNA *prop;
202
203         srna= RNA_def_struct(brna, "KeyboardSensor", "Sensor", "Keyboard Sensor");
204         RNA_def_struct_sdna_from(srna, "bKeyboardSensor", "data");
205
206         prop= RNA_def_property(srna, "key", PROP_INT, PROP_NONE);
207         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* need better range or enum check */
208         RNA_def_property_ui_text(prop, "Key", "Input key code.");
209         RNA_def_property_range(prop, 0, 255);
210
211         prop= RNA_def_property(srna, "modifier_key", PROP_INT, PROP_NONE);
212         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* need better range or enum check */
213         RNA_def_property_int_sdna(prop, NULL, "qual");
214         RNA_def_property_ui_text(prop, "Modifier Key", "Modifier key code.");
215         RNA_def_property_range(prop, 0, 255);
216
217         prop= RNA_def_property(srna, "second_modifier_key", PROP_INT, PROP_NONE);
218         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* need better range or enum check */
219         RNA_def_property_int_sdna(prop, NULL, "qual2");
220         RNA_def_property_ui_text(prop, "Second Modifier Key", "Modifier key code.");
221         RNA_def_property_range(prop, 0, 255);
222
223         prop= RNA_def_property(srna, "target", PROP_STRING, PROP_NONE);
224         RNA_def_property_string_sdna(prop, NULL, "targetName");
225         RNA_def_property_ui_text(prop, "Target", "Property that indicates whether to log keystrokes as a string.");
226
227         prop= RNA_def_property(srna, "log", PROP_STRING, PROP_NONE);
228         RNA_def_property_string_sdna(prop, NULL, "toggleName");
229         RNA_def_property_ui_text(prop, "Log", "Property that receive the keystrokes in case a string is logged.");
230
231         prop= RNA_def_property(srna, "all_keys", PROP_BOOLEAN, PROP_NONE);
232         RNA_def_property_boolean_sdna(prop, NULL, "type", 1);
233         RNA_def_property_ui_text(prop, "All Keys", "Trigger this sensor on any keystroke.");
234 }
235
236 void rna_def_property_sensor(BlenderRNA *brna)
237 {
238         StructRNA *srna;
239         PropertyRNA *prop;
240         static EnumPropertyItem prop_type_items[] ={
241                 {SENS_PROP_EQUAL, "PROPEQUAL", "Equal", ""},
242                 {SENS_PROP_NEQUAL, "PROPNEQUAL", "Not Equal", ""},
243                 {SENS_PROP_INTERVAL, "PROPINTERVAL", "Interval", ""},
244                 {SENS_PROP_CHANGED, "PROPCHANGED", "Changed", ""},
245                 /* {SENS_PROP_EXPRESSION, "PROPEXPRESSION", "Expression", ""},  NOT_USED_IN_UI */
246                 {0, NULL, NULL, NULL}};
247
248         srna= RNA_def_struct(brna, "PropertySensor", "Sensor", "Property Sensor");
249         RNA_def_struct_sdna_from(srna, "bPropertySensor", "data");
250
251         prop= RNA_def_property(srna, "evaluation_type", PROP_ENUM, PROP_NONE);
252         RNA_def_property_enum_sdna(prop, NULL, "type", 0);
253         RNA_def_property_enum_items(prop, prop_type_items);
254         RNA_def_property_ui_text(prop, "Evaluation Type", "Type of property evaluation.");
255
256         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
257         RNA_def_property_string_sdna(prop, NULL, "name");
258         RNA_def_property_ui_text(prop, "Property", "");
259
260         prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
261         RNA_def_property_string_sdna(prop, NULL, "value");
262         RNA_def_property_ui_text(prop, "Value", "Check for this value in types in Equal or Not Equal types.");
263
264         prop= RNA_def_property(srna, "min_value", PROP_STRING, PROP_NONE);
265         RNA_def_property_string_sdna(prop, NULL, "value");
266         RNA_def_property_ui_text(prop, "Minimum Value", "Specify minimum value in Interval type.");
267
268         prop= RNA_def_property(srna, "max_value", PROP_STRING, PROP_NONE);
269         RNA_def_property_string_sdna(prop, NULL, "maxvalue");
270         RNA_def_property_ui_text(prop, "Maximum Value", "Specify maximum value in Interval type.");
271 }
272
273 void rna_def_actuator_sensor(BlenderRNA *brna)
274 {
275         StructRNA *srna;
276         PropertyRNA *prop;
277
278         srna= RNA_def_struct(brna, "ActuatorSensor", "Sensor", "Actuator Sensor");
279         RNA_def_struct_sdna_from(srna, "bActuatorSensor", "data");
280
281         prop= RNA_def_property(srna, "actuator", PROP_STRING, PROP_NONE);
282         RNA_def_property_string_sdna(prop, NULL, "name");
283         RNA_def_property_ui_text(prop, "Actuator", "Actuator name, actuator active state modifications will be detected.");
284 }
285
286 void rna_def_delay_sensor(BlenderRNA *brna)
287 {
288         StructRNA *srna;
289         PropertyRNA *prop;
290
291         srna= RNA_def_struct(brna, "DelaySensor", "Sensor", "Delay Sensor");
292         RNA_def_struct_sdna_from(srna, "bDelaySensor", "data");
293
294         prop= RNA_def_property(srna, "delay", PROP_INT, PROP_NONE);
295         RNA_def_property_ui_text(prop, "Delay", "Delay in number of logic tics before the positive trigger (default 60 per second).");
296         RNA_def_property_range(prop, 0, 5000);
297
298         prop= RNA_def_property(srna, "duration", PROP_INT, PROP_NONE);
299         RNA_def_property_ui_text(prop, "Duration", "If >0, delay in number of logic tics before the negative trigger following the positive trigger.");
300         RNA_def_property_range(prop, 0, 5000);
301
302         prop= RNA_def_property(srna, "repeat", PROP_BOOLEAN, PROP_NONE);
303         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_DELAY_REPEAT);
304         RNA_def_property_ui_text(prop, "Repeat", "Toggle repeat option. If selected, the sensor restarts after Delay+Dur logic tics.");
305 }
306
307 void rna_def_collision_sensor(BlenderRNA *brna)
308 {
309         StructRNA *srna;
310         PropertyRNA *prop;
311         static EnumPropertyItem prop_type_items[] ={
312                 {0, "PROPERTY", "Property", ""},
313                 {1, "MATERIAL", "Material", ""},
314                 {0, NULL, NULL, NULL}};
315
316         srna= RNA_def_struct(brna, "CollisionSensor", "Sensor", "Collision Sensor");
317         RNA_def_struct_sdna_from(srna, "bCollisionSensor", "data");
318
319         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
320         RNA_def_property_string_sdna(prop, NULL, "name");
321         RNA_def_property_ui_text(prop, "Property Name", "Only look for Objects with this property.");
322
323         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
324         RNA_def_property_string_sdna(prop, NULL, "materialName");
325         RNA_def_property_ui_text(prop, "Material Name", "Only look for Objects with this material.");
326
327         prop= RNA_def_property(srna, "collision_type", PROP_ENUM, PROP_NONE);
328         RNA_def_property_enum_sdna(prop, NULL, "mode", 0);
329         RNA_def_property_enum_items(prop, prop_type_items);
330         RNA_def_property_ui_text(prop, "Collision Type", "Toggle collision on material or property.");
331 }
332
333 void rna_def_radar_sensor(BlenderRNA *brna)
334 {
335         StructRNA *srna;
336         PropertyRNA *prop;
337         static EnumPropertyItem axis_items[] ={
338                 {SENS_RAY_X_AXIS, "XAXIS", "+X axis", ""},
339                 {SENS_RAY_Y_AXIS, "YAXIS", "+Y axis", ""},
340                 {SENS_RAY_Z_AXIS, "ZAXIS", "+Z axis", ""},
341                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", "-X axis", ""},
342                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", "-Y axis", ""},
343                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", "-Z axis", ""},
344                 {0, NULL, NULL, NULL}};
345
346         srna= RNA_def_struct(brna, "RadarSensor", "Sensor", "Radar Sensor");
347         RNA_def_struct_sdna_from(srna, "bRadarSensor", "data");
348
349         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
350         RNA_def_property_string_sdna(prop, NULL, "name");
351         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property.");
352
353         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
354         RNA_def_property_enum_items(prop, axis_items);
355         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the radar cone is cast.");
356
357         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
358         RNA_def_property_range(prop, 0.0, 179.9);
359         RNA_def_property_ui_text(prop, "Angle", "Opening angle of the radar cone.");
360
361         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
362         RNA_def_property_float_sdna(prop, NULL, "range");
363         RNA_def_property_range(prop, 0.0, 10000.0);
364         RNA_def_property_ui_text(prop, "Distance", "Depth of the radar cone.");
365 }
366
367 void rna_def_random_sensor(BlenderRNA *brna)
368 {
369         StructRNA *srna;
370         PropertyRNA *prop;
371
372         srna= RNA_def_struct(brna, "RandomSensor", "Sensor", "Random Sensor");
373         RNA_def_struct_sdna_from(srna, "bRandomSensor", "data");
374
375         prop= RNA_def_property(srna, "seed", PROP_INT, PROP_NONE);
376         RNA_def_property_range(prop, 0, 1000);
377         RNA_def_property_ui_text(prop, "Seed", "Initial seed of the generator. (Choose 0 for not random).");
378 }
379
380 void rna_def_ray_sensor(BlenderRNA *brna)
381 {
382         StructRNA *srna;
383         PropertyRNA *prop;
384         static EnumPropertyItem axis_items[] ={
385                 {SENS_RAY_X_AXIS, "XAXIS", "+X axis", ""},
386                 {SENS_RAY_Y_AXIS, "YAXIS", "+Y axis", ""},
387                 {SENS_RAY_Z_AXIS, "ZAXIS", "+Z axis", ""},
388                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", "-X axis", ""},
389                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", "-Y axis", ""},
390                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", "-Z axis", ""},
391                 {0, NULL, NULL, NULL}};
392         static EnumPropertyItem prop_type_items[] ={
393                 {0, "PROPERTY", "Property", ""},
394                 {1, "MATERIAL", "Material", ""},
395                 {0, NULL, NULL, NULL}};
396
397         srna= RNA_def_struct(brna, "RaySensor", "Sensor", "Ray Sensor");
398         RNA_def_struct_sdna_from(srna, "bRaySensor", "data");
399
400         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
401         RNA_def_property_string_sdna(prop, NULL, "propname");
402         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property.");
403
404         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
405         RNA_def_property_string_sdna(prop, NULL, "matname");
406         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material.");
407
408         prop= RNA_def_property(srna, "ray_type", PROP_ENUM, PROP_NONE);
409         RNA_def_property_enum_sdna(prop, NULL, "mode", 0);
410         RNA_def_property_enum_items(prop, prop_type_items);
411         RNA_def_property_ui_text(prop, "Collision Type", "Toggle collision on material or property.");
412
413         prop= RNA_def_property(srna, "x_ray_mode", PROP_BOOLEAN, PROP_NONE);
414         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_RAY_XRAY);
415         RNA_def_property_ui_text(prop, "X-Ray Mode", "Toggle X-Ray option (see through objects that don't have the property).");
416
417         prop= RNA_def_property(srna, "range", PROP_FLOAT, PROP_NONE);
418         RNA_def_property_range(prop, 0.01, 10000.0);
419         RNA_def_property_ui_text(prop, "Range", "Sense objects no farther than this distance.");
420
421         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
422         RNA_def_property_enum_sdna(prop, NULL, "axisflag", 0);
423         RNA_def_property_enum_items(prop, axis_items);
424         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the ray is cast.");
425 }
426
427 void rna_def_message_sensor(BlenderRNA *brna)
428 {
429         StructRNA *srna;
430         PropertyRNA *prop;
431
432         srna= RNA_def_struct(brna, "MessageSensor", "Sensor", "Message Sensor");
433         RNA_def_struct_sdna_from(srna, "bMessageSensor", "data");
434
435         prop= RNA_def_property(srna, "subject", PROP_STRING, PROP_NONE);
436         RNA_def_property_ui_text(prop, "Subject", "Optional subject filter: only accept messages with this subject, or empty for all.");
437 }
438
439 void rna_def_joystick_sensor(BlenderRNA *brna)
440 {
441         StructRNA *srna;
442         PropertyRNA *prop;
443
444         static EnumPropertyItem event_type_items[] ={
445                 {SENS_JOY_BUTTON, "BUTTON", "Button", ""},
446                 {SENS_JOY_AXIS, "AXIS", "Axis", ""},
447                 {SENS_JOY_HAT, "HAT", "Hat", ""},
448                 {0, NULL, NULL, NULL}};
449
450         static EnumPropertyItem axis_direction_items[] ={
451                 {SENS_JOY_X_AXIS, "RIGHTAXIS", "Right Axis", ""},
452                 {SENS_JOY_Y_AXIS, "UPAXIS", "Up Axis", ""},
453                 {SENS_JOY_NEG_X_AXIS, "LEFTAXIS", "Left Axis", ""},
454                 {SENS_JOY_NEG_Y_AXIS, "DOWNAXIS", "Down Axis", ""},
455                 {0, NULL, NULL, NULL}};
456
457         srna= RNA_def_struct(brna, "JoystickSensor", "Sensor", "Joystick Sensor");
458         RNA_def_struct_sdna_from(srna, "bJoystickSensor", "data");
459         
460         prop= RNA_def_property(srna, "joystick_index", PROP_INT, PROP_NONE);
461         RNA_def_property_int_sdna(prop, NULL, "joyindex");
462         RNA_def_property_ui_text(prop, "Joystick Index", "Specify which joystick to use.");
463         RNA_def_property_range(prop, 0, SENS_JOY_MAXINDEX-1);
464
465         prop= RNA_def_property(srna, "event_type", PROP_ENUM, PROP_NONE);
466         RNA_def_property_enum_sdna(prop, NULL, "type", 0);
467         RNA_def_property_enum_items(prop, event_type_items);
468         RNA_def_property_ui_text(prop, "Event Type", "The type of event this joystick sensor is triggered on.");
469
470         prop= RNA_def_property(srna, "all_events", PROP_BOOLEAN, PROP_NONE);
471         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_JOY_ANY_EVENT);
472         RNA_def_property_ui_text(prop, "All Events", "Triggered by all events on this joysticks current type (axis/button/hat).");
473
474         /* Button */
475         prop= RNA_def_property(srna, "button_number", PROP_INT, PROP_NONE);
476         RNA_def_property_int_sdna(prop, NULL, "button");
477         RNA_def_property_ui_text(prop, "Button Number", "Specify which button to use.");
478         RNA_def_property_range(prop, 0, 18);
479
480         /* Axis */
481         prop= RNA_def_property(srna, "axis_number", PROP_INT, PROP_NONE);
482         RNA_def_property_int_sdna(prop, NULL, "axis");
483         RNA_def_property_ui_text(prop, "Axis Number", "Specify which axis pair to use, 1 is useually the main direction input.");
484         RNA_def_property_range(prop, 1, 2);
485
486         prop= RNA_def_property(srna, "axis_threshold", PROP_INT, PROP_NONE);
487         RNA_def_property_int_sdna(prop, NULL, "precision");
488         RNA_def_property_ui_text(prop, "Axis Threshold", "Specify the precision of the axis.");
489         RNA_def_property_range(prop, 0, 32768);
490
491         prop= RNA_def_property(srna, "axis_direction", PROP_ENUM, PROP_NONE);
492         RNA_def_property_enum_sdna(prop, NULL, "axisf", 0);
493         RNA_def_property_enum_items(prop, axis_direction_items);
494         RNA_def_property_ui_text(prop, "Axis Direction", "The direction of the axis.");
495
496         /* Hat */
497         prop= RNA_def_property(srna, "hat_number", PROP_INT, PROP_NONE);
498         RNA_def_property_int_sdna(prop, NULL, "hat");
499         RNA_def_property_ui_text(prop, "Hat Number", "Specify which hat to use.");
500         RNA_def_property_range(prop, 1, 2);
501
502         prop= RNA_def_property(srna, "hat_direction", PROP_INT, PROP_NONE);
503         RNA_def_property_int_sdna(prop, NULL, "hatf");
504         RNA_def_property_ui_text(prop, "Hat Direction", "Specify hat direction.");
505         RNA_def_property_range(prop, 0, 12);
506 }
507
508 void RNA_def_sensor(BlenderRNA *brna)
509 {
510         rna_def_sensor(brna);
511
512         rna_def_always_sensor(brna);
513         rna_def_near_sensor(brna);
514         rna_def_mouse_sensor(brna);
515         rna_def_touch_sensor(brna);
516         rna_def_keyboard_sensor(brna);
517         rna_def_property_sensor(brna);
518         rna_def_actuator_sensor(brna);
519         rna_def_delay_sensor(brna);
520         rna_def_collision_sensor(brna);
521         rna_def_radar_sensor(brna);
522         rna_def_random_sensor(brna);
523         rna_def_ray_sensor(brna);
524         rna_def_message_sensor(brna);
525         rna_def_joystick_sensor(brna);
526 }
527
528 #endif
529