Merging with trunk up to r38631.
[blender.git] / doc / python_api / rst / bge.types.rst
1
2 Game Engine  bge.types Module
3 =============================
4
5 .. module:: bge.types
6
7 .. class:: PyObjectPlus
8
9    PyObjectPlus base class of most other types in the Game Engine.
10
11    .. attribute:: invalid
12
13       Test if the object has been freed by the game engine and is no longer valid.
14        
15       Normally this is not a problem but when storing game engine data in the GameLogic module, 
16       KX_Scenes or other KX_GameObjects its possible to hold a reference to invalid data.
17       Calling an attribute or method on an invalid object will raise a SystemError.
18        
19       The invalid attribute allows testing for this case without exception handling.
20
21       :type: boolean
22
23 .. class:: CValue(PyObjectPlus)
24
25    This class is a basis for other classes.
26
27    .. attribute:: name
28
29       The name of this CValue derived object (read-only).
30
31       :type: string
32       
33 .. class:: CPropValue(CValue)
34
35    This class has no python functions
36
37 .. class:: SCA_ILogicBrick(CValue)
38
39    Base class for all logic bricks.
40
41    .. attribute:: executePriority
42
43       This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
44
45       :type: executePriority: int
46
47    .. attribute:: owner
48
49       The game object this logic brick is attached to (read-only).
50       
51       :type: :class:`KX_GameObject` or None in exceptional cases.
52
53    .. attribute:: name
54
55       The name of this logic brick (read-only).
56       
57       :type: string
58
59 .. class:: SCA_PythonKeyboard(PyObjectPlus)
60
61    The current keyboard.
62
63    .. attribute:: events
64
65       A dictionary containing the status of each keyboard event or key. (read-only).
66
67       :type: dictionary {:ref:`keycode<keyboard-keys>`::ref:`status<input-status>`, ...}
68
69 .. class:: SCA_PythonMouse(PyObjectPlus)
70
71    The current mouse.
72
73    .. attribute:: events
74
75       a dictionary containing the status of each mouse event. (read-only).
76
77       :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...}
78       
79    .. attribute:: position
80
81       The normalized x and y position of the mouse cursor.
82
83       :type: list [x, y]
84
85    .. attribute:: visible
86
87       The visibility of the mouse cursor.
88       
89       :type: boolean
90
91 .. class:: SCA_IObject(CValue)
92
93    This class has no python functions
94
95 .. class:: SCA_ISensor(SCA_ILogicBrick)
96
97    Base class for all sensor logic bricks.
98
99    .. attribute:: usePosPulseMode
100
101       Flag to turn positive pulse mode on and off.
102       
103       :type: boolean
104
105    .. attribute:: useNegPulseMode
106
107       Flag to turn negative pulse mode on and off.
108       
109       :type: boolean
110
111    .. attribute:: frequency
112
113       The frequency for pulse mode sensors.
114       
115       :type: integer
116
117    .. attribute:: level
118
119       level Option whether to detect level or edge transition when entering a state.
120       It makes a difference only in case of logic state transition (state actuator).
121       A level detector will immediately generate a pulse, negative or positive
122       depending on the sensor condition, as soon as the state is activated.
123       A edge detector will wait for a state change before generating a pulse.
124       note: mutually exclusive with :data:`tap`, enabling will disable :data:`tap`.
125
126       :type: boolean
127
128    .. attribute:: tap
129
130       When enabled only sensors that are just activated will send a positive event, 
131       after this they will be detected as negative by the controllers.
132       This will make a key thats held act as if its only tapped for an instant.
133       note: mutually exclusive with :data:`level`, enabling will disable :data:`level`.
134
135       :type: boolean
136
137    .. attribute:: invert
138
139       Flag to set if this sensor activates on positive or negative events.
140       
141       :type: boolean
142
143    .. attribute:: triggered
144
145       True if this sensor brick is in a positive state. (read-only).
146      
147       :type: boolean
148
149    .. attribute:: positive
150
151       True if this sensor brick is in a positive state. (read-only).
152       
153       :type: boolean
154
155    .. attribute:: status
156
157       The status of the sensor (read-only): can be one of :ref:`these constants<sensor-status>`.
158
159       :type: int
160
161       .. note::
162       
163          This convenient attribute combines the values of triggered and positive attributes.
164
165    .. method:: reset()
166
167       Reset sensor internal state, effect depends on the type of sensor and settings.
168
169       The sensor is put in its initial state as if it was just activated.
170
171 .. class:: SCA_IController(SCA_ILogicBrick)
172
173    Base class for all controller logic bricks.
174
175    .. attribute:: state
176
177       The controllers state bitmask. This can be used with the GameObject's state to test if the controller is active.
178       
179       :type: int bitmask
180
181    .. attribute:: sensors
182
183       A list of sensors linked to this controller.
184       
185       :type: sequence supporting index/string lookups and iteration.
186
187       .. note::
188
189          The sensors are not necessarily owned by the same object.
190
191       .. note::
192          
193          When objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
194
195    .. attribute:: actuators
196
197       A list of actuators linked to this controller.
198       
199       :type: sequence supporting index/string lookups and iteration.
200
201       .. note::
202
203          The sensors are not necessarily owned by the same object.
204
205       .. note::
206          
207          When objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
208
209    .. attribute:: useHighPriority
210
211       When set the controller executes always before all other controllers that dont have this set.
212       
213       :type: boolen
214
215       .. note::
216          
217          Order of execution between high priority controllers is not guaranteed.
218
219 .. class:: SCA_IActuator(SCA_ILogicBrick)
220
221    Base class for all actuator logic bricks.
222
223 .. class:: BL_ActionActuator(SCA_IActuator)
224
225    Action Actuators apply an action to an actor.
226
227    .. attribute:: action
228
229       The name of the action to set as the current action.
230
231       :type: string
232
233    .. attribute:: channelNames
234
235       A list of channel names that may be used with :data:`setChannel` and :data:`getChannel`.
236
237       :type: list of strings
238
239    .. attribute:: frameStart
240
241       Specifies the starting frame of the animation.
242
243       :type: float
244
245    .. attribute:: frameEnd
246
247       Specifies the ending frame of the animation.
248
249       :type: float
250
251    .. attribute:: blendIn
252
253       Specifies the number of frames of animation to generate when making transitions between actions.
254
255       :type: float
256
257    .. attribute:: priority
258
259       Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
260
261       :type: integer
262
263    .. attribute:: frame
264
265       Sets the current frame for the animation.
266
267       :type: float
268
269    .. attribute:: propName
270
271       Sets the property to be used in FromProp playback mode.
272
273       :type: string
274
275    .. attribute:: blendTime
276
277       Sets the internal frame timer. This property must be in the range from 0.0 to blendIn.
278
279       :type: float
280
281    .. attribute:: mode
282
283       The operation mode of the actuator. Can be one of :ref:`these constants<action-actuator>`.
284
285       :type: integer
286
287    .. attribute:: useContinue
288
289       The actions continue option, True or False. When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame.
290
291       :type: boolean
292
293    .. attribute:: framePropName
294
295       The name of the property that is set to the current frame number.
296
297       :type: string
298
299    .. method:: setChannel(channel, matrix)
300
301       Alternative to the 2 arguments, 4 arguments (channel, matrix, loc, size, quat) are also supported.
302
303       :arg channel: A string specifying the name of the bone channel, error raised if not in :data:`channelNames`.
304       :type channel: string
305       :arg matrix: A 4x4 matrix specifying the overriding transformation as an offset from the bone's rest position.
306       :arg  matrix: list [[float]]
307
308       .. note::
309          
310          These values are relative to the bones rest position, currently the api has no way to get this info (which is annoying), but can be worked around by using bones with a rest pose that has no translation.
311
312    .. method:: getChannel(channel)
313
314       :arg channel: A string specifying the name of the bone channel. error raised if not in :data:`channelNames`.
315       :type channel: string
316       :return: (loc, size, quat)
317       :rtype: tuple
318
319 .. class:: BL_Shader(PyObjectPlus)
320
321    BL_Shader GLSL shaders.
322
323    TODO - Description
324
325    .. method:: setUniformfv(name, fList)
326
327       Set a uniform with a list of float values
328
329       :arg name: the uniform name
330       :type name: string
331       :arg fList: a list (2, 3 or 4 elements) of float values
332       :type fList: list[float]
333
334    .. method:: delSource()
335
336       Clear the shader. Use this method before the source is changed with :data:`setSource`.
337
338    .. method:: getFragmentProg()
339
340       Returns the fragment program.
341
342       :return: The fragment program.
343       :rtype: string
344
345    .. method:: getVertexProg()
346
347       Get the vertex program.
348
349       :return: The vertex program.
350       :rtype: string
351
352    .. method:: isValid()
353
354       Check if the shader is valid.
355
356       :return: True if the shader is valid
357       :rtype: boolean
358
359    .. method:: setAttrib(enum)
360
361       Set attribute location. (The parameter is ignored a.t.m. and the value of "tangent" is always used.)
362
363       :arg enum: attribute location value
364       :type enum: integer
365
366    .. method:: setNumberOfPasses( max_pass )
367
368       Set the maximum number of passes. Not used a.t.m.
369
370       :arg max_pass: the maximum number of passes
371       :type max_pass: integer
372
373    .. method:: setSampler(name, index)
374
375       Set uniform texture sample index.
376
377       :arg name: Uniform name
378       :type name: string
379       :arg index: Texture sample index.
380       :type index: integer
381
382    .. method:: setSource(vertexProgram, fragmentProgram)
383
384       Set the vertex and fragment programs
385
386       :arg vertexProgram: Vertex program
387       :type vertexProgram: string
388       :arg fragmentProgram: Fragment program
389       :type fragmentProgram: string
390
391    .. method:: setUniform1f(name, fx)
392
393       Set a uniform with 1 float value.
394
395       :arg name: the uniform name
396       :type name: string
397       :arg fx: Uniform value
398       :type fx: float
399
400    .. method:: setUniform1i(name, ix)
401
402       Set a uniform with an integer value.
403
404       :arg name: the uniform name
405       :type name: string
406       :arg ix: the uniform value
407       :type ix: integer
408
409    .. method:: setUniform2f(name, fx, fy)
410
411       Set a uniform with 2 float values
412
413       :arg name: the uniform name
414       :type name: string
415       :arg fx: first float value
416       :type fx: float
417
418       :arg fy: second float value
419       :type fy: float
420
421    .. method:: setUniform2i(name, ix, iy)
422
423       Set a uniform with 2 integer values
424
425       :arg name: the uniform name
426       :type name: string
427       :arg ix: first integer value
428       :type ix: integer
429       :arg iy: second integer value
430       :type iy: integer
431
432    .. method:: setUniform3f(name, fx, fy, fz)
433
434       Set a uniform with 3 float values.
435
436       :arg name: the uniform name
437       :type name: string
438       :arg fx: first float value
439       :type fx: float
440       :arg fy: second float value
441       :type fy: float
442       :arg fz: third float value
443       :type fz: float
444
445    .. method:: setUniform3i(name, ix, iy, iz)
446
447       Set a uniform with 3 integer values
448
449       :arg name: the uniform name
450       :type name: string
451       :arg ix: first integer value
452       :type ix: integer
453       :arg iy: second integer value
454       :type iy: integer
455       :arg iz: third integer value
456       :type iz: integer
457
458    .. method:: setUniform4f(name, fx, fy, fz, fw)
459
460       Set a uniform with 4 float values.
461
462       :arg name: the uniform name
463       :type name: string
464       :arg fx: first float value
465       :type fx: float
466       :arg fy: second float value
467       :type fy: float
468       :arg fz: third float value
469       :type fz: float
470       :arg fw: fourth float value
471       :type fw: float
472
473    .. method:: setUniform4i(name, ix, iy, iz, iw)
474
475       Set a uniform with 4 integer values
476
477       :arg name: the uniform name
478       :type name: string
479       :arg ix: first integer value
480       :type ix: integer
481       :arg iy: second integer value
482       :type iy: integer
483       :arg iz: third integer value
484       :type iz: integer
485       :arg iw: fourth integer value
486       :type iw: integer
487
488    .. method:: setUniformDef(name, type)
489
490       Define a new uniform
491
492       :arg name: the uniform name
493       :type name: string
494       :arg type: uniform type
495       :type type: UNI_NONE, UNI_INT, UNI_FLOAT, UNI_INT2, UNI_FLOAT2, UNI_INT3, UNI_FLOAT3, UNI_INT4, UNI_FLOAT4, UNI_MAT3, UNI_MAT4, UNI_MAX
496
497    .. method:: setUniformMatrix3(name, mat, transpose)
498
499       Set a uniform with a 3x3 matrix value
500
501       :arg name: the uniform name
502       :type name: string
503       :arg mat: A 3x3 matrix [[f, f, f], [f, f, f], [f, f, f]]
504       :type mat: 3x3 matrix
505       :arg transpose: set to True to transpose the matrix
506       :type transpose: boolean
507
508    .. method:: setUniformMatrix4(name, mat, transpose)
509
510       Set a uniform with a 4x4 matrix value
511
512       :arg name: the uniform name
513       :type name: string
514       :arg mat: A 4x4 matrix [[f, f, f, f], [f, f, f, f], [f, f, f, f], [f, f, f, f]]
515       :type mat: 4x4 matrix
516       :arg transpose: set to True to transpose the matrix
517       :type transpose: boolean
518
519    .. method:: setUniformiv(name, iList)
520
521       Set a uniform with a list of integer values
522
523       :arg name: the uniform name
524       :type name: string
525       :arg iList: a list (2, 3 or 4 elements) of integer values
526       :type iList: list[integer]
527
528    .. method:: validate()
529
530       Validate the shader object.
531
532 .. class:: BL_ShapeActionActuator(SCA_IActuator)
533
534    ShapeAction Actuators apply an shape action to an mesh object.
535
536    .. attribute:: action
537
538       The name of the action to set as the current shape action.
539
540       :type: string
541
542    .. attribute:: frameStart
543
544       Specifies the starting frame of the shape animation.
545
546       :type: float
547
548    .. attribute:: frameEnd
549
550       Specifies the ending frame of the shape animation.
551
552       :type: float
553
554    .. attribute:: blendIn
555
556       Specifies the number of frames of animation to generate when making transitions between actions.
557
558       :type: float
559
560    .. attribute:: priority
561
562       Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
563
564       :type: integer
565
566    .. attribute:: frame
567
568       Sets the current frame for the animation.
569
570       :type: float
571
572    .. attribute:: propName
573
574       Sets the property to be used in FromProp playback mode.
575
576       :type: string
577
578    .. attribute:: blendTime
579
580       Sets the internal frame timer. This property must be in the range from 0.0 to blendin.
581
582       :type: float
583
584    .. attribute:: mode
585
586       The operation mode of the actuator. Can be one of :ref:`these constants<shape-action-actuator>`.
587
588       :type: integer
589
590    .. attribute:: framePropName
591
592       The name of the property that is set to the current frame number.
593
594       :type: string
595
596 .. class:: CListValue(CPropValue)
597
598    This is a list like object used in the game engine internally that behaves similar to a python list in most ways.
599
600    As well as the normal index lookup (``val= clist[i]``), CListValue supports string lookups (``val= scene.objects["Cube"]``)
601
602    Other operations such as ``len(clist)``, ``list(clist)``, ``clist[0:10]`` are also supported.
603
604    .. method:: append(val)
605
606       Add an item to the list (like pythons append)
607
608       .. warning::
609       
610          Appending values to the list can cause crashes when the list is used internally by the game engine.
611
612    .. method:: count(val)
613
614       Count the number of instances of a value in the list.
615
616       :return: number of instances
617       :rtype: integer
618
619    .. method:: index(val)
620
621       Return the index of a value in the list.
622
623       :return: The index of the value in the list.
624       :rtype: integer
625
626    .. method:: reverse()
627
628       Reverse the order of the list.
629
630    .. method:: get(key, default=None)
631
632       Return the value matching key, or the default value if its not found.
633
634       :return: The key value or a default.
635
636    .. method:: from_id(id)
637
638       This is a funtion especially for the game engine to return a value with a spesific id.
639
640       Since object names are not always unique, the id of an object can be used to get an object from the CValueList.
641
642       Example:
643
644       .. code-block:: python
645         
646          myObID=id(gameObject)
647          ob= scene.objects.from_id(myObID)
648
649       Where ``myObID`` is an int or long from the id function.
650
651       This has the advantage that you can store the id in places you could not store a gameObject.
652
653       .. warning::
654
655          The id is derived from a memory location and will be different each time the game engine starts.
656
657 .. class:: KX_BlenderMaterial(PyObjectPlus)
658
659    KX_BlenderMaterial
660
661    .. method:: getShader()
662
663       Returns the material's shader.
664
665       :return: the material's shader
666       :rtype: :class:`BL_Shader`
667
668    .. method:: setBlending(src, dest)
669
670       Set the pixel color arithmetic functions.
671
672       :arg src: Specifies how the red, green, blue, and alpha source blending factors are computed.
673       :type src: Value in...
674
675          * GL_ZERO,
676          * GL_ONE, 
677          * GL_SRC_COLOR, 
678          * GL_ONE_MINUS_SRC_COLOR, 
679          * GL_DST_COLOR, 
680          * GL_ONE_MINUS_DST_COLOR, 
681          * GL_SRC_ALPHA, 
682          * GL_ONE_MINUS_SRC_ALPHA, 
683          * GL_DST_ALPHA, 
684          * GL_ONE_MINUS_DST_ALPHA, 
685          * GL_SRC_ALPHA_SATURATE
686
687       :arg dest: Specifies how the red, green, blue, and alpha destination blending factors are computed.
688       :type dest: Value in...
689
690          * GL_ZERO
691          * GL_ONE
692          * GL_SRC_COLOR
693          * GL_ONE_MINUS_SRC_COLOR
694          * GL_DST_COLOR
695          * GL_ONE_MINUS_DST_COLOR
696          * GL_SRC_ALPHA
697          * GL_ONE_MINUS_SRC_ALPHA
698          * GL_DST_ALPHA
699          * GL_ONE_MINUS_DST_ALPHA
700          * GL_SRC_ALPHA_SATURATE
701
702    .. method:: getMaterialIndex()
703
704       Returns the material's index.
705
706       :return: the material's index
707       :rtype: integer
708
709 .. class:: KX_CameraActuator(SCA_IActuator)
710
711    Applies changes to a camera.
712
713    .. attribute:: damping
714
715       strength of of the camera following movement.
716
717       :type: float
718    
719    .. attribute:: min
720
721       minimum distance to the target object maintained by the actuator.
722
723       :type: float
724
725    .. attribute:: max
726
727       maximum distance to stay from the target object.
728
729       :type: float
730
731    .. attribute:: height
732
733       height to stay above the target object.
734
735       :type: float
736
737    .. attribute:: useXY
738
739       axis this actuator is tracking, True=X, False=Y.
740
741       :type: boolean
742
743    .. attribute:: object
744
745       the object this actuator tracks.
746
747       :type: :class:`KX_GameObject` or None
748
749 .. class:: KX_ConstraintActuator(SCA_IActuator)
750
751    A constraint actuator limits the position, rotation, distance or orientation of an object.
752
753    .. attribute:: damp
754
755       Time constant of the constraint expressed in frame (not use by Force field constraint).
756
757       :type: integer
758
759    .. attribute:: rotDamp
760
761       Time constant for the rotation expressed in frame (only for the distance constraint), 0 = use damp for rotation as well.
762
763       :type: integer
764
765    .. attribute:: direction
766
767       The reference direction in world coordinate for the orientation constraint.
768
769       :type: 3-tuple of float: (x, y, z)
770
771    .. attribute:: option
772
773       Binary combination of :ref:`these constants <constraint-actuator-option>`
774
775       :type: integer
776
777    .. attribute:: time
778
779       activation time of the actuator. The actuator disables itself after this many frame. If set to 0, the actuator is not limited in time.
780
781       :type: integer
782
783    .. attribute:: propName
784
785       the name of the property or material for the ray detection of the distance constraint.
786
787       :type: string
788
789    .. attribute:: min
790
791       The lower bound of the constraint. For the rotation and orientation constraint, it represents radiant.
792
793       :type: float
794
795    .. attribute:: distance
796
797       the target distance of the distance constraint.
798
799       :type: float
800
801    .. attribute:: max
802
803       the upper bound of the constraint. For rotation and orientation constraints, it represents radiant.
804
805       :type: float
806
807    .. attribute:: rayLength
808
809       the length of the ray of the distance constraint.
810
811       :type: float
812
813    .. attribute:: limit
814
815       type of constraint. Use one of the :ref:`these constants <constraint-actuator-limit>`
816
817       :type: integer.
818
819       
820 .. class:: KX_ConstraintWrapper(PyObjectPlus)
821
822    KX_ConstraintWrapper
823
824    .. method:: getConstraintId(val)
825
826       Returns the contraint's ID
827
828       :return: the constraint's ID
829       :rtype: integer
830
831 .. class:: KX_GameActuator(SCA_IActuator)
832
833    The game actuator loads a new .blend file, restarts the current .blend file or quits the game.
834
835    .. attribute:: fileName
836
837       the new .blend file to load.
838
839       :type: string
840
841    .. attribute:: mode
842
843       The mode of this actuator. Can be on of :ref:`these constants <game-actuator>`
844
845       :type: Int
846
847 .. class:: KX_GameObject(SCA_IObject)
848
849    All game objects are derived from this class.
850
851    Properties assigned to game objects are accessible as attributes of this class.
852
853    .. note::
854       
855       Calling ANY method or attribute on an object that has been removed from a scene will raise a SystemError, if an object may have been removed since last accessing it use the :data:`invalid` attribute to check.
856
857    .. attribute:: name
858
859       The object's name. (read-only).
860
861       :type: string
862
863    .. attribute:: mass
864
865       The object's mass
866
867       :type: float
868
869       .. note::
870          
871          The object must have a physics controller for the mass to be applied, otherwise the mass value will be returned as 0.0.
872       
873    .. attribute:: linVelocityMin
874
875       Enforces the object keeps moving at a minimum velocity.
876
877       :type: float
878       
879       .. note::
880       
881          Applies to dynamic and rigid body objects only.
882
883       .. note::
884          
885          A value of 0.0 disables this option.
886
887       .. note::
888       
889          While objects are stationary the minimum velocity will not be applied.
890
891    .. attribute:: linVelocityMax
892
893       Clamp the maximum linear velocity to prevent objects moving beyond a set speed.
894
895       :type: float
896       
897       .. note::
898          
899          Applies to dynamic and rigid body objects only.
900
901       .. note::
902
903          A value of 0.0 disables this option (rather then setting it stationary).
904
905    .. attribute:: localInertia
906
907       the object's inertia vector in local coordinates. Read only.
908
909       :type: list [ix, iy, iz]
910
911    .. attribute:: parent
912
913       The object's parent object. (read-only).
914
915       :type: :class:`KX_GameObject` or None
916
917    .. attribute:: visible
918
919       visibility flag.
920
921       :type: boolean
922       
923       .. note::
924       
925          Game logic will still run for invisible objects.
926
927    .. attribute:: color
928
929       The object color of the object. [r, g, b, a]
930
931       :type: :class:`mathutils.Vector`
932
933    .. attribute:: occlusion
934
935       occlusion capability flag.
936
937       :type: boolean
938
939    .. attribute:: position
940
941       The object's position. [x, y, z] On write: local position, on read: world position
942
943       .. deprecated:: use :data:`localPosition` and :data:`worldPosition`.
944
945       :type: :class:`mathurils.Vector`
946
947    .. attribute:: orientation
948
949       The object's orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector. On write: local orientation, on read: world orientation
950
951       .. deprecated:: use :data:`localOrientation` and :data:`worldOrientation`.
952
953       :type: :class:`mathutils.Matrix`
954
955    .. attribute:: scaling
956
957       The object's scaling factor. [sx, sy, sz] On write: local scaling, on read: world scaling
958
959       .. deprecated:: use :data:`localScale` and :data:`worldScale`.
960
961       :type: :class:`mathutils.Vector`
962
963    .. attribute:: localOrientation
964
965       The object's local orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector.
966
967       :type: :class:`mathutils.Matrix`
968
969    .. attribute:: worldOrientation
970
971       The object's world orientation. 3x3 Matrix.
972
973       :type: :class:`mathutils.Matrix`
974
975    .. attribute:: localScale
976
977       The object's local scaling factor. [sx, sy, sz]
978
979       :type: :class:`mathutils.Vector`
980
981    .. attribute:: worldScale
982
983       The object's world scaling factor. Read-only. [sx, sy, sz]
984
985       :type: :class:`mathutils.Vector`
986
987    .. attribute:: localPosition
988
989       The object's local position. [x, y, z]
990
991       :type: :class:`mathutils.Vector`
992
993    .. attribute:: worldPosition
994
995       The object's world position. [x, y, z]
996
997       :type: :class:`mathutils.Vector`
998           
999    .. attribute:: localLinearVelocity
1000       
1001           The object's local linear velocity. [x, y, z]
1002           
1003           :type: :class:`mathutils.Vector`
1004           
1005    .. attribute:: worldLinearVelocity
1006    
1007       The object's world linear velocity. [x, y, z]
1008           
1009           :type: :class:`mathutils.Vector`
1010           
1011    .. attribute:: localAngularVelocity
1012    
1013       The object's local angular velocity. [x, y, z]
1014           
1015           :type: :class:`mathutils.Vector`
1016           
1017    .. attribute:: worldAngularVelocity
1018    
1019       The object's world angular velocity. [x, y, z]
1020           
1021           :type: :class:`mathutils.Vector`
1022
1023    .. attribute:: timeOffset
1024
1025       adjust the slowparent delay at runtime.
1026
1027       :type: float
1028
1029    .. attribute:: state
1030
1031       the game object's state bitmask, using the first 30 bits, one bit must always be set.
1032
1033       :type: int
1034
1035    .. attribute:: meshes
1036
1037       a list meshes for this object.
1038
1039       :type: list of :class:`KX_MeshProxy`
1040       
1041       .. note::
1042          
1043          Most objects use only 1 mesh.
1044
1045       .. note::
1046          
1047          Changes to this list will not update the KX_GameObject.
1048
1049    .. attribute:: sensors
1050
1051       a sequence of :class:`SCA_ISensor` objects with string/index lookups and iterator support.
1052
1053       :type: list
1054       
1055       .. note::
1056          
1057          This attribute is experemental and may be removed (but probably wont be).
1058
1059       .. note::
1060       
1061          Changes to this list will not update the KX_GameObject.
1062
1063    .. attribute:: controllers
1064
1065       a sequence of :class:`SCA_IController` objects with string/index lookups and iterator support.
1066
1067       :type: list of :class:`SCA_ISensor`
1068       
1069       .. note::
1070          
1071          This attribute is experemental and may be removed (but probably wont be).
1072
1073       .. note::
1074          
1075          Changes to this list will not update the KX_GameObject.
1076
1077    .. attribute:: actuators
1078
1079       a list of :class:`SCA_IActuator` with string/index lookups and iterator support.
1080
1081       :type: list
1082       
1083       .. note::
1084
1085          This attribute is experemental and may be removed (but probably wont be).
1086
1087       .. note::
1088
1089          Changes to this list will not update the KX_GameObject.
1090
1091    .. attribute:: attrDict
1092
1093       get the objects internal python attribute dictionary for direct (faster) access.
1094
1095       :type: dict
1096
1097    .. attribute:: children
1098
1099       direct children of this object, (read-only).
1100
1101       :type: :class:`CListValue` of :class:`KX_GameObject`'s
1102
1103    .. attribute:: childrenRecursive
1104
1105       all children of this object including childrens children, (read-only).
1106
1107       :type: :class:`CListValue` of :class:`KX_GameObject`'s
1108
1109    .. method:: endObject()
1110
1111       Delete this object, can be used in place of the EndObject Actuator.
1112
1113       The actual removal of the object from the scene is delayed.
1114
1115    .. method:: replaceMesh(mesh, useDisplayMesh=True, usePhysicsMesh=False)
1116
1117       Replace the mesh of this object with a new mesh. This works the same was as the actuator.
1118
1119       :arg mesh: mesh to replace or the meshes name.
1120       :type mesh: :class:`MeshProxy` or string
1121       :arg useDisplayMesh: when enabled the display mesh will be replaced (optional argument).
1122       :type useDisplayMesh: boolean
1123       :arg usePhysicsMesh: when enabled the physics mesh will be replaced (optional argument).
1124       :type usePhysicsMesh: boolean
1125
1126    .. method:: setVisible(visible, recursive)
1127
1128       Sets the game object's visible flag.
1129
1130       :arg visible: the visible state to set.
1131       :type visible: boolean
1132       :arg recursive: optional argument to set all childrens visibility flag too.
1133       :type recursive: boolean
1134
1135    .. method:: setOcclusion(occlusion, recursive)
1136
1137       Sets the game object's occlusion capability.
1138
1139       :arg occlusion: the state to set the occlusion to.
1140       :type occlusion: boolean
1141       :arg recursive: optional argument to set all childrens occlusion flag too.
1142       :type recursive: boolean
1143
1144    .. method:: alignAxisToVect(vect, axis=2, factor=1.0)
1145
1146       Aligns any of the game object's axis along the given vector.
1147
1148
1149       :arg vect: a vector to align the axis.
1150       :type vect: 3D vector
1151       :arg axis: The axis you want to align
1152
1153          * 0: X axis
1154          * 1: Y axis
1155          * 2: Z axis
1156
1157       :type axis: integer
1158       :arg factor: Only rotate a feaction of the distance to the target vector (0.0 - 1.0)
1159       :type factor: float
1160
1161    .. method:: getAxisVect(vect)
1162
1163       Returns the axis vector rotates by the objects worldspace orientation.
1164       This is the equivalent of multiplying the vector by the orientation matrix.
1165
1166       :arg vect: a vector to align the axis.
1167       :type vect: 3D Vector
1168       :return: The vector in relation to the objects rotation.
1169       :rtype: 3d vector.
1170
1171    .. method:: applyMovement(movement, local=False)
1172
1173       Sets the game object's movement.
1174
1175       :arg movement: movement vector.
1176       :type movement: 3D Vector
1177       :arg local:
1178          * False: you get the "global" movement ie: relative to world orientation.
1179          * True: you get the "local" movement ie: relative to object orientation.
1180       :arg local: boolean
1181
1182    .. method:: applyRotation(rotation, local=False)
1183
1184       Sets the game object's rotation.
1185
1186       :arg rotation: rotation vector.
1187       :type rotation: 3D Vector
1188       :arg local:
1189          * False: you get the "global" rotation ie: relative to world orientation.
1190          * True: you get the "local" rotation ie: relative to object orientation.
1191       :arg local: boolean
1192
1193    .. method:: applyForce(force, local=False)
1194
1195       Sets the game object's force.
1196
1197       This requires a dynamic object.
1198
1199       :arg force: force vector.
1200       :type force: 3D Vector
1201       :arg local:
1202          * False: you get the "global" force ie: relative to world orientation.
1203          * True: you get the "local" force ie: relative to object orientation.
1204       :type local: boolean
1205
1206    .. method:: applyTorque(torque, local=False)
1207
1208       Sets the game object's torque.
1209
1210       This requires a dynamic object.
1211
1212       :arg torque: torque vector.
1213       :type torque: 3D Vector
1214       :arg local:
1215          * False: you get the "global" torque ie: relative to world orientation.
1216          * True: you get the "local" torque ie: relative to object orientation.
1217       :type local: boolean
1218
1219    .. method:: getLinearVelocity(local=False)
1220
1221       Gets the game object's linear velocity.
1222
1223       This method returns the game object's velocity through it's centre of mass, ie no angular velocity component.
1224
1225       :arg local:
1226          * False: you get the "global" velocity ie: relative to world orientation.
1227          * True: you get the "local" velocity ie: relative to object orientation.
1228       :type local: boolean
1229       :return: the object's linear velocity.
1230       :rtype: list [vx, vy, vz]
1231
1232    .. method:: setLinearVelocity(velocity, local=False)
1233
1234       Sets the game object's linear velocity.
1235
1236       This method sets game object's velocity through it's centre of mass, 
1237       ie no angular velocity component.
1238
1239       This requires a dynamic object.
1240
1241       :arg velocity: linear velocity vector.
1242       :type velocity: 3D Vector
1243       :arg local:
1244          * False: you get the "global" velocity ie: relative to world orientation.
1245          * True: you get the "local" velocity ie: relative to object orientation.
1246       :type local: boolean
1247
1248    .. method:: getAngularVelocity(local=False)
1249
1250       Gets the game object's angular velocity.
1251
1252       :arg local:
1253          * False: you get the "global" velocity ie: relative to world orientation.
1254          * True: you get the "local" velocity ie: relative to object orientation.
1255       :type local: boolean
1256       :return: the object's angular velocity.
1257       :rtype: list [vx, vy, vz]
1258
1259    .. method:: setAngularVelocity(velocity, local=False)
1260
1261       Sets the game object's angular velocity.
1262
1263       This requires a dynamic object.
1264
1265       :arg velocity: angular velocity vector.
1266       :type velocity: boolean
1267       :arg local:
1268          * False: you get the "global" velocity ie: relative to world orientation.
1269          * True: you get the "local" velocity ie: relative to object orientation.
1270
1271    .. method:: getVelocity(point=(0, 0, 0))
1272
1273       Gets the game object's velocity at the specified point.
1274
1275       Gets the game object's velocity at the specified point, including angular
1276       components.
1277
1278       :arg point: optional point to return the velocity for, in local coordinates.
1279       :type point: 3D Vector
1280       :return: the velocity at the specified point.
1281       :rtype: list [vx, vy, vz]
1282
1283    .. method:: getReactionForce()
1284
1285       Gets the game object's reaction force.
1286
1287       The reaction force is the force applied to this object over the last simulation timestep.
1288       This also includes impulses, eg from collisions.
1289
1290       :return: the reaction force of this object.
1291       :rtype: list [fx, fy, fz]
1292
1293       .. note::
1294
1295          This is not implimented at the moment.
1296
1297    .. method:: applyImpulse(point, impulse)
1298
1299       Applies an impulse to the game object.
1300
1301       This will apply the specified impulse to the game object at the specified point.
1302       If point != position, applyImpulse will also change the object's angular momentum.
1303       Otherwise, only linear momentum will change.
1304
1305       :arg point: the point to apply the impulse to (in world coordinates)
1306       :type point: the point to apply the impulse to (in world coordinates)
1307
1308    .. method:: suspendDynamics()
1309
1310       Suspends physics for this object.
1311
1312    .. method:: restoreDynamics()
1313
1314       Resumes physics for this object.
1315
1316       .. note::
1317          
1318          The objects linear velocity will be applied from when the dynamics were suspended.
1319
1320    .. method:: enableRigidBody()
1321
1322       Enables rigid body physics for this object.
1323
1324       Rigid body physics allows the object to roll on collisions.
1325
1326       .. note::
1327          
1328          This is not working with bullet physics yet.
1329
1330    .. method:: disableRigidBody()
1331
1332       Disables rigid body physics for this object.
1333
1334       .. note::
1335
1336          This is not working with bullet physics yet. The angular is removed but rigid body physics can still rotate it later.
1337
1338    .. method:: setParent(parent, compound=True, ghost=True)
1339
1340       Sets this object's parent.
1341       Control the shape status with the optional compound and ghost parameters:
1342
1343       In that case you can control if it should be ghost or not:
1344
1345       :arg parent: new parent object.
1346       :type parent: :class:`KX_GameObject`
1347       :arg compound: whether the shape should be added to the parent compound shape.
1348
1349          * True: the object shape should be added to the parent compound shape.
1350          * False: the object should keep its individual shape.
1351
1352       :type compound: boolean
1353       :arg ghost: whether the object should be ghost while parented.
1354
1355          * True: if the object should be made ghost while parented.
1356          * False: if the object should be solid while parented.
1357
1358       :type ghost: boolean
1359
1360       .. note::
1361       
1362          If the object type is sensor, it stays ghost regardless of ghost parameter
1363
1364    .. method:: removeParent()
1365
1366       Removes this objects parent.
1367
1368    .. method:: getPhysicsId()
1369
1370       Returns the user data object associated with this game object's physics controller.
1371
1372    .. method:: getPropertyNames()
1373
1374       Gets a list of all property names.
1375
1376       :return: All property names for this object.
1377       :rtype: list
1378
1379    .. method:: getDistanceTo(other)
1380
1381       :arg other: a point or another :class:`KX_GameObject` to measure the distance to.
1382       :type other: :class:`KX_GameObject` or list [x, y, z]
1383       :return: distance to another object or point.
1384       :rtype: float
1385
1386    .. method:: getVectTo(other)
1387
1388       Returns the vector and the distance to another object or point.
1389       The vector is normalized unless the distance is 0, in which a zero length vector is returned.
1390
1391       :arg other: a point or another :class:`KX_GameObject` to get the vector and distance to.
1392       :type other: :class:`KX_GameObject` or list [x, y, z]
1393       :return: (distance, globalVector(3), localVector(3))
1394       :rtype: 3-tuple (float, 3-tuple (x, y, z), 3-tuple (x, y, z))
1395
1396    .. method:: rayCastTo(other, dist, prop)
1397
1398       Look towards another point/object and find first object hit within dist that matches prop.
1399
1400       The ray is always casted from the center of the object, ignoring the object itself.
1401       The ray is casted towards the center of another object or an explicit [x, y, z] point.
1402       Use rayCast() if you need to retrieve the hit point
1403
1404       :arg other: [x, y, z] or object towards which the ray is casted
1405       :type other: :class:`KX_GameObject` or 3-tuple
1406       :arg dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
1407       :type dist: float
1408       :arg prop: property name that object must have; can be omitted => detect any object
1409       :type prop: string
1410       :return: the first object hit or None if no object or object does not match prop
1411       :rtype: :class:`KX_GameObject`
1412
1413    .. method:: rayCast(objto, objfrom, dist, prop, face, xray, poly)
1414
1415       Look from a point/object to another point/object and find first object hit within dist that matches prop.
1416       if poly is 0, returns a 3-tuple with object reference, hit point and hit normal or (None, None, None) if no hit.
1417       if poly is 1, returns a 4-tuple with in addition a :class:`KX_PolyProxy` as 4th element.
1418       if poly is 2, returns a 5-tuple with in addition a 2D vector with the UV mapping of the hit point as 5th element.
1419
1420       .. code-block:: python
1421
1422          # shoot along the axis gun-gunAim (gunAim should be collision-free)
1423          obj, point, normal = gun.rayCast(gunAim, None, 50)
1424          if obj:
1425             # do something
1426             pass
1427
1428       The face paremeter determines the orientation of the normal.
1429
1430       * 0 => hit normal is always oriented towards the ray origin (as if you casted the ray from outside)
1431       * 1 => hit normal is the real face normal (only for mesh object, otherwise face has no effect)
1432
1433       The ray has X-Ray capability if xray parameter is 1, otherwise the first object hit (other than self object) stops the ray.
1434       The prop and xray parameters interact as follow.
1435
1436       * prop off, xray off: return closest hit or no hit if there is no object on the full extend of the ray.
1437       * prop off, xray on : idem.
1438       * prop on, xray off: return closest hit if it matches prop, no hit otherwise.
1439       * prop on, xray on : return closest hit matching prop or no hit if there is no object matching prop on the full extend of the ray.
1440
1441       The :class:`KX_PolyProxy` 4th element of the return tuple when poly=1 allows to retrieve information on the polygon hit by the ray.
1442       If there is no hit or the hit object is not a static mesh, None is returned as 4th element.
1443
1444       The ray ignores collision-free objects and faces that dont have the collision flag enabled, you can however use ghost objects.
1445
1446       :arg objto: [x, y, z] or object to which the ray is casted
1447       :type objto: :class:`KX_GameObject` or 3-tuple
1448       :arg objfrom: [x, y, z] or object from which the ray is casted; None or omitted => use self object center
1449       :type objfrom: :class:`KX_GameObject` or 3-tuple or None
1450       :arg dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to to
1451       :type dist: float
1452       :arg prop: property name that object must have; can be omitted or "" => detect any object
1453       :type prop: string
1454       :arg face: normal option: 1=>return face normal; 0 or omitted => normal is oriented towards origin
1455       :type face: integer
1456       :arg xray: X-ray option: 1=>skip objects that don't match prop; 0 or omitted => stop on first object
1457       :type xray: integer
1458       :arg poly: polygon option: 0, 1 or 2 to return a 3-, 4- or 5-tuple with information on the face hit.
1459
1460          * 0 or omitted: return value is a 3-tuple (object, hitpoint, hitnormal) or (None, None, None) if no hit
1461          * 1: return value is a 4-tuple and the 4th element is a :class:`KX_PolyProxy` or None if no hit or the object doesn't use a mesh collision shape.
1462          * 2: return value is a 5-tuple and the 5th element is a 2-tuple (u, v) with the UV mapping of the hit point or None if no hit, or the object doesn't use a mesh collision shape, or doesn't have a UV mapping.
1463
1464       :type poly: integer
1465       :return: (object, hitpoint, hitnormal) or (object, hitpoint, hitnormal, polygon) or (object, hitpoint, hitnormal, polygon, hituv).
1466
1467          * object, hitpoint and hitnormal are None if no hit.
1468          * polygon is valid only if the object is valid and is a static object, a dynamic object using mesh collision shape or a soft body object, otherwise it is None
1469          * hituv is valid only if polygon is valid and the object has a UV mapping, otherwise it is None
1470
1471       :rtype:
1472
1473          * 3-tuple (:class:`KX_GameObject`, 3-tuple (x, y, z), 3-tuple (nx, ny, nz))
1474          * or 4-tuple (:class:`KX_GameObject`, 3-tuple (x, y, z), 3-tuple (nx, ny, nz), :class:`PolyProxy`)
1475          * or 5-tuple (:class:`KX_GameObject`, 3-tuple (x, y, z), 3-tuple (nx, ny, nz), :class:`PolyProxy`, 2-tuple (u, v))
1476
1477       .. note::
1478       
1479          The ray ignores the object on which the method is called. It is casted from/to object center or explicit [x, y, z] points.
1480
1481    .. method:: setCollisionMargin(margin)
1482
1483       Set the objects collision margin.
1484
1485       :arg margin: the collision margin distance in blender units.
1486       :type margin: float
1487
1488       .. note::
1489       
1490          If this object has no physics controller (a physics ID of zero), this function will raise RuntimeError.
1491
1492    .. method:: sendMessage(subject, body="", to="")
1493
1494       Sends a message.
1495
1496       :arg subject: The subject of the message
1497       :type subject: string
1498       :arg body: The body of the message (optional)
1499       :type body: string
1500       :arg to: The name of the object to send the message to (optional)
1501       :type to: string
1502
1503    .. method:: reinstancePhysicsMesh(gameObject, meshObject)
1504
1505       Updates the physics system with the changed mesh.
1506
1507       If no arguments are given the physics mesh will be re-created from the first mesh assigned to the game object.
1508
1509       :arg gameObject: optional argument, set the physics shape from this gameObjets mesh.
1510       :type gameObject: string, :class:`KX_GameObject` or None
1511       :arg meshObject: optional argument, set the physics shape from this mesh.
1512       :type meshObject: string, :class:`MeshProxy` or None
1513
1514       :return: True if reinstance succeeded, False if it failed.
1515       :rtype: boolean
1516
1517       .. note::
1518
1519          If this object has instances the other instances will be updated too.
1520       
1521       .. note::
1522
1523          The gameObject argument has an advantage that it can convert from a mesh with modifiers applied (such as subsurf).
1524       
1525       .. warning::
1526
1527          Only triangle mesh type objects are supported currently (not convex hull)
1528
1529       .. warning::
1530
1531          If the object is a part of a combound object it will fail (parent or child)
1532
1533       .. warning::
1534
1535          Rebuilding the physics mesh can be slow, running many times per second will give a performance hit.
1536
1537    .. method:: get(key, default=None)
1538
1539       Return the value matching key, or the default value if its not found.
1540       :return: The key value or a default.
1541
1542    .. method:: playAction(name, start_frame, end_frame, layer=0, priority=0 blendin=0, play_mode=ACT_MODE_PLAY, layer_weight=0.0, ipo_flags=0, speed=1.0)
1543
1544       Plays an action.
1545           
1546       :arg name: the name of the action
1547           :type name: string
1548       :arg start: the start frame of the action
1549           :type start: float
1550       :arg end: the end frame of the action
1551           :type end: float
1552       :arg layer: the layer the action will play in (actions in different layers are added/blended together)
1553           :type layer: integer
1554       :arg priority: only play this action if there isn't an action currently playing in this layer with a higher (lower number) priority
1555           :type priority: integer
1556       :arg blendin: the amount of blending between this animation and the previous one on this layer
1557           :type blendin: float
1558       :arg play_mode: the play mode
1559           :type play_mode: KX_ACTION_PLAY, KX_ACTION_LOOP, or KX_ACTION_PING_PONG
1560       :arg layer_weight: how much of the previous layer to use for blending (0 = add)
1561           :type layer_weight: float
1562       :arg ipo_flags: flags for the old IPO behaviors (force, etc)
1563           :type ipo_flags: int bitfield
1564       :arg speed: the playback speed of the action as a factor (1.0 = normal speed, 2.0 = 2x speed, etc)
1565           :type speed: float
1566
1567    .. method:: stopAction(layer=0)
1568       
1569           Stop playing the action on the given layer.
1570           
1571           :arg layer: The layer to stop playing.
1572           :type layer: integer
1573           
1574    .. method:: getActionFrame(layer=0)
1575    
1576       Gets the current frame of the action playing in the supplied layer.
1577           
1578           :arg layer: The layer that you want to get the frame from.
1579           :type layer: integer
1580           
1581           :return: The current frame of the action
1582           
1583    .. method:: setActionFrame(frame, layer=0)
1584    
1585       Set the current frame of the action playing in the supplied layer.
1586           
1587           :arg layer: The layer where you want to set the frame
1588           :type layer: integer
1589           :arg frame: The frame to set the action to
1590           :type frame: float
1591
1592    .. method:: isPlayingAction(layer=0)
1593    
1594        Checks to see if there is an action playing in the given layer.
1595            
1596            :arg layer: The layer to check for a playing action.
1597            :type layer: integer
1598
1599 .. class:: KX_IpoActuator(SCA_IActuator)
1600
1601    IPO actuator activates an animation.
1602
1603    .. attribute:: frameStart
1604
1605       Start frame.
1606
1607       :type: float
1608
1609    .. attribute:: frameEnd
1610
1611       End frame.
1612
1613       :type: float
1614
1615    .. attribute:: propName
1616
1617       Use this property to define the Ipo position.
1618
1619       :type: string
1620
1621    .. attribute:: framePropName
1622
1623       Assign this property this action current frame number.
1624
1625       :type: string
1626
1627    .. attribute:: mode
1628
1629       Play mode for the ipo. Can be on of :ref:`these constants <ipo-actuator>`
1630
1631       :type: integer
1632
1633    .. attribute:: useIpoAsForce
1634
1635       Apply Ipo as a global or local force depending on the local option (dynamic objects only).
1636
1637       :type: boolean
1638
1639    .. attribute:: useIpoAdd
1640
1641       Ipo is added to the current loc/rot/scale in global or local coordinate according to Local flag.
1642
1643       :type: boolean
1644
1645    .. attribute:: useIpoLocal
1646
1647       Let the ipo acts in local coordinates, used in Force and Add mode.
1648
1649       :type: boolean
1650
1651    .. attribute:: useChildren
1652
1653       Update IPO on all children Objects as well.
1654
1655       :type: boolean
1656
1657 .. class:: KX_LightObject(KX_GameObject)
1658
1659    A Light object.
1660
1661    .. code-block:: python
1662
1663       # Turn on a red alert light.
1664       import bge
1665
1666       co = bge.logic.getCurrentController()
1667       light = co.owner
1668
1669       light.energy = 1.0
1670       light.colour = [1.0, 0.0, 0.0]
1671
1672    .. data:: SPOT
1673
1674       A spot light source. See attribute :data:`type`
1675
1676    .. data:: SUN
1677
1678       A point light source with no attenuation. See attribute :data:`type`
1679
1680    .. data:: NORMAL
1681
1682       A point light source. See attribute :data:`type`
1683
1684    .. attribute:: type
1685
1686       The type of light - must be SPOT, SUN or NORMAL
1687
1688    .. attribute:: layer
1689
1690       The layer mask that this light affects object on.
1691
1692       :type: bitfield
1693
1694    .. attribute:: energy
1695
1696       The brightness of this light.
1697
1698       :type: float
1699
1700    .. attribute:: distance
1701
1702       The maximum distance this light can illuminate. (SPOT and NORMAL lights only).
1703
1704       :type: float
1705
1706    .. attribute:: colour
1707
1708       The colour of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
1709
1710       :type: list [r, g, b]
1711
1712    .. attribute:: color
1713
1714       Synonym for colour.
1715
1716    .. attribute:: lin_attenuation
1717
1718       The linear component of this light's attenuation. (SPOT and NORMAL lights only).
1719
1720       :type: float
1721
1722    .. attribute:: quad_attenuation
1723
1724       The quadratic component of this light's attenuation (SPOT and NORMAL lights only).
1725
1726       :type: float
1727
1728    .. attribute:: spotsize
1729
1730       The cone angle of the spot light, in degrees (SPOT lights only).
1731
1732       :type: float in [0 - 180].
1733
1734    .. attribute:: spotblend
1735
1736       Specifies the intensity distribution of the spot light (SPOT lights only).
1737
1738       :type: float in [0 - 1]
1739
1740       .. note::
1741          
1742          Higher values result in a more focused light source.
1743
1744 .. class:: KX_MeshProxy(SCA_IObject)
1745
1746    A mesh object.
1747
1748    You can only change the vertex properties of a mesh object, not the mesh topology.
1749
1750    To use mesh objects effectively, you should know a bit about how the game engine handles them.
1751
1752    #. Mesh Objects are converted from Blender at scene load.
1753    #. The Converter groups polygons by Material.  This means they can be sent to the renderer efficiently.  A material holds:
1754
1755       #. The texture.
1756       #. The Blender material.
1757       #. The Tile properties
1758       #. The face properties - (From the "Texture Face" panel)
1759       #. Transparency & z sorting
1760       #. Light layer
1761       #. Polygon shape (triangle/quad)
1762       #. Game Object
1763
1764    #. Verticies will be split by face if necessary.  Verticies can only be shared between faces if:
1765
1766       #. They are at the same position
1767       #. UV coordinates are the same
1768       #. Their normals are the same (both polygons are "Set Smooth")
1769       #. They are the same colour, for example: a cube has 24 verticies: 6 faces with 4 verticies per face.
1770
1771    The correct method of iterating over every :class:`KX_VertexProxy` in a game object
1772    
1773    .. code-block:: python
1774
1775       import GameLogic
1776
1777       co = GameLogic.getCurrentController()
1778       obj = co.owner
1779
1780       m_i = 0
1781       mesh = obj.getMesh(m_i) # There can be more than one mesh...
1782       while mesh != None:
1783          for mat in range(mesh.getNumMaterials()):
1784             for v_index in range(mesh.getVertexArrayLength(mat)):
1785                vertex = mesh.getVertex(mat, v_index)
1786                # Do something with vertex here...
1787                # ... eg: colour the vertex red.
1788                vertex.colour = [1.0, 0.0, 0.0, 1.0]
1789          m_i += 1
1790          mesh = obj.getMesh(m_i)
1791
1792    .. attribute:: materials
1793
1794       :type: list of :class:`KX_BlenderMaterial` or :class:`KX_PolygonMaterial` types
1795
1796    .. attribute:: numPolygons
1797
1798       :type: integer
1799
1800    .. attribute:: numMaterials
1801
1802       :type: integer
1803
1804    .. method:: getNumMaterials()
1805
1806       :return: number of materials associated with this object
1807       :rtype: integer
1808
1809    .. method:: getMaterialName(matid)
1810
1811       Gets the name of the specified material.
1812
1813       :arg matid: the specified material.
1814       :type matid: integer
1815       :return: the attached material name.
1816       :rtype: string
1817
1818    .. method:: getTextureName(matid)
1819
1820       Gets the name of the specified material's texture.
1821
1822       :arg matid: the specified material
1823       :type matid: integer
1824       :return: the attached material's texture name.
1825       :rtype: string
1826
1827    .. method:: getVertexArrayLength(matid)
1828
1829       Gets the length of the vertex array associated with the specified material.
1830
1831       There is one vertex array for each material.
1832
1833       :arg matid: the specified material
1834       :type matid: integer
1835       :return: the number of verticies in the vertex array.
1836       :rtype: integer
1837
1838    .. method:: getVertex(matid, index)
1839
1840       Gets the specified vertex from the mesh object.
1841
1842       :arg matid: the specified material
1843       :type matid: integer
1844       :arg index: the index into the vertex array.
1845       :type index: integer
1846       :return: a vertex object.
1847       :rtype: :class:`KX_VertexProxy`
1848
1849    .. method:: getNumPolygons()
1850
1851       :return: The number of polygon in the mesh.
1852       :rtype: integer
1853
1854    .. method:: getPolygon(index)
1855
1856       Gets the specified polygon from the mesh.
1857
1858       :arg index: polygon number
1859       :type index: integer
1860       :return: a polygon object.
1861       :rtype: :class:`PolyProxy`
1862
1863 .. class:: SCA_MouseSensor(SCA_ISensor)
1864
1865    Mouse Sensor logic brick.
1866
1867    .. attribute:: position
1868
1869       current [x, y] coordinates of the mouse, in frame coordinates (pixels).
1870
1871       :type: [integer, interger]
1872
1873    .. attribute:: mode
1874
1875       sensor mode.
1876
1877       :type: integer
1878
1879          * KX_MOUSESENSORMODE_LEFTBUTTON(1)
1880          * KX_MOUSESENSORMODE_MIDDLEBUTTON(2)
1881          * KX_MOUSESENSORMODE_RIGHTBUTTON(3)
1882          * KX_MOUSESENSORMODE_WHEELUP(4)
1883          * KX_MOUSESENSORMODE_WHEELDOWN(5)
1884          * KX_MOUSESENSORMODE_MOVEMENT(6)
1885
1886    .. method:: getButtonStatus(button)
1887
1888       Get the mouse button status.
1889  
1890       :arg button: The code that represents the key you want to get the state of, use one of :ref:`these constants<mouse-keys>`
1891       :type button: int
1892       :return: The state of the given key, can be one of :ref:`these constants<input-status>`
1893       :rtype: int
1894
1895 .. class:: KX_MouseFocusSensor(SCA_MouseSensor)
1896
1897    The mouse focus sensor detects when the mouse is over the current game object.
1898
1899    The mouse focus sensor works by transforming the mouse coordinates from 2d device
1900    space to 3d space then raycasting away from the camera.
1901
1902    .. attribute:: raySource
1903
1904       The worldspace source of the ray (the view position).
1905
1906       :type: list (vector of 3 floats)
1907
1908    .. attribute:: rayTarget
1909
1910       The worldspace target of the ray.
1911
1912       :type: list (vector of 3 floats)
1913
1914    .. attribute:: rayDirection
1915
1916       The :data:`rayTarget` - :class:`raySource` normalized.
1917
1918       :type: list (normalized vector of 3 floats)
1919
1920    .. attribute:: hitObject
1921
1922       the last object the mouse was over.
1923
1924       :type: :class:`KX_GameObject` or None
1925
1926    .. attribute:: hitPosition
1927
1928       The worldspace position of the ray intersecton.
1929
1930       :type: list (vector of 3 floats)
1931
1932    .. attribute:: hitNormal
1933
1934       the worldspace normal from the face at point of intersection.
1935
1936       :type: list (normalized vector of 3 floats)
1937
1938    .. attribute:: hitUV
1939
1940       the UV coordinates at the point of intersection.
1941
1942       :type: list (vector of 2 floats)
1943
1944       If the object has no UV mapping, it returns [0, 0].
1945
1946       The UV coordinates are not normalized, they can be < 0 or > 1 depending on the UV mapping.
1947
1948    .. attribute:: usePulseFocus
1949
1950       When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set).
1951
1952       :type: boolean
1953
1954 .. class:: KX_TouchSensor(SCA_ISensor)
1955
1956    Touch sensor detects collisions between objects.
1957
1958    .. attribute:: propName
1959
1960       The property or material to collide with.
1961
1962       :type: string
1963
1964    .. attribute:: useMaterial
1965
1966       Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property.
1967
1968       :type: boolean
1969
1970    .. attribute:: usePulseCollision
1971
1972       When enabled, changes to the set of colliding objects generate a pulse.
1973
1974       :type: boolean
1975
1976    .. attribute:: hitObject
1977
1978       The last collided object. (read-only).
1979
1980       :type: :class:`KX_GameObject` or None
1981
1982    .. attribute:: hitObjectList
1983
1984       A list of colliding objects. (read-only).
1985
1986       :type: :class:`CListValue` of :class:`KX_GameObject`
1987
1988 .. class:: KX_NearSensor(KX_TouchSensor)
1989
1990    A near sensor is a specialised form of touch sensor.
1991
1992    .. attribute:: distance
1993
1994       The near sensor activates when an object is within this distance.
1995
1996       :type: float
1997
1998    .. attribute:: resetDistance
1999
2000       The near sensor deactivates when the object exceeds this distance.
2001
2002       :type: float
2003
2004 .. class:: KX_NetworkMessageActuator(SCA_IActuator)
2005
2006    Message Actuator
2007
2008    .. attribute:: propName
2009
2010       Messages will only be sent to objects with the given property name.
2011
2012       :type: string
2013
2014    .. attribute:: subject
2015
2016       The subject field of the message.
2017
2018       :type: string
2019
2020    .. attribute:: body
2021
2022       The body of the message.
2023
2024       :type: string
2025
2026    .. attribute:: usePropBody
2027
2028       Send a property instead of a regular body message.
2029
2030       :type: boolean
2031
2032 .. class:: KX_NetworkMessageSensor(SCA_ISensor)
2033
2034    The Message Sensor logic brick.
2035
2036    Currently only loopback (local) networks are supported.
2037
2038    .. attribute:: subject
2039
2040       The subject the sensor is looking for.
2041
2042       :type: string
2043
2044    .. attribute:: frameMessageCount
2045
2046       The number of messages received since the last frame. (read-only).
2047
2048       :type: integer
2049
2050    .. attribute:: subjects
2051
2052       The list of message subjects received. (read-only).
2053
2054       :type: list of strings
2055
2056    .. attribute:: bodies
2057
2058       The list of message bodies received. (read-only).
2059
2060       :type: list of strings
2061
2062 .. class:: KX_ObjectActuator(SCA_IActuator)
2063
2064    The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement, 
2065    velocity, or angular velocity to an object.
2066    Servo control allows to regulate force to achieve a certain speed target.
2067
2068    .. attribute:: force
2069
2070       The force applied by the actuator.
2071
2072       :type: list [x, y, z]
2073
2074    .. attribute:: useLocalForce
2075
2076       A flag specifying if the force is local.
2077
2078       :type: boolean
2079
2080    .. attribute:: torque
2081
2082       The torque applied by the actuator.
2083
2084       :type: list [x, y, z]
2085
2086    .. attribute:: useLocalTorque
2087
2088       A flag specifying if the torque is local.
2089
2090       :type: boolean
2091
2092    .. attribute:: dLoc
2093
2094       The displacement vector applied by the actuator.
2095
2096       :type: list [x, y, z]
2097
2098    .. attribute:: useLocalDLoc
2099
2100       A flag specifying if the dLoc is local.
2101
2102       :type: boolean
2103
2104    .. attribute:: dRot
2105
2106       The angular displacement vector applied by the actuator
2107
2108       :type: list [x, y, z]
2109       
2110       .. note::
2111       
2112          Since the displacement is applied every frame, you must adjust the displacement based on the frame rate, or you game experience will depend on the player's computer speed.
2113
2114    .. attribute:: useLocalDRot
2115
2116       A flag specifying if the dRot is local.
2117
2118       :type: boolean
2119
2120    .. attribute:: linV
2121
2122       The linear velocity applied by the actuator.
2123
2124       :type: list [x, y, z]
2125
2126    .. attribute:: useLocalLinV
2127
2128       A flag specifying if the linear velocity is local.
2129
2130       :type: boolean
2131       
2132       .. note::
2133       
2134          This is the target speed for servo controllers.
2135
2136    .. attribute:: angV
2137
2138       The angular velocity applied by the actuator.
2139
2140       :type: list [x, y, z]
2141
2142    .. attribute:: useLocalAngV
2143
2144       A flag specifying if the angular velocity is local.
2145
2146       :type: boolean
2147
2148    .. attribute:: damping
2149
2150       The damping parameter of the servo controller.
2151
2152       :type: short
2153
2154    .. attribute:: forceLimitX
2155
2156       The min/max force limit along the X axis and activates or deactivates the limits in the servo controller.
2157
2158       :type: list [min(float), max(float), bool]
2159
2160    .. attribute:: forceLimitY
2161
2162       The min/max force limit along the Y axis and activates or deactivates the limits in the servo controller.
2163
2164       :type: list [min(float), max(float), bool]
2165
2166    .. attribute:: forceLimitZ
2167
2168       The min/max force limit along the Z axis and activates or deactivates the limits in the servo controller.
2169
2170       :type: list [min(float), max(float), bool]
2171
2172    .. attribute:: pid
2173
2174       The PID coefficients of the servo controller.
2175
2176       :type: list of floats [proportional, integral, derivate]
2177
2178    .. attribute:: reference
2179
2180       The object that is used as reference to compute the velocity for the servo controller.
2181
2182       :type: :class:`KX_GameObject` or None
2183
2184 .. class:: KX_ParentActuator(SCA_IActuator)
2185
2186    The parent actuator can set or remove an objects parent object.
2187
2188    .. attribute:: object
2189
2190       the object this actuator sets the parent too.
2191
2192       :type: :class:`KX_GameObject` or None
2193
2194    .. attribute:: mode
2195
2196       The mode of this actuator.
2197
2198       :type: integer from 0 to 1.
2199
2200    .. attribute:: compound
2201
2202       Whether the object shape should be added to the parent compound shape when parenting.
2203
2204       Effective only if the parent is already a compound shape.
2205
2206       :type: boolean
2207
2208    .. attribute:: ghost
2209
2210       Whether the object should be made ghost when parenting
2211       Effective only if the shape is not added to the parent compound shape.
2212
2213       :type: boolean
2214
2215 .. class:: KX_PhysicsObjectWrapper(PyObjectPlus)
2216
2217    KX_PhysicsObjectWrapper
2218
2219    .. method:: setActive(active)
2220
2221       Set the object to be active.
2222
2223       :arg active: set to True to be active
2224       :type active: boolean
2225
2226    .. method:: setAngularVelocity(x, y, z, local)
2227
2228       Set the angular velocity of the object.
2229
2230       :arg x: angular velocity for the x-axis
2231       :type x: float
2232
2233       :arg y: angular velocity for the y-axis
2234       :type y: float
2235
2236       :arg z: angular velocity for the z-axis
2237       :type z: float
2238
2239       :arg local: set to True for local axis
2240       :type local: boolean
2241
2242    .. method:: setLinearVelocity(x, y, z, local)
2243
2244       Set the linear velocity of the object.
2245
2246       :arg x: linear velocity for the x-axis
2247       :type x: float
2248
2249       :arg y: linear velocity for the y-axis
2250       :type y: float
2251
2252       :arg z: linear velocity for the z-axis
2253       :type z: float
2254
2255       :arg local: set to True for local axis
2256       :type local: boolean
2257
2258 .. class:: KX_PolyProxy(SCA_IObject)
2259
2260    A polygon holds the index of the vertex forming the poylgon.
2261
2262    Note:
2263    The polygon attributes are read-only, you need to retrieve the vertex proxy if you want
2264    to change the vertex settings.
2265
2266    .. attribute:: matname
2267
2268       The name of polygon material, empty if no material.
2269
2270       :type: string
2271
2272    .. attribute:: material
2273
2274       The material of the polygon.
2275
2276       :type: :class:`KX_PolygonMaterial` or :class:`KX_BlenderMaterial`
2277
2278    .. attribute:: texture
2279
2280       The texture name of the polygon.
2281
2282       :type: string
2283
2284    .. attribute:: matid
2285
2286       The material index of the polygon, use this to retrieve vertex proxy from mesh proxy.
2287
2288       :type: integer
2289
2290    .. attribute:: v1
2291
2292       vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
2293
2294       :type: integer
2295
2296    .. attribute:: v2
2297
2298       vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
2299
2300       :type: integer
2301
2302    .. attribute:: v3
2303
2304       vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
2305
2306       :type: integer
2307
2308    .. attribute:: v4
2309
2310       Vertex index of the fourth vertex of the polygon, 0 if polygon has only 3 vertex
2311       Use this to retrieve vertex proxy from mesh proxy.
2312
2313       :type: integer
2314
2315    .. attribute:: visible
2316
2317       visible state of the polygon: 1=visible, 0=invisible.
2318
2319       :type: integer
2320
2321    .. attribute:: collide
2322
2323       collide state of the polygon: 1=receives collision, 0=collision free.
2324
2325       :type: integer
2326
2327    .. method:: getMaterialName()
2328
2329       Returns the polygon material name with MA prefix
2330
2331       :return: material name
2332       :rtype: string
2333
2334    .. method:: getMaterial()
2335
2336       :return: The polygon material
2337       :rtype: :class:`KX_PolygonMaterial` or :class:`KX_BlenderMaterial`
2338
2339    .. method:: getTextureName()
2340
2341       :return: The texture name
2342       :rtype: string
2343
2344    .. method:: getMaterialIndex()
2345
2346       Returns the material bucket index of the polygon.
2347       This index and the ones returned by getVertexIndex() are needed to retrieve the vertex proxy from :class:`MeshProxy`.
2348
2349       :return: the material index in the mesh
2350       :rtype: integer
2351
2352    .. method:: getNumVertex()
2353
2354       Returns the number of vertex of the polygon.
2355
2356       :return: number of vertex, 3 or 4.
2357       :rtype: integer
2358
2359    .. method:: isVisible()
2360
2361       Returns whether the polygon is visible or not
2362
2363       :return: 0=invisible, 1=visible
2364       :rtype: boolean
2365
2366    .. method:: isCollider()
2367
2368       Returns whether the polygon is receives collision or not
2369
2370       :return: 0=collision free, 1=receives collision
2371       :rtype: integer
2372
2373    .. method:: getVertexIndex(vertex)
2374
2375       Returns the mesh vertex index of a polygon vertex
2376       This index and the one returned by getMaterialIndex() are needed to retrieve the vertex proxy from :class:`MeshProxy`.
2377
2378       :arg vertex: index of the vertex in the polygon: 0->3
2379       :arg vertex: integer
2380       :return: mesh vertex index
2381       :rtype: integer
2382
2383    .. method:: getMesh()
2384
2385       Returns a mesh proxy
2386
2387       :return: mesh proxy
2388       :rtype: :class:`MeshProxy`
2389
2390 .. class:: KX_PolygonMaterial(PyObjectPlus)
2391
2392    This is the interface to materials in the game engine.
2393
2394    Materials define the render state to be applied to mesh objects.
2395
2396    .. warning::
2397
2398       Some of the methods/variables are CObjects.  If you mix these up, you will crash blender.
2399
2400    This example requires `PyOpenGL <http://pyopengl.sourceforge.net>`_ and `GLEWPy <http://glewpy.sourceforge.net>`_
2401
2402    .. code-block:: python
2403
2404       import GameLogic
2405       import OpenGL
2406       from OpenGL.GL import *
2407       from OpenGL.GLU import *
2408       import glew
2409       from glew import *
2410       
2411       glewInit()
2412       
2413       vertex_shader = """
2414       
2415       void main(void)
2416       {
2417          gl_Position = ftransform();
2418       }
2419       """
2420       
2421       fragment_shader ="""
2422       
2423       void main(void)
2424       {
2425          gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0);
2426       }
2427       """
2428       
2429       class MyMaterial:
2430          def __init__(self):
2431             self.pass_no = 0
2432             # Create a shader
2433             self.m_program = glCreateProgramObjectARB()
2434             # Compile the vertex shader
2435             self.shader(GL_VERTEX_SHADER_ARB, (vertex_shader))
2436             # Compile the fragment shader
2437             self.shader(GL_FRAGMENT_SHADER_ARB, (fragment_shader))
2438             # Link the shaders together
2439             self.link()
2440             
2441          def PrintInfoLog(self, tag, object):
2442             """
2443             PrintInfoLog prints the GLSL compiler log
2444             """
2445             print "Tag:    def PrintGLError(self, tag = ""):
2446             
2447          def PrintGLError(self, tag = ""):
2448             """
2449             Prints the current GL error status
2450             """
2451             if len(tag):
2452                print tag
2453             err = glGetError()
2454             if err != GL_NO_ERROR:
2455                print "GL Error: %s\\n"%(gluErrorString(err))
2456       
2457          def shader(self, type, shaders):
2458             """
2459             shader compiles a GLSL shader and attaches it to the current
2460             program.
2461             
2462             type should be either GL_VERTEX_SHADER_ARB or GL_FRAGMENT_SHADER_ARB
2463             shaders should be a sequence of shader source to compile.
2464             """
2465             # Create a shader object
2466             shader_object = glCreateShaderObjectARB(type)
2467       
2468             # Add the source code
2469             glShaderSourceARB(shader_object, len(shaders), shaders)
2470             
2471             # Compile the shader
2472             glCompileShaderARB(shader_object)
2473             
2474             # Print the compiler log
2475             self.PrintInfoLog("vertex shader", shader_object)
2476             
2477             # Check if compiled, and attach if it did
2478             compiled = glGetObjectParameterivARB(shader_object, GL_OBJECT_COMPILE_STATUS_ARB)
2479             if compiled:
2480                glAttachObjectARB(self.m_program, shader_object)
2481                
2482             # Delete the object (glAttachObjectARB makes a copy)
2483             glDeleteObjectARB(shader_object)
2484             
2485             # print the gl error log
2486             self.PrintGLError()
2487             
2488          def link(self):
2489             """
2490             Links the shaders together.
2491             """
2492             # clear error indicator
2493             glGetError()
2494             
2495             glLinkProgramARB(self.m_program)
2496       
2497             self.PrintInfoLog("link", self.m_program)
2498          
2499             linked = glGetObjectParameterivARB(self.m_program, GL_OBJECT_LINK_STATUS_ARB)
2500             if not linked:
2501                print "Shader failed to link"
2502                return
2503       
2504             glValidateProgramARB(self.m_program)
2505             valid = glGetObjectParameterivARB(self.m_program, GL_OBJECT_VALIDATE_STATUS_ARB)
2506             if not valid:
2507                print "Shader failed to validate"
2508                return
2509             
2510          def activate(self, rasty, cachingInfo, mat):
2511             self.pass_no+=1
2512             if (self.pass_no == 1):
2513                glDisable(GL_COLOR_MATERIAL)
2514                glUseProgramObjectARB(self.m_program)
2515                return True
2516             
2517             glEnable(GL_COLOR_MATERIAL)
2518             glUseProgramObjectARB(0)
2519             self.pass_no = 0   
2520             return False
2521
2522       obj = GameLogic.getCurrentController().owner
2523       
2524       mesh = obj.meshes[0]
2525       
2526       for mat in mesh.materials:
2527          mat.setCustomMaterial(MyMaterial())
2528          print mat.texture
2529
2530    .. attribute:: texture
2531
2532       Texture name.
2533
2534       :type: string (read-only)
2535
2536    .. attribute:: gl_texture
2537
2538       OpenGL texture handle (eg for glBindTexture(GL_TEXTURE_2D, gl_texture).
2539
2540       :type: integer (read-only)
2541
2542    .. attribute:: material
2543
2544       Material name.
2545
2546       :type: string (read-only)
2547
2548    .. attribute:: tface
2549
2550       Texture face properties.
2551
2552       :type: CObject (read-only)
2553
2554    .. attribute:: tile
2555
2556       Texture is tiling.
2557
2558       :type: boolean
2559
2560    .. attribute:: tilexrep
2561
2562       Number of tile repetitions in x direction.
2563
2564       :type: integer
2565
2566    .. attribute:: tileyrep
2567
2568       Number of tile repetitions in y direction.
2569
2570       :type: integer
2571
2572    .. attribute:: drawingmode
2573
2574       Drawing mode for the material.
2575       - 2  (drawingmode & 4)     Textured
2576       - 4  (drawingmode & 16)    Light
2577       - 14 (drawingmode & 16384) 3d Polygon Text.
2578
2579       :type: bitfield
2580
2581    .. attribute:: transparent
2582
2583       This material is transparent. All meshes with this
2584       material will be rendered after non transparent meshes from back
2585       to front.
2586
2587       :type: boolean
2588
2589    .. attribute:: zsort
2590
2591       Transparent polygons in meshes with this material will be sorted back to
2592       front before rendering.
2593       Non-Transparent polygons will be sorted front to back before rendering.
2594
2595       :type: boolean
2596
2597    .. attribute:: lightlayer
2598
2599       Light layers this material affects.
2600
2601       :type: bitfield.
2602
2603    .. attribute:: triangle
2604
2605       Mesh data with this material is triangles. It's probably not safe to change this.
2606
2607       :type: boolean
2608
2609    .. attribute:: diffuse
2610
2611       The diffuse colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0].
2612
2613       :type: list [r, g, b]
2614
2615    .. attribute:: specular
2616
2617       The specular colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0].
2618
2619       :type: list [r, g, b]
2620
2621    .. attribute:: shininess
2622
2623       The shininess (specular exponent) of the material. 0.0 <= shininess <= 128.0.
2624
2625       :type: float
2626
2627    .. attribute:: specularity
2628
2629       The amount of specular of the material. 0.0 <= specularity <= 1.0.
2630
2631       :type: float
2632
2633    .. method:: updateTexture(tface, rasty)
2634
2635       Updates a realtime animation.
2636
2637       :arg tface: Texture face (eg mat.tface)
2638       :type tface: CObject
2639       :arg rasty: Rasterizer
2640       :type rasty: CObject
2641
2642    .. method:: setTexture(tface)
2643
2644       Sets texture render state.
2645
2646       :arg tface: Texture face
2647       :type tface: CObject
2648
2649       .. code-block:: python
2650
2651          mat.setTexture(mat.tface)
2652          
2653    .. method:: activate(rasty, cachingInfo)
2654
2655       Sets material parameters for this object for rendering.
2656
2657       Material Parameters set:
2658
2659       #. Texture
2660       #. Backface culling
2661       #. Line drawing
2662       #. Specular Colour
2663       #. Shininess
2664       #. Diffuse Colour
2665       #. Polygon Offset.
2666
2667       :arg rasty: Rasterizer instance.
2668       :type rasty: CObject
2669       :arg cachingInfo: Material cache instance.
2670       :type cachingInfo: CObject
2671
2672    .. method:: setCustomMaterial(material)
2673
2674       Sets the material state setup object.
2675
2676       Using this method, you can extend or completely replace the gameengine material
2677       to do your own advanced multipass effects.
2678
2679       Use this method to register your material class.  Instead of the normal material, 
2680       your class's activate method will be called just before rendering the mesh.
2681       This should setup the texture, material, and any other state you would like.
2682       It should return True to render the mesh, or False if you are finished.  You should
2683       clean up any state Blender does not set before returning False.
2684
2685       Activate Method Definition:
2686
2687       .. code-block:: python
2688       
2689          def activate(self, rasty, cachingInfo, material):
2690
2691       :arg material: The material object.
2692       :type material: instance
2693
2694       .. code-block:: python
2695
2696          class PyMaterial:
2697            def __init__(self):
2698              self.pass_no = -1
2699            
2700            def activate(self, rasty, cachingInfo, material):
2701              # Activate the material here.
2702              #
2703              # The activate method will be called until it returns False.
2704              # Every time the activate method returns True the mesh will
2705              # be rendered.
2706              #
2707              # rasty is a CObject for passing to material.updateTexture() 
2708              #       and material.activate()
2709              # cachingInfo is a CObject for passing to material.activate()
2710              # material is the KX_PolygonMaterial instance this material
2711              #          was added to
2712              
2713              # default material properties:
2714              self.pass_no += 1
2715              if self.pass_no == 0:
2716                material.activate(rasty, cachingInfo)
2717                # Return True to do this pass
2718                return True
2719              
2720              # clean up and return False to finish.
2721              self.pass_no = -1
2722              return False
2723          
2724          # Create a new Python Material and pass it to the renderer.
2725          mat.setCustomMaterial(PyMaterial())
2726          
2727 .. class:: KX_RadarSensor(KX_NearSensor)
2728
2729    Radar sensor is a near sensor with a conical sensor object.
2730
2731    .. attribute:: coneOrigin
2732
2733       The origin of the cone with which to test. The origin is in the middle of the cone. (read-only).
2734
2735       :type: list of floats [x, y, z]
2736
2737    .. attribute:: coneTarget
2738
2739       The center of the bottom face of the cone with which to test. (read-only).
2740
2741       :type: list of floats [x, y, z]
2742
2743    .. attribute:: distance
2744
2745       The height of the cone with which to test.
2746
2747       :type: float
2748
2749    .. attribute:: angle
2750
2751       The angle of the cone (in degrees) with which to test.
2752
2753       :type: float from 0 to 360
2754
2755    .. attribute:: axis
2756
2757       The axis on which the radar cone is cast.
2758
2759       :type: integer from 0 to 5
2760
2761       KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z, 
2762       KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
2763
2764    .. method:: getConeHeight()
2765
2766       :return: The height of the cone with which to test.
2767       :rtype: float
2768
2769 .. class:: KX_RaySensor(SCA_ISensor)
2770
2771    A ray sensor detects the first object in a given direction.
2772
2773    .. attribute:: propName
2774
2775       The property the ray is looking for.
2776
2777       :type: string
2778
2779    .. attribute:: range
2780
2781       The distance of the ray.
2782
2783       :type: float
2784
2785    .. attribute:: useMaterial
2786
2787       Whether or not to look for a material (false = property).
2788
2789       :type: boolean
2790
2791    .. attribute:: useXRay
2792
2793       Whether or not to use XRay.
2794
2795       :type: boolean
2796
2797    .. attribute:: hitObject
2798
2799       The game object that was hit by the ray. (read-only).
2800
2801       :type: :class:`KX_GameObject`
2802
2803    .. attribute:: hitPosition
2804
2805       The position (in worldcoordinates) where the object was hit by the ray. (read-only).
2806
2807       :type: list [x, y, z]
2808
2809    .. attribute:: hitNormal
2810
2811       The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (read-only).
2812
2813       :type: list [x, y, z]
2814
2815    .. attribute:: rayDirection
2816
2817       The direction from the ray (in worldcoordinates). (read-only).
2818
2819       :type: list [x, y, z]
2820
2821    .. attribute:: axis
2822
2823       The axis the ray is pointing on.
2824
2825       :type: integer from 0 to 5
2826
2827       * KX_RAY_AXIS_POS_X
2828       * KX_RAY_AXIS_POS_Y
2829       * KX_RAY_AXIS_POS_Z
2830       * KX_RAY_AXIS_NEG_X
2831       * KX_RAY_AXIS_NEG_Y
2832       * KX_RAY_AXIS_NEG_Z
2833
2834 .. class:: KX_SCA_AddObjectActuator(SCA_IActuator)
2835
2836    Edit Object Actuator (in Add Object Mode)
2837
2838    .. warning::
2839
2840       An Add Object actuator will be ignored if at game start, the linked object doesn't exist (or is empty) or the linked object is in an active layer.
2841
2842       .. code-block:: none
2843
2844          Error: GameObject 'Name' has a AddObjectActuator 'ActuatorName' without object (in 'nonactive' layer) 
2845       
2846    .. attribute:: object
2847
2848       the object this actuator adds.
2849
2850       :type: :class:`KX_GameObject` or None
2851
2852    .. attribute:: objectLastCreated
2853
2854       the last added object from this actuator (read-only).
2855
2856       :type: :class:`KX_GameObject` or None
2857
2858    .. attribute:: time
2859
2860       the lifetime of added objects, in frames. Set to 0 to disable automatic deletion.
2861
2862       :type: integer
2863
2864    .. attribute:: linearVelocity
2865
2866       the initial linear velocity of added objects.
2867
2868       :type: list [vx, vy, vz]
2869
2870    .. attribute:: angularVelocity
2871
2872       the initial angular velocity of added objects.
2873
2874       :type: list [vx, vy, vz]
2875
2876    .. method:: instantAddObject()
2877
2878       adds the object without needing to calling SCA_PythonController.activate()
2879           
2880           .. note:: Use objectLastCreated to get the newly created object.
2881
2882 .. class:: KX_SCA_DynamicActuator(SCA_IActuator)
2883
2884    Dynamic Actuator.
2885
2886    .. attribute:: mode
2887
2888       :type: integer
2889
2890       the type of operation of the actuator, 0-4
2891
2892       * KX_DYN_RESTORE_DYNAMICS(0)
2893       * KX_DYN_DISABLE_DYNAMICS(1)
2894       * KX_DYN_ENABLE_RIGID_BODY(2)
2895       * KX_DYN_DISABLE_RIGID_BODY(3)
2896       * KX_DYN_SET_MASS(4)
2897
2898    .. attribute:: mass
2899
2900       the mass value for the KX_DYN_SET_MASS operation.
2901
2902       :type: float
2903
2904 .. class:: KX_SCA_EndObjectActuator(SCA_IActuator)
2905
2906    Edit Object Actuator (in End Object mode)
2907
2908    This actuator has no python methods.
2909
2910 .. class:: KX_SCA_ReplaceMeshActuator(SCA_IActuator)
2911
2912    Edit Object actuator, in Replace Mesh mode.
2913
2914    .. warning::
2915
2916       Replace mesh actuators will be ignored if at game start, the named mesh doesn't exist.
2917
2918       This will generate a warning in the console
2919
2920       .. code-block:: none
2921       
2922          Error: GameObject 'Name' ReplaceMeshActuator 'ActuatorName' without object
2923
2924    .. code-block:: python
2925
2926       # Level-of-detail
2927       # Switch a game object's mesh based on its depth in the camera view.
2928       # +----------+     +-----------+     +-------------------------------------+
2929       # | Always   +-----+ Python    +-----+ Edit Object (Replace Mesh) LOD.Mesh |
2930       # +----------+     +-----------+     +-------------------------------------+
2931       import GameLogic
2932
2933       # List detail meshes here
2934       # Mesh (name, near, far)
2935       # Meshes overlap so that they don't 'pop' when on the edge of the distance.
2936       meshes = ((".Hi", 0.0, -20.0),
2937             (".Med", -15.0, -50.0),
2938             (".Lo", -40.0, -100.0)
2939           )
2940       
2941       co = GameLogic.getCurrentController()
2942       obj = co.owner
2943       act = co.actuators["LOD." + obj.name]
2944       cam = GameLogic.getCurrentScene().active_camera
2945       
2946       def Depth(pos, plane):
2947         return pos[0]*plane[0] + pos[1]*plane[1] + pos[2]*plane[2] + plane[3]
2948       
2949       # Depth is negative and decreasing further from the camera
2950       depth = Depth(obj.position, cam.world_to_camera[2])
2951       
2952       newmesh = None
2953       curmesh = None
2954       # Find the lowest detail mesh for depth
2955       for mesh in meshes:
2956         if depth < mesh[1] and depth > mesh[2]:
2957           newmesh = mesh
2958         if "ME" + obj.name + mesh[0] == act.getMesh():
2959             curmesh = mesh
2960       
2961       if newmesh != None and "ME" + obj.name + newmesh[0] != act.getMesh():
2962         # The mesh is a different mesh - switch it.
2963         # Check the current mesh is not a better fit.
2964         if curmesh == None or curmesh[1] < depth or curmesh[2] > depth:
2965           act.mesh = obj.getName() + newmesh[0]
2966           GameLogic.addActiveActuator(act, True)
2967
2968    .. attribute:: mesh
2969
2970       :class:`MeshProxy` or the name of the mesh that will replace the current one.
2971    
2972       Set to None to disable actuator.
2973
2974       :type: :class:`MeshProxy` or None if no mesh is set
2975
2976    .. attribute:: useDisplayMesh
2977
2978       when true the displayed mesh is replaced.
2979
2980       :type: boolean
2981
2982    .. attribute:: usePhysicsMesh
2983
2984       when true the physics mesh is replaced.
2985
2986       :type: boolean
2987
2988    .. method:: instantReplaceMesh()
2989
2990       Immediately replace mesh without delay.
2991
2992 .. class:: KX_Scene(PyObjectPlus)
2993
2994    An active scene that gives access to objects, cameras, lights and scene attributes.
2995
2996    The activity culling stuff is supposed to disable logic bricks when their owner gets too far
2997    from the active camera.  It was taken from some code lurking at the back of KX_Scene - who knows
2998    what it does!
2999
3000    .. code-block:: python
3001
3002       import GameLogic
3003
3004       # get the scene
3005       scene = GameLogic.getCurrentScene()
3006
3007       # print all the objects in the scene
3008       for obj in scene.objects:
3009          print obj.name
3010
3011       # get an object named 'Cube'
3012       obj = scene.objects["Cube"]
3013
3014       # get the first object in the scene.
3015       obj = scene.objects[0]
3016
3017    .. code-block:: python
3018
3019       # Get the depth of an object in the camera view.
3020       import GameLogic
3021
3022       obj = GameLogic.getCurrentController().owner
3023       cam = GameLogic.getCurrentScene().active_camera
3024
3025       # Depth is negative and decreasing further from the camera
3026       depth = obj.position[0]*cam.world_to_camera[2][0] + obj.position[1]*cam.world_to_camera[2][1] + obj.position[2]*cam.world_to_camera[2][2] + cam.world_to_camera[2][3]
3027
3028    @bug: All attributes are read only at the moment.
3029
3030    .. attribute:: name
3031
3032       The scene's name, (read-only).
3033
3034       :type: string
3035
3036    .. attribute:: objects
3037
3038       A list of objects in the scene, (read-only).
3039
3040       :type: :class:`CListValue` of :class:`KX_GameObject`
3041
3042    .. attribute:: objectsInactive
3043
3044       A list of objects on background layers (used for the addObject actuator), (read-only).
3045
3046       :type: :class:`CListValue` of :class:`KX_GameObject`
3047
3048    .. attribute:: lights
3049
3050       A list of lights in the scene, (read-only).
3051
3052       :type: :class:`CListValue` of :class:`KX_LightObject`
3053
3054    .. attribute:: cameras
3055
3056       A list of cameras in the scene, (read-only).
3057
3058       :type: :class:`CListValue` of :class:`KX_Camera`
3059
3060    .. attribute:: active_camera
3061
3062       The current active camera.
3063
3064       :type: :class:`KX_Camera`
3065       
3066       .. note::
3067          
3068          This can be set directly from python to avoid using the :class:`KX_SceneActuator`.
3069
3070    .. attribute:: suspended
3071
3072       True if the scene is suspended, (read-only).
3073
3074       :type: boolean
3075
3076    .. attribute:: activity_culling
3077
3078       True if the scene is activity culling.
3079
3080       :type: boolean
3081
3082    .. attribute:: activity_culling_radius
3083
3084       The distance outside which to do activity culling. Measured in manhattan distance.
3085
3086       :type: float
3087
3088    .. attribute:: dbvt_culling
3089
3090       True when Dynamic Bounding box Volume Tree is set (read-only).
3091
3092       :type: boolean
3093
3094    .. attribute:: pre_draw
3095
3096       A list of callables to be run before the render step.
3097
3098       :type: list
3099
3100    .. attribute:: post_draw
3101
3102       A list of callables to be run after the render step.
3103
3104       :type: list
3105
3106    .. method:: addObject(object, other, time=0)
3107
3108       Adds an object to the scene like the Add Object Actuator would.
3109
3110       :arg object: The object to add
3111       :type object: :class:`KX_GameObject` or string
3112       :arg other: The object's center to use when adding the object
3113       :type other: :class:`KX_GameObject` or string
3114       :arg time: The lifetime of the added object, in frames. A time of 0 means the object will last forever.
3115       :type time: integer
3116       :return: The newly added object.
3117       :rtype: :class:`KX_GameObject`
3118
3119    .. method:: end()
3120
3121       Removes the scene from the game.
3122
3123    .. method:: restart()
3124
3125       Restarts the scene.
3126
3127    .. method:: replace(scene)
3128
3129       Replaces this scene with another one.
3130
3131       :arg scene: The name of the scene to replace this scene with.
3132       :type scene: string
3133
3134    .. method:: suspend()
3135
3136       Suspends this scene.
3137
3138    .. method:: resume()
3139
3140       Resume this scene.
3141
3142    .. method:: get(key, default=None)
3143
3144       Return the value matching key, or the default value if its not found.
3145       :return: The key value or a default.
3146
3147 .. class:: KX_SceneActuator(SCA_IActuator)
3148
3149    Scene Actuator logic brick.
3150
3151    .. warning::
3152
3153       Scene actuators that use a scene name will be ignored if at game start, the named scene doesn't exist or is empty
3154
3155       This will generate a warning in the console:
3156
3157       .. code-block:: none
3158       
3159          Error: GameObject 'Name' has a SceneActuator 'ActuatorName' (SetScene) without scene
3160
3161    .. attribute:: scene
3162
3163       the name of the scene to change to/overlay/underlay/remove/suspend/resume.
3164
3165       :type: string
3166
3167    .. attribute:: camera
3168
3169       the camera to change to.
3170
3171       :type: :class:`KX_Camera` on read, string or :class:`KX_Camera` on write
3172       
3173       .. note::
3174          
3175          When setting the attribute, you can use either a :class:`KX_Camera` or the name of the camera.
3176
3177    .. attribute:: useRestart
3178
3179       Set flag to True to restart the sene.
3180
3181       :type: boolean
3182
3183    .. attribute:: mode
3184
3185       The mode of the actuator.
3186
3187       :type: integer from 0 to 5.
3188
3189 .. class:: KX_SoundActuator(SCA_IActuator)
3190
3191    Sound Actuator.
3192
3193    The :data:`startSound`, :data:`pauseSound` and :data:`stopSound` do not requirethe actuator to be activated - they act instantly provided that the actuator has been activated once at least.
3194
3195    .. attribute:: fileName
3196
3197       The filename of the sound this actuator plays.
3198
3199       :type: string
3200
3201    .. attribute:: volume
3202
3203       The volume (gain) of the sound.
3204
3205       :type: float
3206
3207    .. attribute:: pitch
3208
3209       The pitch of the sound.
3210
3211       :type: float
3212
3213    .. attribute:: rollOffFactor
3214
3215       The roll off factor. Rolloff defines the rate of attenuation as the sound gets further away.
3216
3217       :type: float
3218
3219    .. attribute:: looping
3220
3221       The loop mode of the actuator.
3222
3223       :type: integer
3224
3225    .. attribute:: position
3226
3227       The position of the sound as a list: [x, y, z].
3228
3229       :type: float array
3230
3231    .. attribute:: velocity
3232
3233       The velocity of the emitter as a list: [x, y, z]. The relative velocity to the observer determines the pitch. List of 3 floats: [x, y, z].
3234
3235       :type: float array
3236
3237    .. attribute:: orientation
3238
3239       The orientation of the sound. When setting the orientation you can also use quaternion [float, float, float, float] or euler angles [float, float, float].
3240
3241       :type: 3x3 matrix [[float]]
3242
3243    .. attribute:: mode
3244
3245       The operation mode of the actuator. Can be one of :ref:`these constants<logic-sound-actuator>`
3246
3247       :type: integer
3248
3249 .. class:: KX_StateActuator(SCA_IActuator)
3250
3251    State actuator changes the state mask of parent object.
3252
3253    .. attribute:: operation
3254
3255       Type of bit operation to be applied on object state mask.
3256       
3257       You can use one of :ref:`these constants <state-actuator-operation>`
3258
3259       :type: integer
3260
3261    .. attribute:: mask
3262
3263       Value that defines the bits that will be modified by the operation.
3264
3265       The bits that are 1 in the mask will be updated in the object state.
3266
3267       The bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state.
3268
3269       :type: integer
3270
3271 .. class:: KX_TrackToActuator(SCA_IActuator)
3272
3273    Edit Object actuator in Track To mode.
3274
3275    .. warning::
3276    
3277       Track To Actuators will be ignored if at game start, the object to track to is invalid.
3278
3279       This will generate a warning in the console:
3280
3281       .. code-block:: none
3282
3283          GameObject 'Name' no object in EditObjectActuator 'ActuatorName'
3284
3285    .. attribute:: object
3286
3287       the object this actuator tracks.
3288
3289       :type: :class:`KX_GameObject` or None
3290
3291    .. attribute:: time
3292
3293       the time in frames with which to delay the tracking motion.
3294
3295       :type: integer
3296
3297    .. attribute:: use3D
3298
3299       the tracking motion to use 3D.
3300
3301       :type: boolean
3302
3303 .. class:: KX_VehicleWrapper(PyObjectPlus)
3304
3305    KX_VehicleWrapper
3306
3307    TODO - description
3308
3309    .. method:: addWheel(wheel, attachPos, attachDir, axleDir, suspensionRestLength, wheelRadius, hasSteering)
3310
3311       Add a wheel to the vehicle
3312
3313       :arg wheel: The object to use as a wheel.
3314       :type wheel: :class:`KX_GameObject` or a KX_GameObject name
3315       :arg attachPos: The position that this wheel will attach to.
3316       :type attachPos: vector of 3 floats
3317       :arg attachDir: The direction this wheel points.
3318       :type attachDir: vector of 3 floats
3319       :arg axleDir: The direction of this wheels axle.
3320       :type axleDir: vector of 3 floats
3321       :arg suspensionRestLength: TODO - Description
3322       :type suspensionRestLength: float
3323       :arg wheelRadius: The size of the wheel.
3324       :type wheelRadius: float
3325
3326    .. method:: applyBraking(force, wheelIndex)
3327
3328       Apply a braking force to the specified wheel
3329
3330       :arg force: the brake force
3331       :type force: float
3332
3333       :arg wheelIndex: index of the wheel where the force needs to be applied
3334       :type wheelIndex: integer
3335
3336    .. method:: applyEngineForce(force, wheelIndex)
3337
3338       Apply an engine force to the specified wheel
3339
3340       :arg force: the engine force
3341       :type force: float
3342
3343       :arg wheelIndex: index of the wheel where the force needs to be applied
3344       :type wheelIndex: integer
3345
3346    .. method:: getConstraintId()
3347
3348       Get the constraint ID
3349
3350       :return: the constraint id
3351       :rtype: integer
3352
3353    .. method:: getConstraintType()
3354
3355       Returns the constraint type.
3356
3357       :return: constraint type
3358       :rtype: integer
3359
3360    .. method:: getNumWheels()
3361
3362       Returns the number of wheels.
3363
3364       :return: the number of wheels for this vehicle
3365       :rtype: integer
3366
3367    .. method:: getWheelOrientationQuaternion(wheelIndex)
3368
3369       Returns the wheel orientation as a quaternion.
3370
3371       :arg wheelIndex: the wheel index
3372       :type wheelIndex: integer
3373
3374       :return: TODO Description
3375       :rtype: TODO - type should be quat as per method name but from the code it looks like a matrix
3376
3377    .. method:: getWheelPosition(wheelIndex)
3378
3379       Returns the position of the specified wheel
3380
3381       :arg wheelIndex: the wheel index
3382       :type wheelIndex: integer
3383       :return: position vector
3384       :rtype: list[x, y, z]
3385
3386    .. method:: getWheelRotation(wheelIndex)
3387
3388       Returns the rotation of the specified wheel
3389
3390       :arg wheelIndex: the wheel index
3391       :type wheelIndex: integer
3392
3393       :return: the wheel rotation
3394       :rtype: float
3395
3396    .. method:: setRollInfluence(rollInfluece, wheelIndex)
3397
3398       Set the specified wheel's roll influence.
3399       The higher the roll influence the more the vehicle will tend to roll over in corners.
3400
3401       :arg rollInfluece: the wheel roll influence
3402       :type rollInfluece: float
3403
3404       :arg wheelIndex: the wheel index
3405       :type wheelIndex: integer
3406
3407    .. method:: setSteeringValue(steering, wheelIndex)
3408
3409       Set the specified wheel's steering
3410
3411       :arg steering: the wheel steering
3412       :type steering: float
3413
3414       :arg wheelIndex: the wheel index
3415       :type wheelIndex: integer
3416
3417    .. method:: setSuspensionCompression(compression, wheelIndex)
3418
3419       Set the specified wheel's compression
3420
3421       :arg compression: the wheel compression
3422       :type compression: float
3423
3424       :arg wheelIndex: the wheel index
3425       :type wheelIndex: integer
3426
3427    .. method:: setSuspensionDamping(damping, wheelIndex)
3428
3429       Set the specified wheel's damping
3430
3431       :arg damping: the wheel damping
3432       :type damping: float
3433
3434       :arg wheelIndex: the wheel index
3435       :type wheelIndex: integer
3436
3437    .. method:: setSuspensionStiffness(stiffness, wheelIndex)
3438
3439       Set the specified wheel's stiffness
3440
3441       :arg stiffness: the wheel stiffness
3442       :type stiffness: float
3443
3444       :arg wheelIndex: the wheel index
3445       :type wheelIndex: integer
3446
3447    .. method:: setTyreFriction(friction, wheelIndex)
3448
3449       Set the specified wheel's tyre friction
3450
3451       :arg friction: the tyre friction
3452       :type friction: float
3453
3454       :arg wheelIndex: the wheel index
3455       :type wheelIndex: integer
3456
3457 .. class:: KX_VertexProxy(SCA_IObject)
3458
3459    A vertex holds position, UV, colour and normal information.
3460
3461    Note:
3462    The physics simulation is NOT currently updated - physics will not respond
3463    to changes in the vertex position.
3464
3465    .. attribute:: XYZ
3466
3467       The position of the vertex.
3468
3469       :type: list [x, y, z]
3470
3471    .. attribute:: UV
3472
3473       The texture coordinates of the vertex.
3474
3475       :type: list [u, v]
3476
3477    .. attribute:: normal
3478
3479       The normal of the vertex.
3480
3481       :type: list [nx, ny, nz]
3482
3483    .. attribute:: colour
3484
3485       The colour of the vertex.
3486
3487       :type: list [r, g, b, a]
3488
3489       Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
3490
3491    .. attribute:: color
3492
3493       Synonym for colour.
3494
3495    .. attribute:: x
3496
3497       The x coordinate of the vertex.
3498
3499       :type: float
3500
3501    .. attribute:: y
3502
3503       The y coordinate of the vertex.
3504
3505       :type: float
3506
3507    .. attribute:: z
3508
3509       The z coordinate of the vertex.
3510
3511       :type: float
3512
3513    .. attribute:: u
3514
3515       The u texture coordinate of the vertex.
3516
3517       :type: float
3518
3519    .. attribute:: v
3520
3521       The v texture coordinate of the vertex.
3522
3523       :type: float
3524
3525    .. attribute:: u2
3526
3527       The second u texture coordinate of the vertex.
3528
3529       :type: float
3530
3531    .. attribute:: v2
3532
3533       The second v texture coordinate of the vertex.
3534
3535       :type: float
3536
3537    .. attribute:: r
3538
3539       The red component of the vertex colour. 0.0 <= r <= 1.0.
3540
3541       :type: float
3542
3543    .. attribute:: g
3544
3545       The green component of the vertex colour. 0.0 <= g <= 1.0.
3546
3547       :type: float
3548
3549    .. attribute:: b
3550
3551       The blue component of the vertex colour. 0.0 <= b <= 1.0.
3552
3553       :type: float
3554
3555    .. attribute:: a
3556
3557       The alpha component of the vertex colour. 0.0 <= a <= 1.0.
3558
3559       :type: float
3560
3561    .. method:: getXYZ()
3562
3563       Gets the position of this vertex.
3564
3565       :return: this vertexes position in local coordinates.
3566       :rtype: list [x, y, z]
3567
3568    .. method:: setXYZ(pos)
3569
3570       Sets the position of this vertex.
3571
3572       :type:  list [x, y, z]
3573
3574       :arg pos: the new position for this vertex in local coordinates.
3575
3576    .. method:: getUV()
3577
3578       Gets the UV (texture) coordinates of this vertex.
3579
3580       :return: this vertexes UV (texture) coordinates.
3581       :rtype: list [u, v]
3582
3583    .. method:: setUV(uv)
3584
3585       Sets the UV (texture) coordinates of this vertex.
3586
3587       :type:  list [u, v]
3588
3589    .. method:: getUV2()
3590
3591       Gets the 2nd UV (texture) coordinates of this vertex.
3592
3593       :return: this vertexes UV (texture) coordinates.
3594       :rtype: list [u, v]
3595
3596    .. method:: setUV2(uv, unit)
3597
3598       Sets the 2nd UV (texture) coordinates of this vertex.
3599
3600       :type:  list [u, v]
3601
3602       :arg unit: optional argument, FLAT==1, SECOND_UV==2, defaults to SECOND_UV
3603       :arg unit:  integer
3604
3605    .. method:: getRGBA()
3606
3607       Gets the colour of this vertex.
3608
3609       The colour is represented as four bytes packed into an integer value.  The colour is
3610       packed as RGBA.
3611
3612       Since Python offers no way to get each byte without shifting, you must use the struct module to
3613       access colour in an machine independent way.
3614
3615       Because of this, it is suggested you use the r, g, b and a attributes or the colour attribute instead.
3616
3617       .. code-block:: python
3618
3619          import struct;
3620          col = struct.unpack('4B', struct.pack('I', v.getRGBA()))
3621          # col = (r, g, b, a)
3622          # black = (  0, 0, 0, 255)
3623          # white = (255, 255, 255, 255)
3624
3625       :return: packed colour. 4 byte integer with one byte per colour channel in RGBA format.
3626       :rtype: integer
3627
3628    .. method:: setRGBA(col)
3629
3630       Sets the colour of this vertex.
3631
3632       See getRGBA() for the format of col, and its relevant problems.  Use the r, g, b and a attributes
3633       or the colour attribute instead.
3634
3635       setRGBA() also accepts a four component list as argument col.  The list represents the colour as [r, g, b, a]
3636       with black = [0.0, 0.0, 0.0, 1.0] and white = [1.0, 1.0, 1.0, 1.0]
3637
3638       .. code-block:: python
3639
3640          v.setRGBA(0xff0000ff) # Red
3641          v.setRGBA(0xff00ff00) # Green on little endian, transparent purple on big endian
3642          v.setRGBA([1.0, 0.0, 0.0, 1.0]) # Red
3643          v.setRGBA([0.0, 1.0, 0.0, 1.0]) # Green on all platforms.
3644
3645       :arg col: the new colour of this vertex in packed RGBA format.
3646       :type col: integer or list [r, g, b, a]
3647
3648    .. method:: getNormal()
3649
3650       Gets the normal vector of this vertex.
3651
3652       :return: normalised normal vector.
3653       :rtype: list [nx, ny, nz]
3654
3655    .. method:: setNormal(normal)
3656
3657       Sets the normal vector of this vertex.
3658
3659       :type:  sequence of floats [r, g, b]
3660
3661       :arg normal: the new normal of this vertex.
3662
3663 .. class:: KX_VisibilityActuator(SCA_IActuator)
3664
3665    Visibility Actuator.
3666
3667    .. attribute:: visibility
3668
3669       whether the actuator makes its parent object visible or invisible.
3670
3671       :type: boolean
3672
3673    .. attribute:: useOcclusion
3674
3675       whether the actuator makes its parent object an occluder or not.
3676
3677       :type: boolean
3678
3679    .. attribute:: useRecursion
3680
3681       whether the visibility/occlusion should be propagated to all children of the object.
3682
3683       :type: boolean
3684
3685 .. class:: SCA_2DFilterActuator(SCA_IActuator)
3686
3687    Create, enable and disable 2D filters
3688
3689    The following properties don't have an immediate effect.
3690    You must active the actuator to get the result.
3691    The actuator is not persistent: it automatically stops itself after setting up the filter
3692    but the filter remains active. To stop a filter you must activate the actuator with 'type'
3693    set to :data:`~bge.logic.RAS_2DFILTER_DISABLED` or :data:`~bge.logic.RAS_2DFILTER_NOFILTER`.
3694
3695    .. attribute:: shaderText
3696
3697       shader source code for custom shader.
3698
3699       :type: string
3700
3701    .. attribute:: disableMotionBlur
3702
3703       action on motion blur: 0=enable, 1=disable.
3704
3705       :type: integer
3706
3707    .. attribute:: mode
3708
3709       Type of 2D filter, use one of :ref:`these constants <Two-D-FilterActuator-mode>`
3710
3711       :type: integer
3712
3713    .. attribute:: passNumber
3714
3715       order number of filter in the stack of 2D filters. Filters are executed in increasing order of passNb.
3716
3717       Only be one filter can be defined per passNb.
3718
3719       :type: integer (0-100)
3720
3721    .. attribute:: value
3722
3723       argument for motion blur filter.
3724
3725       :type: float (0.0-100.0)
3726
3727 .. class:: SCA_ANDController(SCA_IController)
3728
3729    An AND controller activates only when all linked sensors are activated.
3730
3731    There are no special python methods for this controller.
3732
3733 .. class:: SCA_ActuatorSensor(SCA_ISensor)
3734
3735    Actuator sensor detect change in actuator state of the parent object.
3736    It generates a positive pulse if the corresponding actuator is activated
3737    and a negative pulse if the actuator is deactivated.
3738
3739    .. attribute:: actuator
3740
3741       the name of the actuator that the sensor is monitoring.
3742
3743       :type: string
3744
3745 .. class:: SCA_AlwaysSensor(SCA_ISensor)
3746
3747    This sensor is always activated.
3748
3749 .. class:: SCA_DelaySensor(SCA_ISensor)
3750
3751    The Delay sensor generates positive and negative triggers at precise time, 
3752    expressed in number of frames. The delay parameter defines the length of the initial OFF period. A positive trigger is generated at the end of this period.
3753
3754    The duration parameter defines the length of the ON period following the OFF period.
3755    There is a negative trigger at the end of the ON period. If duration is 0, the sensor stays ON and there is no negative trigger.
3756
3757    The sensor runs the OFF-ON cycle once unless the repeat option is set: the OFF-ON cycle repeats indefinately (or the OFF cycle if duration is 0).
3758
3759    Use :class:`SCA_ISensor.reset` at any time to restart sensor.
3760
3761    .. attribute:: delay
3762
3763       length of the initial OFF period as number of frame, 0 for immediate trigger.
3764
3765       :type: integer.
3766
3767    .. attribute:: duration
3768
3769       length of the ON period in number of frame after the initial OFF period.
3770
3771       If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.
3772
3773       :type: integer
3774
3775    .. attribute:: repeat
3776
3777       1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
3778
3779       :type: integer
3780
3781 .. class:: SCA_JoystickSensor(SCA_ISensor)
3782
3783    This sensor detects player joystick events.
3784
3785    .. attribute:: axisValues
3786
3787       The state of the joysticks axis as a list of values :data:`numAxis` long. (read-only).
3788
3789       :type: list of ints.
3790
3791       Each spesifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing.
3792       The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls.
3793
3794       * left:[-32767, 0, ...]
3795       * right:[32767, 0, ...]
3796       * up:[0, -32767, ...]
3797       * down:[0, 32767, ...]
3798
3799    .. attribute:: axisSingle
3800
3801       like :data:`axisValues` but returns a single axis value that is set by the sensor. (read-only).
3802
3803       :type: integer
3804
3805       .. note::
3806          
3807          Only use this for "Single Axis" type sensors otherwise it will raise an error.
3808
3809    .. attribute:: hatValues
3810
3811       The state of the joysticks hats as a list of values :data:`numHats` long. (read-only).
3812
3813       :type: list of ints
3814
3815       Each spesifying the direction of the hat from 1 to 12, 0 when inactive.
3816
3817       Hat directions are as follows...
3818
3819       * 0:None
3820       * 1:Up
3821       * 2:Right
3822       * 4:Down
3823       * 8:Left
3824       * 3:Up - Right
3825       * 6:Down - Right
3826       * 12:Down - Left
3827       * 9:Up - Left
3828
3829    .. attribute:: hatSingle
3830
3831       Like :data:`hatValues` but returns a single hat direction value that is set by the sensor. (read-only).
3832
3833       :type: integer
3834
3835    .. attribute:: numAxis
3836
3837       The number of axes for the joystick at this index. (read-only).
3838
3839       :type: integer
3840
3841    .. attribute:: numButtons
3842
3843       The number of buttons for the joystick at this index. (read-only).
3844
3845       :type: integer
3846
3847    .. attribute:: numHats
3848
3849       The number of hats for the joystick at this index. (read-only).
3850
3851       :type: integer
3852
3853    .. attribute:: connected
3854
3855       True if a joystick is connected at this joysticks index. (read-only).
3856
3857       :type: boolean
3858
3859    .. attribute:: index
3860
3861       The joystick index to use (from 0 to 7). The first joystick is always 0.
3862
3863       :type: integer
3864
3865    .. attribute:: threshold
3866
3867       Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
3868
3869       :type: integer
3870
3871    .. attribute:: button
3872
3873       The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
3874
3875       :type: integer
3876
3877    .. attribute:: axis
3878
3879       The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection]
3880
3881       * axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control.
3882       * axisDirection: 0=right, 1=up, 2=left, 3=down.
3883
3884       :type: [integer, integer]
3885
3886    .. attribute:: hat
3887
3888       The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]
3889
3890       * hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat (4 max).
3891       * hatDirection: 1-12.
3892
3893       :type: [integer, integer]
3894
3895    .. method:: getButtonActiveList()
3896
3897       :return: A list containing the indicies of the currently pressed buttons.
3898       :rtype: list
3899
3900    .. method:: getButtonStatus(buttonIndex)
3901
3902       :arg buttonIndex: the button index, 0=first button
3903       :type buttonIndex: integer
3904       :return: The current pressed state of the specified button.
3905       :rtype: boolean
3906
3907 .. class:: SCA_KeyboardSensor(SCA_ISensor)
3908
3909    A keyboard sensor detects player key presses.
3910
3911    See module :mod:`bge.keys` for keycode values.
3912
3913    .. attribute:: key
3914
3915       The key code this sensor is looking for.
3916