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