* changed NULL properties into UnknownProperty
[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 struct StructRNA* rna_Sensor_data_type(struct PointerRNA *ptr)
38 {
39         bSensor *sensor= (bSensor*)ptr->data;
40
41         switch(sensor->type) {
42                 case SENS_ALWAYS:
43                         return &RNA_UnknownType;
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_UnknownType;
72         }
73
74         return &RNA_UnknownType;
75 }
76
77 #else
78
79 void rna_def_sensor(BlenderRNA *brna)
80 {
81         StructRNA *srna;
82         PropertyRNA *prop;
83         static EnumPropertyItem sensor_types_items[] ={
84                 {SENS_ALWAYS, "ALWAYS", "Always", ""},
85                 {SENS_TOUCH, "TOUCH", "Touch", ""},
86                 {SENS_NEAR, "NEAR", "Near", ""},
87                 {SENS_KEYBOARD, "KEYBOARD", "Keyboard", ""},
88                 {SENS_PROPERTY, "PROPERTY", "Property", ""},
89                 {SENS_MOUSE, "MOUSE", "Mouse", ""},
90                 {SENS_COLLISION, "COLLISION", "Collision", ""},
91                 {SENS_RADAR, "RADAR", "Radar", ""},
92                 {SENS_RANDOM, "RANDOM", "Random", ""},
93                 {SENS_RAY, "RAY", "Ray", ""},
94                 {SENS_MESSAGE, "MESSAGE", "Message", ""},
95                 {SENS_JOYSTICK, "JOYSTICK", "joystick", ""},
96                 {SENS_ACTUATOR, "ACTUATOR", "Actuator", ""},
97                 {SENS_DELAY, "DELAY", "Delay", ""},
98                 {0, NULL, NULL, NULL}};
99
100         srna= RNA_def_struct(brna, "Sensor", NULL , "Sensor");
101         RNA_def_struct_sdna(srna, "bSensor");
102
103         prop= RNA_def_property(srna, "sensor_name", PROP_STRING, PROP_NONE);
104         RNA_def_property_string_sdna(prop, NULL, "name");
105         RNA_def_property_string_maxlength(prop, 31);
106         RNA_def_property_ui_text(prop, "Name", "Sensor name.");
107
108         /* type is not editable, would need to do proper data free/alloc */
109         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
110         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
111         RNA_def_property_enum_items(prop, sensor_types_items);
112         RNA_def_property_ui_text(prop, "Sensor Types", "Sensor types.");
113
114         prop= RNA_def_property(srna, "invert", PROP_BOOLEAN, PROP_NONE);
115         RNA_def_property_ui_text(prop, "Invert Output", "Invert the level(output) of this sensor.");
116
117         prop= RNA_def_property(srna, "level", PROP_BOOLEAN, PROP_NONE);
118         RNA_def_property_ui_text(prop, "Level", "Level detector, trigger controllers of new states(only applicable upon logic state transition).");
119
120         prop= RNA_def_property(srna, "pulse_true_level", PROP_BOOLEAN, PROP_NONE);
121         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_PULSE_REPEAT);
122         RNA_def_property_ui_text(prop, "Pulse True Level", "Activate TRUE level triggering (pulse mode).");
123
124         prop= RNA_def_property(srna, "pulse_false_level", PROP_BOOLEAN, PROP_NONE);
125         RNA_def_property_boolean_sdna(prop, NULL, "pulse", SENS_NEG_PULSE_MODE);
126         RNA_def_property_ui_text(prop, "Pulse False Level", "Activate FALSE level triggering (pulse mode).");
127         
128
129         prop= RNA_def_property(srna, "freq", PROP_INT, PROP_NONE);
130         RNA_def_property_ui_text(prop, "Frequency", "Delay between repeated pulses(in logic tics, 0=no delay).");
131         RNA_def_property_range(prop, 0, 10000);
132
133         
134         //This add data property to Sensor, and because data can be bMouseSensor, bNearSensor, bAlwaysSensor ...
135         //rna_Sensor_data_type defines above in runtime section to get its type and proper structure for data
136         prop= RNA_def_property(srna, "data", PROP_POINTER, PROP_NONE);
137         RNA_def_property_ui_text(prop, "Data", "Sensor data.");
138         RNA_def_property_pointer_funcs(prop, NULL, "rna_Sensor_data_type", NULL);
139 }
140
141 void rna_def_near_sensor(BlenderRNA *brna)
142 {
143         StructRNA *srna;
144         PropertyRNA *prop;
145
146         srna= RNA_def_struct(brna, "NearSensor", NULL , "NearSensor");
147         RNA_def_struct_sdna(srna, "bNearSensor");
148
149         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
150         RNA_def_property_string_sdna(prop, NULL, "name");
151         RNA_def_property_string_maxlength(prop, 31);
152         RNA_def_property_ui_text(prop, "Property", "Only look for objects with this property.");
153
154         prop= RNA_def_property(srna, "distance", PROP_INT, PROP_NONE);
155         RNA_def_property_int_sdna(prop, NULL, "dist");
156         RNA_def_property_ui_text(prop, "Distance", "Trigger distance.");
157         RNA_def_property_range(prop, 0, 10000);
158
159         prop= RNA_def_property(srna, "reset_distance", PROP_INT, PROP_NONE);
160         RNA_def_property_int_sdna(prop, NULL, "resetdist");
161         RNA_def_property_ui_text(prop, "Reset", "Reset distance.");
162         RNA_def_property_range(prop, 0, 10000);
163 }
164
165 void rna_def_mouse_sensor(BlenderRNA *brna)
166 {
167         StructRNA *srna;
168         PropertyRNA *prop;
169
170         static EnumPropertyItem mouse_event_items[] ={
171                 {BL_SENS_MOUSE_LEFT_BUTTON, "LEFTCLICK", "Left Button", ""},
172                 {BL_SENS_MOUSE_MIDDLE_BUTTON, "MIDDLECLICK", "Middle Button", ""},
173                 {BL_SENS_MOUSE_RIGHT_BUTTON, "RIGHTCLICK", "Right Button", ""},
174                 {BL_SENS_MOUSE_WHEEL_UP, "WHEELUP", "Wheel Up", ""},
175                 {BL_SENS_MOUSE_WHEEL_DOWN, "WHEELDOWN", "Wheel Down", ""},
176                 {BL_SENS_MOUSE_MOVEMENT, "MOVEMENT", "Movement", ""},
177                 {BL_SENS_MOUSE_MOUSEOVER, "MOUSEOVER", "Mouse Over", ""},
178                 {BL_SENS_MOUSE_MOUSEOVER_ANY, "MOUSEOVERANY", "Mouse Over Any", ""},
179                 {0, NULL, NULL, NULL}};
180
181         srna= RNA_def_struct(brna, "MouseSensor", NULL , "MouseSensor");
182         RNA_def_struct_sdna(srna, "bMouseSensor");
183
184         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
185         RNA_def_property_enum_items(prop, mouse_event_items);
186         RNA_def_property_ui_text(prop, "Mouse Event", "Specify the type of event this mouse sensor should trigger on.");
187 }
188
189 void rna_def_touch_sensor(BlenderRNA *brna)
190 {
191         StructRNA *srna;
192         PropertyRNA *prop;
193
194         srna= RNA_def_struct(brna, "TouchSensor", NULL , "TouchSensor");
195         RNA_def_struct_sdna(srna, "bTouchSensor");
196
197         prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
198         RNA_def_property_pointer_sdna(prop, NULL, "ma");
199         RNA_def_property_struct_type(prop, "Material");
200         RNA_def_property_ui_text(prop, "Material", "only look for floors with this material.");
201
202 }
203
204 void rna_def_keyboard_sensor(BlenderRNA *brna)
205 {
206         StructRNA *srna;
207         PropertyRNA *prop;
208
209         srna= RNA_def_struct(brna, "KeyboardSensor", NULL , "KeyboardSensor");
210         RNA_def_struct_sdna(srna, "bKeyboardSensor");
211
212         prop= RNA_def_property(srna, "key", PROP_INT, PROP_NONE);
213         RNA_def_property_ui_text(prop, "Input Key", "Input key code.");
214         RNA_def_property_range(prop, 0, 255);
215
216         prop= RNA_def_property(srna, "modifier_key1", PROP_INT, PROP_NONE);
217         RNA_def_property_int_sdna(prop, NULL, "qual");
218         RNA_def_property_ui_text(prop, "First Modifier Key", "Modifier key code.");
219         RNA_def_property_range(prop, 0, 255);
220
221         prop= RNA_def_property(srna, "modifier_key2", PROP_INT, PROP_NONE);
222         RNA_def_property_int_sdna(prop, NULL, "qual2");
223         RNA_def_property_ui_text(prop, "Second Modifier Key", "Modifier key code.");
224         RNA_def_property_range(prop, 0, 255);
225
226         prop= RNA_def_property(srna, "target_name", PROP_STRING, PROP_NONE);
227         RNA_def_property_string_sdna(prop, NULL, "targetName");
228         RNA_def_property_string_maxlength(prop, 31);
229         RNA_def_property_ui_text(prop, "Target Name", "Property that indicates whether to log keystrokes as a string.");
230
231         prop= RNA_def_property(srna, "toggle_name", PROP_STRING, PROP_NONE);
232         RNA_def_property_string_sdna(prop, NULL, "toggleName");
233         RNA_def_property_string_maxlength(prop, 31);
234         RNA_def_property_ui_text(prop, "Toggle Name", "Property that receive the keystrokes in case a string is logged.");
235
236         prop= RNA_def_property(srna, "type", PROP_BOOLEAN, PROP_NONE);
237         RNA_def_property_ui_text(prop, "All Keys", "Trigger this sensor on any keystroke.");
238
239 }
240
241 void rna_def_property_sensor(BlenderRNA *brna)
242 {
243         StructRNA *srna;
244         PropertyRNA *prop;
245         static EnumPropertyItem prop_items[] ={
246                 {SENS_PROP_EQUAL, "PROPEQUAL", "Equal", ""},
247                 {SENS_PROP_NEQUAL, "PROPNEQUAL", "Not Equal", ""},
248                 {SENS_PROP_INTERVAL, "PROPINTERVAL", "Interval", ""},
249                 {SENS_PROP_CHANGED, "PROPCHANGED", "Changed", ""},
250                 /* {SENS_PROP_EXPRESSION, "PROPEXPRESSION", "Expression", ""},  NOT_USED_IN_UI */
251                 {0, NULL, NULL, NULL}};
252
253         srna= RNA_def_struct(brna, "PropertySensor", NULL , "PropertySensor");
254         RNA_def_struct_sdna(srna, "bPropertySensor");
255
256         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
257         RNA_def_property_enum_items(prop, prop_items);
258         RNA_def_property_ui_text(prop, "Property Type", "Specify the type of property evaluation type.");
259
260         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
261         RNA_def_property_string_maxlength(prop, 31);
262         RNA_def_property_ui_text(prop, "Property Name", "Property name.");
263
264         prop= RNA_def_property(srna, "first_value", PROP_STRING, PROP_NONE);
265         RNA_def_property_string_sdna(prop, NULL, "value");
266         RNA_def_property_string_maxlength(prop, 31);
267         RNA_def_property_ui_text(prop, "First Value", "Specify the value that checked, or minimum value in Interval Type.");
268
269         prop= RNA_def_property(srna, "second_value", PROP_STRING, PROP_NONE);
270         RNA_def_property_string_sdna(prop, NULL, "maxvalue");
271         RNA_def_property_string_maxlength(prop, 31);
272         RNA_def_property_ui_text(prop, "Second Value", "Specify maximum value in Interval type.");
273 }
274
275 void rna_def_actuator_sensor(BlenderRNA *brna)
276 {
277         StructRNA *srna;
278         PropertyRNA *prop;
279
280         srna= RNA_def_struct(brna, "ActuatorSensor", NULL , "ActuatorSensor");
281         RNA_def_struct_sdna(srna, "bActuatorSensor");
282
283         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
284         RNA_def_property_string_maxlength(prop, 31);
285         RNA_def_property_ui_text(prop, "Actuator Name", "Actuator name.");
286 }
287
288 void rna_def_delay_sensor(BlenderRNA *brna)
289 {
290         StructRNA *srna;
291         PropertyRNA *prop;
292
293         srna= RNA_def_struct(brna, "DelaySensor", NULL , "DelaySensor");
294         RNA_def_struct_sdna(srna, "bDelaySensor");
295
296         prop= RNA_def_property(srna, "delay", PROP_INT, PROP_NONE);
297         RNA_def_property_ui_text(prop, "Delay", "Delay in number of logic tics before the positive trigger (default 60 per second).");
298         RNA_def_property_range(prop, 0, 5000);
299
300         prop= RNA_def_property(srna, "duration", PROP_INT, PROP_NONE);
301         RNA_def_property_ui_text(prop, "Duration", "If >0, delay in number of logic tics before the negative trigger following the positive trigger.");
302         RNA_def_property_range(prop, 0, 5000);
303
304         prop= RNA_def_property(srna, "repeat", PROP_BOOLEAN, PROP_NONE);
305         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_DELAY_REPEAT);
306         RNA_def_property_ui_text(prop, "Repeat", "Toggle repeat option. If selected, the sensor restarts after Delay+Dur logic tics.");
307 }
308
309 void rna_def_collision_sensor(BlenderRNA *brna)
310 {
311         StructRNA *srna;
312         PropertyRNA *prop;
313
314         srna= RNA_def_struct(brna, "CollisionSensor", NULL , "CollisionSensor");
315         RNA_def_struct_sdna(srna, "bCollisionSensor");
316
317         prop= RNA_def_property(srna, "property_name", PROP_STRING, PROP_NONE);
318         RNA_def_property_string_sdna(prop, NULL, "name");
319         RNA_def_property_string_maxlength(prop, 31);
320         RNA_def_property_ui_text(prop, "Property Name", "Only look for Objects with this property.");
321
322         prop= RNA_def_property(srna, "material_name", PROP_STRING, PROP_NONE);
323         RNA_def_property_string_sdna(prop, NULL, "materialName");
324         RNA_def_property_string_maxlength(prop, 31);
325         RNA_def_property_ui_text(prop, "Material Name", "Only look for Objects with this material.");
326
327         prop= RNA_def_property(srna, "type", PROP_BOOLEAN, PROP_NONE);
328         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_COLLISION_MATERIAL);
329         RNA_def_property_ui_text(prop, "Material/Property", "Toggle collision on material or property.");
330 }
331
332 void rna_def_radar_sensor(BlenderRNA *brna)
333 {
334         StructRNA *srna;
335         PropertyRNA *prop;
336         static EnumPropertyItem axis_items[] ={
337                 {SENS_RAY_X_AXIS, "RAYX", "+X axis", ""},
338                 {SENS_RAY_Y_AXIS, "RAYY", "+Y axis", ""},
339                 {SENS_RAY_Z_AXIS, "RAYZ", "+Z axis", ""},
340                 {SENS_RAY_NEG_X_AXIS, "RAYNX", "-X axis", ""},
341                 {SENS_RAY_NEG_Y_AXIS, "RAYNY", "-Y axis", ""},
342                 {SENS_RAY_NEG_Z_AXIS, "RAYNZ", "-Z axis", ""},
343                 {0, NULL, NULL, NULL}};
344         srna= RNA_def_struct(brna, "RadarSensor", NULL , "RadarSensor");
345         RNA_def_struct_sdna(srna, "bRadarSensor");
346
347         prop= RNA_def_property(srna, "property_name", PROP_STRING, PROP_NONE);
348         RNA_def_property_string_sdna(prop, NULL, "name");
349         RNA_def_property_string_maxlength(prop, 31);
350         RNA_def_property_ui_text(prop, "Property Name", "Only look for Objects with this property.");
351
352         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
353         RNA_def_property_enum_items(prop, axis_items);
354         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the radar cone is cast.");
355
356         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
357         RNA_def_property_range(prop, 0.0, 179.9);
358         RNA_def_property_ui_text(prop, "Angle", "Opening angle of the radar cone.");
359
360         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
361         RNA_def_property_float_sdna(prop, NULL, "range");
362         RNA_def_property_range(prop, 0.0, 10000.0);
363         RNA_def_property_ui_text(prop, "Distance", "Depth of the radar cone.");
364 }
365
366 void rna_def_random_sensor(BlenderRNA *brna)
367 {
368         StructRNA *srna;
369         PropertyRNA *prop;
370
371         srna= RNA_def_struct(brna, "RandomSensor", NULL , "RandomSensor");
372         RNA_def_struct_sdna(srna, "bRandomSensor");
373
374         prop= RNA_def_property(srna, "seed", PROP_INT, PROP_NONE);
375         RNA_def_property_range(prop, 0, 1000);
376         RNA_def_property_ui_text(prop, "Seed", "Initial seed of the generator. (Choose 0 for not random).");
377
378 }
379
380 void rna_def_ray_sensor(BlenderRNA *brna)
381 {
382         StructRNA *srna;
383         PropertyRNA *prop;
384         
385         static EnumPropertyItem axis_items[] ={
386                 {SENS_RAY_X_AXIS, "RAYX", "+X axis", ""},
387                 {SENS_RAY_Y_AXIS, "RAYY", "+Y axis", ""},
388                 {SENS_RAY_Z_AXIS, "RAYZ", "+Z axis", ""},
389                 {SENS_RAY_NEG_X_AXIS, "RAYNX", "-X axis", ""},
390                 {SENS_RAY_NEG_Y_AXIS, "RAYNY", "-Y axis", ""},
391                 {SENS_RAY_NEG_Z_AXIS, "RAYNZ", "-Z axis", ""},
392                 {0, NULL, NULL, NULL}};
393
394         srna= RNA_def_struct(brna, "RaySensor", NULL , "RaySensor");
395         RNA_def_struct_sdna(srna, "bRaySensor");
396
397         prop= RNA_def_property(srna, "property_name", PROP_STRING, PROP_NONE);
398         RNA_def_property_string_sdna(prop, NULL, "propname");
399         RNA_def_property_string_maxlength(prop, 31);
400         RNA_def_property_ui_text(prop, "Property Name", "Only look for Objects with this property.");
401
402         prop= RNA_def_property(srna, "material_name", PROP_STRING, PROP_NONE);
403         RNA_def_property_string_sdna(prop, NULL, "matname");
404         RNA_def_property_string_maxlength(prop, 31);
405         RNA_def_property_ui_text(prop, "Material Name", "Only look for Objects with this material.");
406
407         prop= RNA_def_property(srna, "type", PROP_BOOLEAN, PROP_NONE);
408         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_COLLISION_MATERIAL);
409         RNA_def_property_ui_text(prop, "Material/Property", "Toggle collision on material or property.");
410
411         prop= RNA_def_property(srna, "x_ray_mode", PROP_BOOLEAN, PROP_NONE);
412         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_RAY_XRAY);
413         RNA_def_property_ui_text(prop, "X-Ray Mode", "Toggle X-Ray option (see through objects that don't have the property).");
414
415         prop= RNA_def_property(srna, "range", PROP_FLOAT, PROP_NONE);
416         RNA_def_property_range(prop, 0.0, 10000.0);
417         RNA_def_property_ui_text(prop, "Range", "Sense objects no farther than this distance.");
418
419         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
420         RNA_def_property_enum_sdna(prop, NULL, "axisflag", PROP_DEF_ENUM_BITFLAGS);
421         RNA_def_property_enum_items(prop, axis_items);
422         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the ray is cast.");
423
424 }
425
426 void rna_def_message_sensor(BlenderRNA *brna)
427 {
428         StructRNA *srna;
429         PropertyRNA *prop;
430
431         srna= RNA_def_struct(brna, "MessageSensor", NULL , "MessageSensor");
432         RNA_def_struct_sdna(srna, "bMessageSensor");
433
434         prop= RNA_def_property(srna, "subject", PROP_STRING, PROP_NONE);
435         RNA_def_property_string_maxlength(prop, 31);
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", NULL , "JoystickSensor");
458         RNA_def_struct_sdna(srna, "bJoystickSensor");
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, "Index", "Specify which joystick to use.");
463         RNA_def_property_range(prop, 0, SENS_JOY_MAXINDEX-1);
464
465
466         prop= RNA_def_property(srna, "event_type", PROP_ENUM, PROP_NONE);
467         RNA_def_property_enum_sdna(prop, NULL, "type", PROP_DEF_ENUM_BITFLAGS);
468         RNA_def_property_enum_items(prop, event_type_items);
469         RNA_def_property_ui_text(prop, "Event Type", "The type of event this joystick sensor is triggered on.");
470
471         prop= RNA_def_property(srna, "any_event", PROP_BOOLEAN, PROP_NONE);
472         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_JOY_ANY_EVENT);
473         RNA_def_property_ui_text(prop, "All (Button/Axis/Hat) Events", "Triggered by all events on this joysticks current type (axis/button/hat).");
474
475         /* Button */
476         prop= RNA_def_property(srna, "button_number", PROP_INT, PROP_NONE);
477         RNA_def_property_int_sdna(prop, NULL, "button");
478         RNA_def_property_ui_text(prop, "Button Number", "Specify which button to use.");
479         RNA_def_property_range(prop, 0, 18);
480
481         /* Axis */
482         prop= RNA_def_property(srna, "axis_number", PROP_INT, PROP_NONE);
483         RNA_def_property_int_sdna(prop, NULL, "axis");
484         RNA_def_property_ui_text(prop, "Axis Number", "Specify which axis pair to use, 1 is useually the main direction input.");
485         RNA_def_property_range(prop, 1, 2);
486
487         prop= RNA_def_property(srna, "axis_threshold", PROP_INT, PROP_NONE);
488         RNA_def_property_int_sdna(prop, NULL, "precision");
489         RNA_def_property_ui_text(prop, "Axis Threshold", "Specify the precision of the axis.");
490         RNA_def_property_range(prop, 0, 32768);
491
492         prop= RNA_def_property(srna, "axis_direction", PROP_ENUM, PROP_NONE);
493         RNA_def_property_enum_sdna(prop, NULL, "axisf", PROP_DEF_ENUM_BITFLAGS);
494         RNA_def_property_enum_items(prop, axis_direction_items);
495         RNA_def_property_ui_text(prop, "Axis Direction", "The direction of the axis.");
496
497         /* Hat */
498         prop= RNA_def_property(srna, "hat_number", PROP_INT, PROP_NONE);
499         RNA_def_property_int_sdna(prop, NULL, "hat");
500         RNA_def_property_ui_text(prop, "Hat Number", "Specify which hat to use.");
501         RNA_def_property_range(prop, 1, 2);
502
503         prop= RNA_def_property(srna, "hat_direction", PROP_INT, PROP_NONE);
504         RNA_def_property_int_sdna(prop, NULL, "hatf");
505         RNA_def_property_ui_text(prop, "Hat Direction", "Specify hat direction.");
506         RNA_def_property_range(prop, 0, 12);
507 }
508
509
510 void RNA_def_sensor(BlenderRNA *brna)
511 {
512         rna_def_sensor(brna);
513
514         rna_def_near_sensor(brna);
515         rna_def_mouse_sensor(brna);
516         rna_def_touch_sensor(brna);
517         rna_def_keyboard_sensor(brna);
518         rna_def_property_sensor(brna);
519         rna_def_actuator_sensor(brna);
520         rna_def_delay_sensor(brna);
521         rna_def_collision_sensor(brna);
522         rna_def_radar_sensor(brna);
523         rna_def_random_sensor(brna);
524         rna_def_ray_sensor(brna);
525         rna_def_message_sensor(brna);
526         rna_def_joystick_sensor(brna);
527 }
528
529 #endif
530