1db3abe12ec27761fbd9132801344ba5cc3802a9
[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_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_sensor_types.h"
33
34 #ifdef RNA_RUNTIME
35
36 static StructRNA* rna_Sensor_refine(struct PointerRNA *ptr)
37 {
38         bSensor *sensor= (bSensor*)ptr->data;
39
40         switch(sensor->type) {
41                 case SENS_ALWAYS:
42                         return &RNA_AlwaysSensor;
43                 case SENS_TOUCH:
44                         return &RNA_TouchSensor;
45                 case SENS_NEAR:
46                         return &RNA_NearSensor;
47                 case SENS_KEYBOARD:
48                         return &RNA_KeyboardSensor;
49                 case SENS_PROPERTY:
50                         return &RNA_PropertySensor;
51                 case SENS_MOUSE:
52                         return &RNA_MouseSensor;
53                 case SENS_COLLISION:
54                         return &RNA_CollisionSensor;
55                 case SENS_RADAR:
56                         return &RNA_RadarSensor;
57                 case SENS_RANDOM:
58                         return &RNA_RandomSensor;
59                 case SENS_RAY:
60                         return &RNA_RaySensor;
61                 case SENS_MESSAGE:
62                         return &RNA_MessageSensor;
63                 case SENS_JOYSTICK:
64                         return &RNA_JoystickSensor;
65                 case SENS_ACTUATOR:
66                         return &RNA_ActuatorSensor;
67                 case SENS_DELAY:
68                         return &RNA_DelaySensor;
69                 default:
70                         return &RNA_Sensor;
71         }
72 }
73
74 #else
75
76 void rna_def_sensor(BlenderRNA *brna)
77 {
78         StructRNA *srna;
79         PropertyRNA *prop;
80         static EnumPropertyItem sensor_type_items[] ={
81                 {SENS_ALWAYS, "ALWAYS", "Always", ""},
82                 {SENS_TOUCH, "TOUCH", "Touch", ""},
83                 {SENS_NEAR, "NEAR", "Near", ""},
84                 {SENS_KEYBOARD, "KEYBOARD", "Keyboard", ""},
85                 {SENS_PROPERTY, "PROPERTY", "Property", ""},
86                 {SENS_MOUSE, "MOUSE", "Mouse", ""},
87                 {SENS_COLLISION, "COLLISION", "Collision", ""},
88                 {SENS_RADAR, "RADAR", "Radar", ""},
89                 {SENS_RANDOM, "RANDOM", "Random", ""},
90                 {SENS_RAY, "RAY", "Ray", ""},
91                 {SENS_MESSAGE, "MESSAGE", "Message", ""},
92                 {SENS_JOYSTICK, "JOYSTICK", "joystick", ""},
93                 {SENS_ACTUATOR, "ACTUATOR", "Actuator", ""},
94                 {SENS_DELAY, "DELAY", "Delay", ""},
95                 {0, NULL, NULL, NULL}};
96
97         srna= RNA_def_struct(brna, "Sensor", NULL);
98         RNA_def_struct_ui_text(srna, "Sensor", "DOC_BROKEN");
99         RNA_def_struct_sdna(srna, "bSensor");
100         RNA_def_struct_refine_func(srna, "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         StructRNA *srna;
134         srna= RNA_def_struct(brna, "AlwaysSensor", "Sensor");
135         RNA_def_struct_ui_text(srna, "Always Sensor", "DOC_BROKEN");
136 }
137
138 void rna_def_near_sensor(BlenderRNA *brna)
139 {
140         StructRNA *srna;
141         PropertyRNA *prop;
142
143         srna= RNA_def_struct(brna, "NearSensor", "Sensor");
144         RNA_def_struct_ui_text(srna , "Near Sensor", "DOC_BROKEN");
145         RNA_def_struct_sdna_from(srna, "bNearSensor", "data");
146
147         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
148         RNA_def_property_string_sdna(prop, NULL, "name");
149         RNA_def_property_ui_text(prop, "Property", "Only look for objects with this property.");
150
151         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
152         RNA_def_property_float_sdna(prop, NULL, "dist");
153         RNA_def_property_ui_text(prop, "Distance", "Trigger distance.");
154         RNA_def_property_range(prop, 0.0f, 10000.0f);
155
156         prop= RNA_def_property(srna, "reset_distance", PROP_FLOAT, PROP_NONE);
157         RNA_def_property_float_sdna(prop, NULL, "resetdist");
158         RNA_def_property_ui_text(prop, "Reset Distance", "");
159         RNA_def_property_range(prop, 0.0f, 10000.0f);
160 }
161
162 void rna_def_mouse_sensor(BlenderRNA *brna)
163 {
164         StructRNA *srna;
165         PropertyRNA *prop;
166
167         static EnumPropertyItem mouse_event_items[] ={
168                 {BL_SENS_MOUSE_LEFT_BUTTON, "LEFTCLICK", "Left Button", ""},
169                 {BL_SENS_MOUSE_MIDDLE_BUTTON, "MIDDLECLICK", "Middle Button", ""},
170                 {BL_SENS_MOUSE_RIGHT_BUTTON, "RIGHTCLICK", "Right Button", ""},
171                 {BL_SENS_MOUSE_WHEEL_UP, "WHEELUP", "Wheel Up", ""},
172                 {BL_SENS_MOUSE_WHEEL_DOWN, "WHEELDOWN", "Wheel Down", ""},
173                 {BL_SENS_MOUSE_MOVEMENT, "MOVEMENT", "Movement", ""},
174                 {BL_SENS_MOUSE_MOUSEOVER, "MOUSEOVER", "Mouse Over", ""},
175                 {BL_SENS_MOUSE_MOUSEOVER_ANY, "MOUSEOVERANY", "Mouse Over Any", ""},
176                 {0, NULL, NULL, NULL}};
177
178         srna= RNA_def_struct(brna, "MouseSensor", "Sensor");
179         RNA_def_struct_ui_text(srna, "Mouse Sensor", "DOC_BROKEN");
180         RNA_def_struct_sdna_from(srna, "bMouseSensor", "data");
181
182         prop= RNA_def_property(srna, "mouse_event", PROP_ENUM, PROP_NONE);
183         RNA_def_property_enum_sdna(prop, NULL, "type");
184         RNA_def_property_enum_items(prop, mouse_event_items);
185         RNA_def_property_ui_text(prop, "Mouse Event", "Specify the type of event this mouse sensor should trigger on.");
186 }
187
188 void rna_def_touch_sensor(BlenderRNA *brna)
189 {
190         StructRNA *srna;
191         PropertyRNA *prop;
192
193         srna= RNA_def_struct(brna, "TouchSensor", "Sensor");
194         RNA_def_struct_ui_text(srna, "Touch Sensor", "DOC_BROKEN");
195         RNA_def_struct_sdna_from(srna, "bTouchSensor", "data");
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_ui_text(prop, "Material", "Only look for floors with this material.");
200 }
201
202 void rna_def_keyboard_sensor(BlenderRNA *brna)
203 {
204         StructRNA *srna;
205         PropertyRNA *prop;
206
207         srna= RNA_def_struct(brna, "KeyboardSensor", "Sensor");
208         RNA_def_struct_ui_text(srna, "Keyboard Sensor", "DOC_BROKEN");
209         RNA_def_struct_sdna_from(srna, "bKeyboardSensor", "data");
210
211         prop= RNA_def_property(srna, "key", PROP_INT, PROP_NONE);
212         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* need better range or enum check */
213         RNA_def_property_ui_text(prop, "Key", "Input key code.");
214         RNA_def_property_range(prop, 0, 255);
215
216         prop= RNA_def_property(srna, "modifier_key", PROP_INT, PROP_NONE);
217         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* need better range or enum check */
218         RNA_def_property_int_sdna(prop, NULL, "qual");
219         RNA_def_property_ui_text(prop, "Modifier Key", "Modifier key code.");
220         RNA_def_property_range(prop, 0, 255);
221
222         prop= RNA_def_property(srna, "second_modifier_key", PROP_INT, PROP_NONE);
223         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* need better range or enum check */
224         RNA_def_property_int_sdna(prop, NULL, "qual2");
225         RNA_def_property_ui_text(prop, "Second Modifier Key", "Modifier key code.");
226         RNA_def_property_range(prop, 0, 255);
227
228         prop= RNA_def_property(srna, "target", PROP_STRING, PROP_NONE);
229         RNA_def_property_string_sdna(prop, NULL, "targetName");
230         RNA_def_property_ui_text(prop, "Target", "Property that indicates whether to log keystrokes as a string.");
231
232         prop= RNA_def_property(srna, "log", PROP_STRING, PROP_NONE);
233         RNA_def_property_string_sdna(prop, NULL, "toggleName");
234         RNA_def_property_ui_text(prop, "Log", "Property that receive the keystrokes in case a string is logged.");
235
236         prop= RNA_def_property(srna, "all_keys", PROP_BOOLEAN, PROP_NONE);
237         RNA_def_property_boolean_sdna(prop, NULL, "type", 1);
238         RNA_def_property_ui_text(prop, "All Keys", "Trigger this sensor on any keystroke.");
239 }
240
241 void rna_def_property_sensor(BlenderRNA *brna)
242 {
243         StructRNA *srna;
244         PropertyRNA *prop;
245         static EnumPropertyItem prop_type_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", "Sensor");
254         RNA_def_struct_ui_text(srna, "Property Sensor", "DOC_BROKEN");
255         RNA_def_struct_sdna_from(srna, "bPropertySensor", "data");
256
257         prop= RNA_def_property(srna, "evaluation_type", PROP_ENUM, PROP_NONE);
258         RNA_def_property_enum_sdna(prop, NULL, "type");
259         RNA_def_property_enum_items(prop, prop_type_items);
260         RNA_def_property_ui_text(prop, "Evaluation Type", "Type of property evaluation.");
261
262         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
263         RNA_def_property_string_sdna(prop, NULL, "name");
264         RNA_def_property_ui_text(prop, "Property", "");
265
266         prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
267         RNA_def_property_string_sdna(prop, NULL, "value");
268         RNA_def_property_ui_text(prop, "Value", "Check for this value in types in Equal or Not Equal types.");
269
270         prop= RNA_def_property(srna, "min_value", PROP_STRING, PROP_NONE);
271         RNA_def_property_string_sdna(prop, NULL, "value");
272         RNA_def_property_ui_text(prop, "Minimum Value", "Specify minimum value in Interval type.");
273
274         prop= RNA_def_property(srna, "max_value", PROP_STRING, PROP_NONE);
275         RNA_def_property_string_sdna(prop, NULL, "maxvalue");
276         RNA_def_property_ui_text(prop, "Maximum Value", "Specify maximum value in Interval type.");
277 }
278
279 void rna_def_actuator_sensor(BlenderRNA *brna)
280 {
281         StructRNA *srna;
282         PropertyRNA *prop;
283
284         srna= RNA_def_struct(brna, "ActuatorSensor", "Sensor");
285         RNA_def_struct_ui_text(srna, "Actuator Sensor", "DOC_BROKEN");
286         RNA_def_struct_sdna_from(srna, "bActuatorSensor", "data");
287
288         prop= RNA_def_property(srna, "actuator", PROP_STRING, PROP_NONE);
289         RNA_def_property_string_sdna(prop, NULL, "name");
290         RNA_def_property_ui_text(prop, "Actuator", "Actuator name, actuator active state modifications will be detected.");
291 }
292
293 void rna_def_delay_sensor(BlenderRNA *brna)
294 {
295         StructRNA *srna;
296         PropertyRNA *prop;
297
298         srna= RNA_def_struct(brna, "DelaySensor", "Sensor");
299         RNA_def_struct_ui_text(srna, "Delay Sensor", "DOC_BROKEN");
300         RNA_def_struct_sdna_from(srna, "bDelaySensor", "data");
301
302         prop= RNA_def_property(srna, "delay", PROP_INT, PROP_NONE);
303         RNA_def_property_ui_text(prop, "Delay", "Delay in number of logic tics before the positive trigger (default 60 per second).");
304         RNA_def_property_range(prop, 0, 5000);
305
306         prop= RNA_def_property(srna, "duration", PROP_INT, PROP_NONE);
307         RNA_def_property_ui_text(prop, "Duration", "If >0, delay in number of logic tics before the negative trigger following the positive trigger.");
308         RNA_def_property_range(prop, 0, 5000);
309
310         prop= RNA_def_property(srna, "repeat", PROP_BOOLEAN, PROP_NONE);
311         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_DELAY_REPEAT);
312         RNA_def_property_ui_text(prop, "Repeat", "Toggle repeat option. If selected, the sensor restarts after Delay+Dur logic tics.");
313 }
314
315 void rna_def_collision_sensor(BlenderRNA *brna)
316 {
317         StructRNA *srna;
318         PropertyRNA *prop;
319         static EnumPropertyItem prop_type_items[] ={
320                 {0, "PROPERTY", "Property", ""},
321                 {1, "MATERIAL", "Material", ""},
322                 {0, NULL, NULL, NULL}};
323
324         srna= RNA_def_struct(brna, "CollisionSensor", "Sensor");
325         RNA_def_struct_ui_text(srna, "Collision Sensor", "DOC_BROKEN");
326         RNA_def_struct_sdna_from(srna, "bCollisionSensor", "data");
327
328         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
329         RNA_def_property_string_sdna(prop, NULL, "name");
330         RNA_def_property_ui_text(prop, "Property Name", "Only look for Objects with this property.");
331
332         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
333         RNA_def_property_string_sdna(prop, NULL, "materialName");
334         RNA_def_property_ui_text(prop, "Material Name", "Only look for Objects with this material.");
335
336         prop= RNA_def_property(srna, "collision_type", PROP_ENUM, PROP_NONE);
337         RNA_def_property_enum_sdna(prop, NULL, "mode");
338         RNA_def_property_enum_items(prop, prop_type_items);
339         RNA_def_property_ui_text(prop, "Collision Type", "Toggle collision on material or property.");
340 }
341
342 void rna_def_radar_sensor(BlenderRNA *brna)
343 {
344         StructRNA *srna;
345         PropertyRNA *prop;
346         static EnumPropertyItem axis_items[] ={
347                 {SENS_RAY_X_AXIS, "XAXIS", "+X axis", ""},
348                 {SENS_RAY_Y_AXIS, "YAXIS", "+Y axis", ""},
349                 {SENS_RAY_Z_AXIS, "ZAXIS", "+Z axis", ""},
350                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", "-X axis", ""},
351                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", "-Y axis", ""},
352                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", "-Z axis", ""},
353                 {0, NULL, NULL, NULL}};
354
355         srna= RNA_def_struct(brna, "RadarSensor", "Sensor");
356         RNA_def_struct_ui_text(srna, "Radar Sensor", "DOC_BROKEN");
357         RNA_def_struct_sdna_from(srna, "bRadarSensor", "data");
358
359         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
360         RNA_def_property_string_sdna(prop, NULL, "name");
361         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property.");
362
363         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
364         RNA_def_property_enum_items(prop, axis_items);
365         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the radar cone is cast.");
366
367         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_NONE);
368         RNA_def_property_range(prop, 0.0, 179.9);
369         RNA_def_property_ui_text(prop, "Angle", "Opening angle of the radar cone.");
370
371         prop= RNA_def_property(srna, "distance", PROP_FLOAT, PROP_NONE);
372         RNA_def_property_float_sdna(prop, NULL, "range");
373         RNA_def_property_range(prop, 0.0, 10000.0);
374         RNA_def_property_ui_text(prop, "Distance", "Depth of the radar cone.");
375 }
376
377 void rna_def_random_sensor(BlenderRNA *brna)
378 {
379         StructRNA *srna;
380         PropertyRNA *prop;
381
382         srna= RNA_def_struct(brna, "RandomSensor", "Sensor");
383         RNA_def_struct_ui_text(srna, "Random Sensor", "DOC_BROKEN");
384         RNA_def_struct_sdna_from(srna, "bRandomSensor", "data");
385
386         prop= RNA_def_property(srna, "seed", PROP_INT, PROP_NONE);
387         RNA_def_property_range(prop, 0, 1000);
388         RNA_def_property_ui_text(prop, "Seed", "Initial seed of the generator. (Choose 0 for not random).");
389 }
390
391 void rna_def_ray_sensor(BlenderRNA *brna)
392 {
393         StructRNA *srna;
394         PropertyRNA *prop;
395         static EnumPropertyItem axis_items[] ={
396                 {SENS_RAY_X_AXIS, "XAXIS", "+X axis", ""},
397                 {SENS_RAY_Y_AXIS, "YAXIS", "+Y axis", ""},
398                 {SENS_RAY_Z_AXIS, "ZAXIS", "+Z axis", ""},
399                 {SENS_RAY_NEG_X_AXIS, "NEGXAXIS", "-X axis", ""},
400                 {SENS_RAY_NEG_Y_AXIS, "NEGYAXIS", "-Y axis", ""},
401                 {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", "-Z axis", ""},
402                 {0, NULL, NULL, NULL}};
403         static EnumPropertyItem prop_type_items[] ={
404                 {0, "PROPERTY", "Property", ""},
405                 {1, "MATERIAL", "Material", ""},
406                 {0, NULL, NULL, NULL}};
407
408         srna= RNA_def_struct(brna, "RaySensor", "Sensor");
409         RNA_def_struct_ui_text(srna, "Ray Sensor", "DOC_BROKEN");
410         RNA_def_struct_sdna_from(srna, "bRaySensor", "data");
411
412         prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
413         RNA_def_property_string_sdna(prop, NULL, "propname");
414         RNA_def_property_ui_text(prop, "Property", "Only look for Objects with this property.");
415
416         prop= RNA_def_property(srna, "material", PROP_STRING, PROP_NONE);
417         RNA_def_property_string_sdna(prop, NULL, "matname");
418         RNA_def_property_ui_text(prop, "Material", "Only look for Objects with this material.");
419
420         prop= RNA_def_property(srna, "ray_type", PROP_ENUM, PROP_NONE);
421         RNA_def_property_enum_sdna(prop, NULL, "mode");
422         RNA_def_property_enum_items(prop, prop_type_items);
423         RNA_def_property_ui_text(prop, "Collision Type", "Toggle collision on material or property.");
424
425         prop= RNA_def_property(srna, "x_ray_mode", PROP_BOOLEAN, PROP_NONE);
426         RNA_def_property_boolean_sdna(prop, NULL, "mode", SENS_RAY_XRAY);
427         RNA_def_property_ui_text(prop, "X-Ray Mode", "Toggle X-Ray option (see through objects that don't have the property).");
428
429         prop= RNA_def_property(srna, "range", PROP_FLOAT, PROP_NONE);
430         RNA_def_property_range(prop, 0.01, 10000.0);
431         RNA_def_property_ui_text(prop, "Range", "Sense objects no farther than this distance.");
432
433         prop= RNA_def_property(srna, "axis", PROP_ENUM, PROP_NONE);
434         RNA_def_property_enum_sdna(prop, NULL, "axisflag");
435         RNA_def_property_enum_items(prop, axis_items);
436         RNA_def_property_ui_text(prop, "Axis", "Specify along which axis the ray is cast.");
437 }
438
439 void rna_def_message_sensor(BlenderRNA *brna)
440 {
441         StructRNA *srna;
442         PropertyRNA *prop;
443
444         srna= RNA_def_struct(brna, "MessageSensor", "Sensor");
445         RNA_def_struct_ui_text(srna, "Message Sensor", "DOC_BROKEN");
446         RNA_def_struct_sdna_from(srna, "bMessageSensor", "data");
447
448         prop= RNA_def_property(srna, "subject", PROP_STRING, PROP_NONE);
449         RNA_def_property_ui_text(prop, "Subject", "Optional subject filter: only accept messages with this subject, or empty for all.");
450 }
451
452 void rna_def_joystick_sensor(BlenderRNA *brna)
453 {
454         StructRNA *srna;
455         PropertyRNA *prop;
456
457         static EnumPropertyItem event_type_items[] ={
458                 {SENS_JOY_BUTTON, "BUTTON", "Button", ""},
459                 {SENS_JOY_AXIS, "AXIS", "Axis", ""},
460                 {SENS_JOY_HAT, "HAT", "Hat", ""},
461                 {0, NULL, NULL, NULL}};
462
463         static EnumPropertyItem axis_direction_items[] ={
464                 {SENS_JOY_X_AXIS, "RIGHTAXIS", "Right Axis", ""},
465                 {SENS_JOY_Y_AXIS, "UPAXIS", "Up Axis", ""},
466                 {SENS_JOY_NEG_X_AXIS, "LEFTAXIS", "Left Axis", ""},
467                 {SENS_JOY_NEG_Y_AXIS, "DOWNAXIS", "Down Axis", ""},
468                 {0, NULL, NULL, NULL}};
469
470         srna= RNA_def_struct(brna, "JoystickSensor", "Sensor");
471         RNA_def_struct_ui_text(srna, "Joystick Sensor", "DOC_BROKEN");
472         RNA_def_struct_sdna_from(srna, "bJoystickSensor", "data");
473         
474         prop= RNA_def_property(srna, "joystick_index", PROP_INT, PROP_NONE);
475         RNA_def_property_int_sdna(prop, NULL, "joyindex");
476         RNA_def_property_ui_text(prop, "Joystick Index", "Specify which joystick to use.");
477         RNA_def_property_range(prop, 0, SENS_JOY_MAXINDEX-1);
478
479         prop= RNA_def_property(srna, "event_type", PROP_ENUM, PROP_NONE);
480         RNA_def_property_enum_sdna(prop, NULL, "type");
481         RNA_def_property_enum_items(prop, event_type_items);
482         RNA_def_property_ui_text(prop, "Event Type", "The type of event this joystick sensor is triggered on.");
483
484         prop= RNA_def_property(srna, "all_events", PROP_BOOLEAN, PROP_NONE);
485         RNA_def_property_boolean_sdna(prop, NULL, "flag", SENS_JOY_ANY_EVENT);
486         RNA_def_property_ui_text(prop, "All Events", "Triggered by all events on this joysticks current type (axis/button/hat).");
487
488         /* Button */
489         prop= RNA_def_property(srna, "button_number", PROP_INT, PROP_NONE);
490         RNA_def_property_int_sdna(prop, NULL, "button");
491         RNA_def_property_ui_text(prop, "Button Number", "Specify which button to use.");
492         RNA_def_property_range(prop, 0, 18);
493
494         /* Axis */
495         prop= RNA_def_property(srna, "axis_number", PROP_INT, PROP_NONE);
496         RNA_def_property_int_sdna(prop, NULL, "axis");
497         RNA_def_property_ui_text(prop, "Axis Number", "Specify which axis pair to use, 1 is useually the main direction input.");
498         RNA_def_property_range(prop, 1, 2);
499
500         prop= RNA_def_property(srna, "axis_threshold", PROP_INT, PROP_NONE);
501         RNA_def_property_int_sdna(prop, NULL, "precision");
502         RNA_def_property_ui_text(prop, "Axis Threshold", "Specify the precision of the axis.");
503         RNA_def_property_range(prop, 0, 32768);
504
505         prop= RNA_def_property(srna, "axis_direction", PROP_ENUM, PROP_NONE);
506         RNA_def_property_enum_sdna(prop, NULL, "axisf");
507         RNA_def_property_enum_items(prop, axis_direction_items);
508         RNA_def_property_ui_text(prop, "Axis Direction", "The direction of the axis.");
509
510         /* Hat */
511         prop= RNA_def_property(srna, "hat_number", PROP_INT, PROP_NONE);
512         RNA_def_property_int_sdna(prop, NULL, "hat");
513         RNA_def_property_ui_text(prop, "Hat Number", "Specify which hat to use.");
514         RNA_def_property_range(prop, 1, 2);
515
516         prop= RNA_def_property(srna, "hat_direction", PROP_INT, PROP_NONE);
517         RNA_def_property_int_sdna(prop, NULL, "hatf");
518         RNA_def_property_ui_text(prop, "Hat Direction", "Specify hat direction.");
519         RNA_def_property_range(prop, 0, 12);
520 }
521
522 void RNA_def_sensor(BlenderRNA *brna)
523 {
524         rna_def_sensor(brna);
525
526         rna_def_always_sensor(brna);
527         rna_def_near_sensor(brna);
528         rna_def_mouse_sensor(brna);
529         rna_def_touch_sensor(brna);
530         rna_def_keyboard_sensor(brna);
531         rna_def_property_sensor(brna);
532         rna_def_actuator_sensor(brna);
533         rna_def_delay_sensor(brna);
534         rna_def_collision_sensor(brna);
535         rna_def_radar_sensor(brna);
536         rna_def_random_sensor(brna);
537         rna_def_ray_sensor(brna);
538         rna_def_message_sensor(brna);
539         rna_def_joystick_sensor(brna);
540 }
541
542 #endif
543