BGE animations: adding a missing comma.
[blender.git] / doc / python_api / rst / bge.types.rst
1
2 Game Types (bge.types)
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_MODE_PLAY, KX_ACTION_MODE_LOOP, or KX_ACTION_MODE_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       :rtype: float
1583       
1584    .. method:: setActionFrame(frame, layer=0)
1585    
1586       Set the current frame of the action playing in the supplied layer.
1587       
1588       :arg layer: The layer where you want to set the frame
1589       :type layer: integer
1590       :arg frame: The frame to set the action to
1591       :type frame: float
1592
1593    .. method:: isPlayingAction(layer=0)
1594    
1595        Checks to see if there is an action playing in the given layer.
1596        
1597        :arg layer: The layer to check for a playing action.
1598        :type layer: integer
1599        
1600        :return: Whether or not the action is playing
1601        :rtype: boolean
1602
1603 .. class:: KX_IpoActuator(SCA_IActuator)
1604
1605    IPO actuator activates an animation.
1606
1607    .. attribute:: frameStart
1608
1609       Start frame.
1610
1611       :type: float
1612
1613    .. attribute:: frameEnd
1614
1615       End frame.
1616
1617       :type: float
1618
1619    .. attribute:: propName
1620
1621       Use this property to define the Ipo position.
1622
1623       :type: string
1624
1625    .. attribute:: framePropName
1626
1627       Assign this property this action current frame number.
1628
1629       :type: string
1630
1631    .. attribute:: mode
1632
1633       Play mode for the ipo. Can be on of :ref:`these constants <ipo-actuator>`
1634
1635       :type: integer
1636
1637    .. attribute:: useIpoAsForce
1638
1639       Apply Ipo as a global or local force depending on the local option (dynamic objects only).
1640
1641       :type: boolean
1642
1643    .. attribute:: useIpoAdd
1644
1645       Ipo is added to the current loc/rot/scale in global or local coordinate according to Local flag.
1646
1647       :type: boolean
1648
1649    .. attribute:: useIpoLocal
1650
1651       Let the ipo acts in local coordinates, used in Force and Add mode.
1652
1653       :type: boolean
1654
1655    .. attribute:: useChildren
1656
1657       Update IPO on all children Objects as well.
1658
1659       :type: boolean
1660
1661 .. class:: KX_LightObject(KX_GameObject)
1662
1663    A Light object.
1664
1665    .. code-block:: python
1666
1667       # Turn on a red alert light.
1668       import bge
1669
1670       co = bge.logic.getCurrentController()
1671       light = co.owner
1672
1673       light.energy = 1.0
1674       light.colour = [1.0, 0.0, 0.0]
1675
1676    .. data:: SPOT
1677
1678       A spot light source. See attribute :data:`type`
1679
1680    .. data:: SUN
1681
1682       A point light source with no attenuation. See attribute :data:`type`
1683
1684    .. data:: NORMAL
1685
1686       A point light source. See attribute :data:`type`
1687
1688    .. attribute:: type
1689
1690       The type of light - must be SPOT, SUN or NORMAL
1691
1692    .. attribute:: layer
1693
1694       The layer mask that this light affects object on.
1695
1696       :type: bitfield
1697
1698    .. attribute:: energy
1699
1700       The brightness of this light.
1701
1702       :type: float
1703
1704    .. attribute:: distance
1705
1706       The maximum distance this light can illuminate. (SPOT and NORMAL lights only).
1707
1708       :type: float
1709
1710    .. attribute:: colour
1711
1712       The colour of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0].
1713
1714       :type: list [r, g, b]
1715
1716    .. attribute:: color
1717
1718       Synonym for colour.
1719
1720    .. attribute:: lin_attenuation
1721
1722       The linear component of this light's attenuation. (SPOT and NORMAL lights only).
1723
1724       :type: float
1725
1726    .. attribute:: quad_attenuation
1727
1728       The quadratic component of this light's attenuation (SPOT and NORMAL lights only).
1729
1730       :type: float
1731
1732    .. attribute:: spotsize
1733
1734       The cone angle of the spot light, in degrees (SPOT lights only).
1735
1736       :type: float in [0 - 180].
1737
1738    .. attribute:: spotblend
1739
1740       Specifies the intensity distribution of the spot light (SPOT lights only).
1741
1742       :type: float in [0 - 1]
1743
1744       .. note::
1745          
1746          Higher values result in a more focused light source.
1747
1748 .. class:: KX_MeshProxy(SCA_IObject)
1749
1750    A mesh object.
1751
1752    You can only change the vertex properties of a mesh object, not the mesh topology.
1753
1754    To use mesh objects effectively, you should know a bit about how the game engine handles them.
1755
1756    #. Mesh Objects are converted from Blender at scene load.
1757    #. The Converter groups polygons by Material.  This means they can be sent to the renderer efficiently.  A material holds:
1758
1759       #. The texture.
1760       #. The Blender material.
1761       #. The Tile properties
1762       #. The face properties - (From the "Texture Face" panel)
1763       #. Transparency & z sorting
1764       #. Light layer
1765       #. Polygon shape (triangle/quad)
1766       #. Game Object
1767
1768    #. Verticies will be split by face if necessary.  Verticies can only be shared between faces if:
1769
1770       #. They are at the same position
1771       #. UV coordinates are the same
1772       #. Their normals are the same (both polygons are "Set Smooth")
1773       #. They are the same colour, for example: a cube has 24 verticies: 6 faces with 4 verticies per face.
1774
1775    The correct method of iterating over every :class:`KX_VertexProxy` in a game object
1776    
1777    .. code-block:: python
1778
1779       import GameLogic
1780
1781       co = GameLogic.getCurrentController()
1782       obj = co.owner
1783
1784       m_i = 0
1785       mesh = obj.getMesh(m_i) # There can be more than one mesh...
1786       while mesh != None:
1787          for mat in range(mesh.getNumMaterials()):
1788             for v_index in range(mesh.getVertexArrayLength(mat)):
1789                vertex = mesh.getVertex(mat, v_index)
1790                # Do something with vertex here...
1791                # ... eg: colour the vertex red.
1792                vertex.colour = [1.0, 0.0, 0.0, 1.0]
1793          m_i += 1
1794          mesh = obj.getMesh(m_i)
1795
1796    .. attribute:: materials
1797
1798       :type: list of :class:`KX_BlenderMaterial` or :class:`KX_PolygonMaterial` types
1799
1800    .. attribute:: numPolygons
1801
1802       :type: integer
1803
1804    .. attribute:: numMaterials
1805
1806       :type: integer
1807
1808    .. method:: getNumMaterials()
1809
1810       :return: number of materials associated with this object
1811       :rtype: integer
1812
1813    .. method:: getMaterialName(matid)
1814
1815       Gets the name of the specified material.
1816
1817       :arg matid: the specified material.
1818       :type matid: integer
1819       :return: the attached material name.
1820       :rtype: string
1821
1822    .. method:: getTextureName(matid)
1823
1824       Gets the name of the specified material's texture.
1825
1826       :arg matid: the specified material
1827       :type matid: integer
1828       :return: the attached material's texture name.
1829       :rtype: string
1830
1831    .. method:: getVertexArrayLength(matid)
1832
1833       Gets the length of the vertex array associated with the specified material.
1834
1835       There is one vertex array for each material.
1836
1837       :arg matid: the specified material
1838       :type matid: integer
1839       :return: the number of verticies in the vertex array.
1840       :rtype: integer
1841
1842    .. method:: getVertex(matid, index)
1843
1844       Gets the specified vertex from the mesh object.
1845
1846       :arg matid: the specified material
1847       :type matid: integer
1848       :arg index: the index into the vertex array.
1849       :type index: integer
1850       :return: a vertex object.
1851       :rtype: :class:`KX_VertexProxy`
1852
1853    .. method:: getNumPolygons()
1854
1855       :return: The number of polygon in the mesh.
1856       :rtype: integer
1857
1858    .. method:: getPolygon(index)
1859
1860       Gets the specified polygon from the mesh.
1861
1862       :arg index: polygon number
1863       :type index: integer
1864       :return: a polygon object.
1865       :rtype: :class:`PolyProxy`
1866
1867 .. class:: SCA_MouseSensor(SCA_ISensor)
1868
1869    Mouse Sensor logic brick.
1870
1871    .. attribute:: position
1872
1873       current [x, y] coordinates of the mouse, in frame coordinates (pixels).
1874
1875       :type: [integer, interger]
1876
1877    .. attribute:: mode
1878
1879       sensor mode.
1880
1881       :type: integer
1882
1883          * KX_MOUSESENSORMODE_LEFTBUTTON(1)
1884          * KX_MOUSESENSORMODE_MIDDLEBUTTON(2)
1885          * KX_MOUSESENSORMODE_RIGHTBUTTON(3)
1886          * KX_MOUSESENSORMODE_WHEELUP(4)
1887          * KX_MOUSESENSORMODE_WHEELDOWN(5)
1888          * KX_MOUSESENSORMODE_MOVEMENT(6)
1889
1890    .. method:: getButtonStatus(button)
1891
1892       Get the mouse button status.
1893  
1894       :arg button: The code that represents the key you want to get the state of, use one of :ref:`these constants<mouse-keys>`
1895       :type button: int
1896       :return: The state of the given key, can be one of :ref:`these constants<input-status>`
1897       :rtype: int
1898
1899 .. class:: KX_MouseFocusSensor(SCA_MouseSensor)
1900
1901    The mouse focus sensor detects when the mouse is over the current game object.
1902
1903    The mouse focus sensor works by transforming the mouse coordinates from 2d device
1904    space to 3d space then raycasting away from the camera.
1905
1906    .. attribute:: raySource
1907
1908       The worldspace source of the ray (the view position).
1909
1910       :type: list (vector of 3 floats)
1911
1912    .. attribute:: rayTarget
1913
1914       The worldspace target of the ray.
1915
1916       :type: list (vector of 3 floats)
1917
1918    .. attribute:: rayDirection
1919
1920       The :data:`rayTarget` - :class:`raySource` normalized.
1921
1922       :type: list (normalized vector of 3 floats)
1923
1924    .. attribute:: hitObject
1925
1926       the last object the mouse was over.
1927
1928       :type: :class:`KX_GameObject` or None
1929
1930    .. attribute:: hitPosition
1931
1932       The worldspace position of the ray intersecton.
1933
1934       :type: list (vector of 3 floats)
1935
1936    .. attribute:: hitNormal
1937
1938       the worldspace normal from the face at point of intersection.
1939
1940       :type: list (normalized vector of 3 floats)
1941
1942    .. attribute:: hitUV
1943
1944       the UV coordinates at the point of intersection.
1945
1946       :type: list (vector of 2 floats)
1947
1948       If the object has no UV mapping, it returns [0, 0].
1949
1950       The UV coordinates are not normalized, they can be < 0 or > 1 depending on the UV mapping.
1951
1952    .. attribute:: usePulseFocus
1953
1954       When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set).
1955
1956       :type: boolean
1957
1958 .. class:: KX_TouchSensor(SCA_ISensor)
1959
1960    Touch sensor detects collisions between objects.
1961
1962    .. attribute:: propName
1963
1964       The property or material to collide with.
1965
1966       :type: string
1967
1968    .. attribute:: useMaterial
1969
1970       Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property.
1971
1972       :type: boolean
1973
1974    .. attribute:: usePulseCollision
1975
1976       When enabled, changes to the set of colliding objects generate a pulse.
1977
1978       :type: boolean
1979
1980    .. attribute:: hitObject
1981
1982       The last collided object. (read-only).
1983
1984       :type: :class:`KX_GameObject` or None
1985
1986    .. attribute:: hitObjectList
1987
1988       A list of colliding objects. (read-only).
1989
1990       :type: :class:`CListValue` of :class:`KX_GameObject`
1991
1992 .. class:: KX_NearSensor(KX_TouchSensor)
1993
1994    A near sensor is a specialised form of touch sensor.
1995
1996    .. attribute:: distance
1997
1998       The near sensor activates when an object is within this distance.
1999
2000       :type: float
2001
2002    .. attribute:: resetDistance
2003
2004       The near sensor deactivates when the object exceeds this distance.
2005
2006       :type: float
2007
2008 .. class:: KX_NetworkMessageActuator(SCA_IActuator)
2009
2010    Message Actuator
2011
2012    .. attribute:: propName
2013
2014       Messages will only be sent to objects with the given property name.
2015
2016       :type: string
2017
2018    .. attribute:: subject
2019
2020       The subject field of the message.
2021
2022       :type: string
2023
2024    .. attribute:: body
2025
2026       The body of the message.
2027
2028       :type: string
2029
2030    .. attribute:: usePropBody
2031
2032       Send a property instead of a regular body message.
2033
2034       :type: boolean
2035
2036 .. class:: KX_NetworkMessageSensor(SCA_ISensor)
2037
2038    The Message Sensor logic brick.
2039
2040    Currently only loopback (local) networks are supported.
2041
2042    .. attribute:: subject
2043
2044       The subject the sensor is looking for.
2045
2046       :type: string
2047
2048    .. attribute:: frameMessageCount
2049
2050       The number of messages received since the last frame. (read-only).
2051
2052       :type: integer
2053
2054    .. attribute:: subjects
2055
2056       The list of message subjects received. (read-only).
2057
2058       :type: list of strings
2059
2060    .. attribute:: bodies
2061
2062       The list of message bodies received. (read-only).
2063
2064       :type: list of strings
2065
2066 .. class:: KX_ObjectActuator(SCA_IActuator)
2067
2068    The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement, 
2069    velocity, or angular velocity to an object.
2070    Servo control allows to regulate force to achieve a certain speed target.
2071
2072    .. attribute:: force
2073
2074       The force applied by the actuator.
2075
2076       :type: list [x, y, z]
2077
2078    .. attribute:: useLocalForce
2079
2080       A flag specifying if the force is local.
2081
2082       :type: boolean
2083
2084    .. attribute:: torque
2085
2086       The torque applied by the actuator.
2087
2088       :type: list [x, y, z]
2089
2090    .. attribute:: useLocalTorque
2091
2092       A flag specifying if the torque is local.
2093
2094       :type: boolean
2095
2096    .. attribute:: dLoc
2097
2098       The displacement vector applied by the actuator.
2099
2100       :type: list [x, y, z]
2101
2102    .. attribute:: useLocalDLoc
2103
2104       A flag specifying if the dLoc is local.
2105
2106       :type: boolean
2107
2108    .. attribute:: dRot
2109
2110       The angular displacement vector applied by the actuator
2111
2112       :type: list [x, y, z]
2113       
2114       .. note::
2115       
2116          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.
2117
2118    .. attribute:: useLocalDRot
2119
2120       A flag specifying if the dRot is local.
2121
2122       :type: boolean
2123
2124    .. attribute:: linV
2125
2126       The linear velocity applied by the actuator.
2127
2128       :type: list [x, y, z]
2129
2130    .. attribute:: useLocalLinV
2131
2132       A flag specifying if the linear velocity is local.
2133
2134       :type: boolean
2135       
2136       .. note::
2137       
2138          This is the target speed for servo controllers.
2139
2140    .. attribute:: angV
2141
2142       The angular velocity applied by the actuator.
2143
2144       :type: list [x, y, z]
2145
2146    .. attribute:: useLocalAngV
2147
2148       A flag specifying if the angular velocity is local.
2149
2150       :type: boolean
2151
2152    .. attribute:: damping
2153
2154       The damping parameter of the servo controller.
2155
2156       :type: short
2157
2158    .. attribute:: forceLimitX
2159
2160       The min/max force limit along the X axis and activates or deactivates the limits in the servo controller.
2161
2162       :type: list [min(float), max(float), bool]
2163
2164    .. attribute:: forceLimitY
2165
2166       The min/max force limit along the Y axis and activates or deactivates the limits in the servo controller.
2167
2168       :type: list [min(float), max(float), bool]
2169
2170    .. attribute:: forceLimitZ
2171
2172       The min/max force limit along the Z axis and activates or deactivates the limits in the servo controller.
2173
2174       :type: list [min(float), max(float), bool]
2175
2176    .. attribute:: pid
2177
2178       The PID coefficients of the servo controller.
2179
2180       :type: list of floats [proportional, integral, derivate]
2181
2182    .. attribute:: reference
2183
2184       The object that is used as reference to compute the velocity for the servo controller.
2185
2186       :type: :class:`KX_GameObject` or None
2187
2188 .. class:: KX_ParentActuator(SCA_IActuator)
2189
2190    The parent actuator can set or remove an objects parent object.
2191
2192    .. attribute:: object
2193
2194       the object this actuator sets the parent too.
2195
2196       :type: :class:`KX_GameObject` or None
2197
2198    .. attribute:: mode
2199
2200       The mode of this actuator.
2201
2202       :type: integer from 0 to 1.
2203
2204    .. attribute:: compound
2205
2206       Whether the object shape should be added to the parent compound shape when parenting.
2207
2208       Effective only if the parent is already a compound shape.
2209
2210       :type: boolean
2211
2212    .. attribute:: ghost
2213
2214       Whether the object should be made ghost when parenting
2215       Effective only if the shape is not added to the parent compound shape.
2216
2217       :type: boolean
2218
2219 .. class:: KX_PhysicsObjectWrapper(PyObjectPlus)
2220
2221    KX_PhysicsObjectWrapper
2222
2223    .. method:: setActive(active)
2224
2225       Set the object to be active.
2226
2227       :arg active: set to True to be active
2228       :type active: boolean
2229
2230    .. method:: setAngularVelocity(x, y, z, local)
2231
2232       Set the angular velocity of the object.
2233
2234       :arg x: angular velocity for the x-axis
2235       :type x: float
2236
2237       :arg y: angular velocity for the y-axis
2238       :type y: float
2239
2240       :arg z: angular velocity for the z-axis
2241       :type z: float
2242
2243       :arg local: set to True for local axis
2244       :type local: boolean
2245
2246    .. method:: setLinearVelocity(x, y, z, local)
2247
2248       Set the linear velocity of the object.
2249
2250       :arg x: linear velocity for the x-axis
2251       :type x: float
2252
2253       :arg y: linear velocity for the y-axis
2254       :type y: float
2255
2256       :arg z: linear velocity for the z-axis
2257       :type z: float
2258
2259       :arg local: set to True for local axis
2260       :type local: boolean
2261
2262 .. class:: KX_PolyProxy(SCA_IObject)
2263
2264    A polygon holds the index of the vertex forming the poylgon.
2265
2266    Note:
2267    The polygon attributes are read-only, you need to retrieve the vertex proxy if you want
2268    to change the vertex settings.
2269
2270    .. attribute:: matname
2271
2272       The name of polygon material, empty if no material.
2273
2274       :type: string
2275
2276    .. attribute:: material
2277
2278       The material of the polygon.
2279
2280       :type: :class:`KX_PolygonMaterial` or :class:`KX_BlenderMaterial`
2281
2282    .. attribute:: texture
2283
2284       The texture name of the polygon.
2285
2286       :type: string
2287
2288    .. attribute:: matid
2289
2290       The material index of the polygon, use this to retrieve vertex proxy from mesh proxy.
2291
2292       :type: integer
2293
2294    .. attribute:: v1
2295
2296       vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
2297
2298       :type: integer
2299
2300    .. attribute:: v2
2301
2302       vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
2303
2304       :type: integer
2305
2306    .. attribute:: v3
2307
2308       vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
2309
2310       :type: integer
2311
2312    .. attribute:: v4
2313
2314       Vertex index of the fourth vertex of the polygon, 0 if polygon has only 3 vertex
2315       Use this to retrieve vertex proxy from mesh proxy.
2316
2317       :type: integer
2318
2319    .. attribute:: visible
2320
2321       visible state of the polygon: 1=visible, 0=invisible.
2322
2323       :type: integer
2324
2325    .. attribute:: collide
2326
2327       collide state of the polygon: 1=receives collision, 0=collision free.
2328
2329       :type: integer
2330
2331    .. method:: getMaterialName()
2332
2333       Returns the polygon material name with MA prefix
2334
2335       :return: material name
2336       :rtype: string
2337
2338    .. method:: getMaterial()
2339
2340       :return: The polygon material
2341       :rtype: :class:`KX_PolygonMaterial` or :class:`KX_BlenderMaterial`
2342
2343    .. method:: getTextureName()
2344
2345       :return: The texture name
2346       :rtype: string
2347
2348    .. method:: getMaterialIndex()
2349
2350       Returns the material bucket index of the polygon.
2351       This index and the ones returned by getVertexIndex() are needed to retrieve the vertex proxy from :class:`MeshProxy`.
2352
2353       :return: the material index in the mesh
2354       :rtype: integer
2355
2356    .. method:: getNumVertex()
2357
2358       Returns the number of vertex of the polygon.
2359
2360       :return: number of vertex, 3 or 4.
2361       :rtype: integer
2362
2363    .. method:: isVisible()
2364
2365       Returns whether the polygon is visible or not
2366
2367       :return: 0=invisible, 1=visible
2368       :rtype: boolean
2369
2370    .. method:: isCollider()
2371
2372       Returns whether the polygon is receives collision or not
2373
2374       :return: 0=collision free, 1=receives collision
2375       :rtype: integer
2376
2377    .. method:: getVertexIndex(vertex)
2378
2379       Returns the mesh vertex index of a polygon vertex
2380       This index and the one returned by getMaterialIndex() are needed to retrieve the vertex proxy from :class:`MeshProxy`.
2381
2382       :arg vertex: index of the vertex in the polygon: 0->3
2383       :arg vertex: integer
2384       :return: mesh vertex index
2385       :rtype: integer
2386
2387    .. method:: getMesh()
2388
2389       Returns a mesh proxy
2390
2391       :return: mesh proxy
2392       :rtype: :class:`MeshProxy`
2393
2394 .. class:: KX_PolygonMaterial(PyObjectPlus)
2395
2396    This is the interface to materials in the game engine.
2397
2398    Materials define the render state to be applied to mesh objects.
2399
2400    .. warning::
2401
2402       Some of the methods/variables are CObjects.  If you mix these up, you will crash blender.
2403
2404    This example requires `PyOpenGL <http://pyopengl.sourceforge.net>`_ and `GLEWPy <http://glewpy.sourceforge.net>`_
2405
2406    .. code-block:: python
2407
2408       import GameLogic
2409       import OpenGL
2410       from OpenGL.GL import *
2411       from OpenGL.GLU import *
2412       import glew
2413       from glew import *
2414       
2415       glewInit()
2416       
2417       vertex_shader = """
2418       
2419       void main(void)
2420       {
2421          gl_Position = ftransform();
2422       }
2423       """
2424       
2425       fragment_shader ="""
2426       
2427       void main(void)
2428       {
2429          gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0);
2430       }
2431       """
2432       
2433       class MyMaterial:
2434          def __init__(self):
2435             self.pass_no = 0
2436             # Create a shader
2437             self.m_program = glCreateProgramObjectARB()
2438             # Compile the vertex shader
2439             self.shader(GL_VERTEX_SHADER_ARB, (vertex_shader))
2440             # Compile the fragment shader
2441             self.shader(GL_FRAGMENT_SHADER_ARB, (fragment_shader))
2442             # Link the shaders together
2443             self.link()
2444             
2445          def PrintInfoLog(self, tag, object):
2446             """
2447             PrintInfoLog prints the GLSL compiler log
2448             """
2449             print "Tag:    def PrintGLError(self, tag = ""):
2450             
2451          def PrintGLError(self, tag = ""):
2452             """
2453             Prints the current GL error status
2454             """
2455             if len(tag):
2456                print tag
2457             err = glGetError()
2458             if err != GL_NO_ERROR:
2459                print "GL Error: %s\\n"%(gluErrorString(err))
2460       
2461          def shader(self, type, shaders):
2462             """
2463             shader compiles a GLSL shader and attaches it to the current
2464             program.
2465             
2466             type should be either GL_VERTEX_SHADER_ARB or GL_FRAGMENT_SHADER_ARB
2467             shaders should be a sequence of shader source to compile.
2468             """
2469             # Create a shader object
2470             shader_object = glCreateShaderObjectARB(type)
2471       
2472             # Add the source code
2473             glShaderSourceARB(shader_object, len(shaders), shaders)
2474             
2475             # Compile the shader
2476             glCompileShaderARB(shader_object)
2477             
2478             # Print the compiler log
2479             self.PrintInfoLog("vertex shader", shader_object)
2480             
2481             # Check if compiled, and attach if it did
2482             compiled = glGetObjectParameterivARB(shader_object, GL_OBJECT_COMPILE_STATUS_ARB)
2483             if compiled:
2484                glAttachObjectARB(self.m_program, shader_object)
2485                
2486             # Delete the object (glAttachObjectARB makes a copy)
2487             glDeleteObjectARB(shader_object)
2488             
2489             # print the gl error log
2490             self.PrintGLError()
2491             
2492          def link(self):
2493             """
2494             Links the shaders together.
2495             """
2496             # clear error indicator
2497             glGetError()
2498             
2499             glLinkProgramARB(self.m_program)
2500       
2501             self.PrintInfoLog("link", self.m_program)
2502          
2503             linked = glGetObjectParameterivARB(self.m_program, GL_OBJECT_LINK_STATUS_ARB)
2504             if not linked:
2505                print "Shader failed to link"
2506                return
2507       
2508             glValidateProgramARB(self.m_program)
2509             valid = glGetObjectParameterivARB(self.m_program, GL_OBJECT_VALIDATE_STATUS_ARB)
2510             if not valid:
2511                print "Shader failed to validate"
2512                return
2513             
2514          def activate(self, rasty, cachingInfo, mat):
2515             self.pass_no+=1
2516             if (self.pass_no == 1):
2517                glDisable(GL_COLOR_MATERIAL)
2518                glUseProgramObjectARB(self.m_program)
2519                return True
2520             
2521             glEnable(GL_COLOR_MATERIAL)
2522             glUseProgramObjectARB(0)
2523             self.pass_no = 0   
2524             return False
2525
2526       obj = GameLogic.getCurrentController().owner
2527       
2528       mesh = obj.meshes[0]
2529       
2530       for mat in mesh.materials:
2531          mat.setCustomMaterial(MyMaterial())
2532          print mat.texture
2533
2534    .. attribute:: texture
2535
2536       Texture name.
2537
2538       :type: string (read-only)
2539
2540    .. attribute:: gl_texture
2541
2542       OpenGL texture handle (eg for glBindTexture(GL_TEXTURE_2D, gl_texture).
2543
2544       :type: integer (read-only)
2545
2546    .. attribute:: material
2547
2548       Material name.
2549
2550       :type: string (read-only)
2551
2552    .. attribute:: tface
2553
2554       Texture face properties.
2555
2556       :type: CObject (read-only)
2557
2558    .. attribute:: tile
2559
2560       Texture is tiling.
2561
2562       :type: boolean
2563
2564    .. attribute:: tilexrep
2565
2566       Number of tile repetitions in x direction.
2567
2568       :type: integer
2569
2570    .. attribute:: tileyrep
2571
2572       Number of tile repetitions in y direction.
2573
2574       :type: integer
2575
2576    .. attribute:: drawingmode
2577
2578       Drawing mode for the material.
2579       - 2  (drawingmode & 4)     Textured
2580       - 4  (drawingmode & 16)    Light
2581       - 14 (drawingmode & 16384) 3d Polygon Text.
2582
2583       :type: bitfield
2584
2585    .. attribute:: transparent
2586
2587       This material is transparent. All meshes with this
2588       material will be rendered after non transparent meshes from back
2589       to front.
2590
2591       :type: boolean
2592
2593    .. attribute:: zsort
2594
2595       Transparent polygons in meshes with this material will be sorted back to
2596       front before rendering.
2597       Non-Transparent polygons will be sorted front to back before rendering.
2598
2599       :type: boolean
2600
2601    .. attribute:: lightlayer
2602
2603       Light layers this material affects.
2604
2605       :type: bitfield.
2606
2607    .. attribute:: triangle
2608
2609       Mesh data with this material is triangles. It's probably not safe to change this.
2610
2611       :type: boolean
2612
2613    .. attribute:: diffuse
2614
2615       The diffuse colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0].
2616
2617       :type: list [r, g, b]
2618
2619    .. attribute:: specular
2620
2621       The specular colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0].
2622
2623       :type: list [r, g, b]
2624
2625    .. attribute:: shininess
2626
2627       The shininess (specular exponent) of the material. 0.0 <= shininess <= 128.0.
2628
2629       :type: float
2630
2631    .. attribute:: specularity
2632
2633       The amount of specular of the material. 0.0 <= specularity <= 1.0.
2634
2635       :type: float
2636
2637    .. method:: updateTexture(tface, rasty)
2638
2639       Updates a realtime animation.
2640
2641       :arg tface: Texture face (eg mat.tface)
2642       :type tface: CObject
2643       :arg rasty: Rasterizer
2644       :type rasty: CObject
2645
2646    .. method:: setTexture(tface)
2647
2648       Sets texture render state.
2649
2650       :arg tface: Texture face
2651       :type tface: CObject
2652
2653       .. code-block:: python
2654
2655          mat.setTexture(mat.tface)
2656          
2657    .. method:: activate(rasty, cachingInfo)
2658
2659       Sets material parameters for this object for rendering.
2660
2661       Material Parameters set:
2662
2663       #. Texture
2664       #. Backface culling
2665       #. Line drawing
2666       #. Specular Colour
2667       #. Shininess
2668       #. Diffuse Colour
2669       #. Polygon Offset.
2670
2671       :arg rasty: Rasterizer instance.
2672       :type rasty: CObject
2673       :arg cachingInfo: Material cache instance.
2674       :type cachingInfo: CObject
2675
2676    .. method:: setCustomMaterial(material)
2677
2678       Sets the material state setup object.
2679
2680       Using this method, you can extend or completely replace the gameengine material
2681       to do your own advanced multipass effects.
2682
2683       Use this method to register your material class.  Instead of the normal material, 
2684       your class's activate method will be called just before rendering the mesh.
2685       This should setup the texture, material, and any other state you would like.
2686       It should return True to render the mesh, or False if you are finished.  You should
2687       clean up any state Blender does not set before returning False.
2688
2689       Activate Method Definition:
2690
2691       .. code-block:: python
2692       
2693          def activate(self, rasty, cachingInfo, material):
2694
2695       :arg material: The material object.
2696       :type material: instance
2697
2698       .. code-block:: python
2699
2700          class PyMaterial:
2701            def __init__(self):
2702              self.pass_no = -1
2703            
2704            def activate(self, rasty, cachingInfo, material):
2705              # Activate the material here.
2706              #
2707              # The activate method will be called until it returns False.
2708              # Every time the activate method returns True the mesh will
2709              # be rendered.
2710              #
2711              # rasty is a CObject for passing to material.updateTexture() 
2712              #       and material.activate()
2713              # cachingInfo is a CObject for passing to material.activate()
2714              # material is the KX_PolygonMaterial instance this material
2715              #          was added to
2716              
2717              # default material properties:
2718              self.pass_no += 1
2719              if self.pass_no == 0:
2720                material.activate(rasty, cachingInfo)
2721                # Return True to do this pass
2722                return True
2723              
2724              # clean up and return False to finish.
2725              self.pass_no = -1
2726              return False
2727          
2728          # Create a new Python Material and pass it to the renderer.
2729          mat.setCustomMaterial(PyMaterial())
2730          
2731 .. class:: KX_RadarSensor(KX_NearSensor)
2732
2733    Radar sensor is a near sensor with a conical sensor object.
2734
2735    .. attribute:: coneOrigin
2736
2737       The origin of the cone with which to test. The origin is in the middle of the cone. (read-only).
2738
2739       :type: list of floats [x, y, z]
2740
2741    .. attribute:: coneTarget
2742
2743       The center of the bottom face of the cone with which to test. (read-only).
2744
2745       :type: list of floats [x, y, z]
2746
2747    .. attribute:: distance
2748
2749       The height of the cone with which to test.
2750
2751       :type: float
2752
2753    .. attribute:: angle
2754
2755       The angle of the cone (in degrees) with which to test.
2756
2757       :type: float from 0 to 360
2758
2759    .. attribute:: axis
2760
2761       The axis on which the radar cone is cast.
2762
2763       :type: integer from 0 to 5
2764
2765       KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z, 
2766       KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
2767
2768    .. method:: getConeHeight()
2769
2770       :return: The height of the cone with which to test.
2771       :rtype: float
2772
2773 .. class:: KX_RaySensor(SCA_ISensor)
2774
2775    A ray sensor detects the first object in a given direction.
2776
2777    .. attribute:: propName
2778
2779       The property the ray is looking for.
2780
2781       :type: string
2782
2783    .. attribute:: range
2784
2785       The distance of the ray.
2786
2787       :type: float
2788
2789    .. attribute:: useMaterial
2790
2791       Whether or not to look for a material (false = property).
2792
2793       :type: boolean
2794
2795    .. attribute:: useXRay
2796
2797       Whether or not to use XRay.
2798
2799       :type: boolean
2800
2801    .. attribute:: hitObject
2802
2803       The game object that was hit by the ray. (read-only).
2804
2805       :type: :class:`KX_GameObject`
2806
2807    .. attribute:: hitPosition
2808
2809       The position (in worldcoordinates) where the object was hit by the ray. (read-only).
2810
2811       :type: list [x, y, z]
2812
2813    .. attribute:: hitNormal
2814
2815       The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (read-only).
2816
2817       :type: list [x, y, z]
2818
2819    .. attribute:: rayDirection
2820
2821       The direction from the ray (in worldcoordinates). (read-only).
2822
2823       :type: list [x, y, z]
2824
2825    .. attribute:: axis
2826
2827       The axis the ray is pointing on.
2828
2829       :type: integer from 0 to 5
2830
2831       * KX_RAY_AXIS_POS_X
2832       * KX_RAY_AXIS_POS_Y
2833       * KX_RAY_AXIS_POS_Z
2834       * KX_RAY_AXIS_NEG_X
2835       * KX_RAY_AXIS_NEG_Y
2836       * KX_RAY_AXIS_NEG_Z
2837
2838 .. class:: KX_SCA_AddObjectActuator(SCA_IActuator)
2839
2840    Edit Object Actuator (in Add Object Mode)
2841
2842    .. warning::
2843
2844       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.
2845
2846       .. code-block:: none
2847
2848          Error: GameObject 'Name' has a AddObjectActuator 'ActuatorName' without object (in 'nonactive' layer) 
2849       
2850    .. attribute:: object
2851
2852       the object this actuator adds.
2853
2854       :type: :class:`KX_GameObject` or None
2855
2856    .. attribute:: objectLastCreated
2857
2858       the last added object from this actuator (read-only).
2859
2860       :type: :class:`KX_GameObject` or None
2861
2862    .. attribute:: time
2863
2864       the lifetime of added objects, in frames. Set to 0 to disable automatic deletion.
2865
2866       :type: integer
2867
2868    .. attribute:: linearVelocity
2869
2870       the initial linear velocity of added objects.
2871
2872       :type: list [vx, vy, vz]
2873
2874    .. attribute:: angularVelocity
2875
2876       the initial angular velocity of added objects.
2877
2878       :type: list [vx, vy, vz]
2879
2880    .. method:: instantAddObject()
2881
2882       adds the object without needing to calling SCA_PythonController.activate()
2883           
2884           .. note:: Use objectLastCreated to get the newly created object.
2885
2886 .. class:: KX_SCA_DynamicActuator(SCA_IActuator)
2887
2888    Dynamic Actuator.
2889
2890    .. attribute:: mode
2891
2892       :type: integer
2893
2894       the type of operation of the actuator, 0-4
2895
2896       * KX_DYN_RESTORE_DYNAMICS(0)
2897       * KX_DYN_DISABLE_DYNAMICS(1)
2898       * KX_DYN_ENABLE_RIGID_BODY(2)
2899       * KX_DYN_DISABLE_RIGID_BODY(3)
2900       * KX_DYN_SET_MASS(4)
2901
2902    .. attribute:: mass
2903
2904       the mass value for the KX_DYN_SET_MASS operation.
2905
2906       :type: float
2907
2908 .. class:: KX_SCA_EndObjectActuator(SCA_IActuator)
2909
2910    Edit Object Actuator (in End Object mode)
2911
2912    This actuator has no python methods.
2913
2914 .. class:: KX_SCA_ReplaceMeshActuator(SCA_IActuator)
2915
2916    Edit Object actuator, in Replace Mesh mode.
2917
2918    .. warning::
2919
2920       Replace mesh actuators will be ignored if at game start, the named mesh doesn't exist.
2921
2922       This will generate a warning in the console
2923
2924       .. code-block:: none
2925       
2926          Error: GameObject 'Name' ReplaceMeshActuator 'ActuatorName' without object
2927
2928    .. code-block:: python
2929
2930       # Level-of-detail
2931       # Switch a game object's mesh based on its depth in the camera view.
2932       # +----------+     +-----------+     +-------------------------------------+
2933       # | Always   +-----+ Python    +-----+ Edit Object (Replace Mesh) LOD.Mesh |
2934       # +----------+     +-----------+     +-------------------------------------+
2935       import GameLogic
2936
2937       # List detail meshes here
2938       # Mesh (name, near, far)
2939       # Meshes overlap so that they don't 'pop' when on the edge of the distance.
2940       meshes = ((".Hi", 0.0, -20.0),
2941             (".Med", -15.0, -50.0),
2942             (".Lo", -40.0, -100.0)
2943           )
2944       
2945       co = GameLogic.getCurrentController()
2946       obj = co.owner
2947       act = co.actuators["LOD." + obj.name]
2948       cam = GameLogic.getCurrentScene().active_camera
2949       
2950       def Depth(pos, plane):
2951         return pos[0]*plane[0] + pos[1]*plane[1] + pos[2]*plane[2] + plane[3]
2952       
2953       # Depth is negative and decreasing further from the camera
2954       depth = Depth(obj.position, cam.world_to_camera[2])
2955       
2956       newmesh = None
2957       curmesh = None
2958       # Find the lowest detail mesh for depth
2959       for mesh in meshes:
2960         if depth < mesh[1] and depth > mesh[2]:
2961           newmesh = mesh
2962         if "ME" + obj.name + mesh[0] == act.getMesh():
2963             curmesh = mesh
2964       
2965       if newmesh != None and "ME" + obj.name + newmesh[0] != act.getMesh():
2966         # The mesh is a different mesh - switch it.
2967         # Check the current mesh is not a better fit.
2968         if curmesh == None or curmesh[1] < depth or curmesh[2] > depth:
2969           act.mesh = obj.getName() + newmesh[0]
2970           GameLogic.addActiveActuator(act, True)
2971
2972    .. attribute:: mesh
2973
2974       :class:`MeshProxy` or the name of the mesh that will replace the current one.
2975    
2976       Set to None to disable actuator.
2977
2978       :type: :class:`MeshProxy` or None if no mesh is set
2979
2980    .. attribute:: useDisplayMesh
2981
2982       when true the displayed mesh is replaced.
2983
2984       :type: boolean
2985
2986    .. attribute:: usePhysicsMesh
2987
2988       when true the physics mesh is replaced.
2989
2990       :type: boolean
2991
2992    .. method:: instantReplaceMesh()
2993
2994       Immediately replace mesh without delay.
2995
2996 .. class:: KX_Scene(PyObjectPlus)
2997
2998    An active scene that gives access to objects, cameras, lights and scene attributes.
2999
3000    The activity culling stuff is supposed to disable logic bricks when their owner gets too far
3001    from the active camera.  It was taken from some code lurking at the back of KX_Scene - who knows
3002    what it does!
3003
3004    .. code-block:: python
3005
3006       import GameLogic
3007
3008       # get the scene
3009       scene = GameLogic.getCurrentScene()
3010
3011       # print all the objects in the scene
3012       for obj in scene.objects:
3013          print obj.name
3014
3015       # get an object named 'Cube'
3016       obj = scene.objects["Cube"]
3017
3018       # get the first object in the scene.
3019       obj = scene.objects[0]
3020
3021    .. code-block:: python
3022
3023       # Get the depth of an object in the camera view.
3024       import GameLogic
3025
3026       obj = GameLogic.getCurrentController().owner
3027       cam = GameLogic.getCurrentScene().active_camera
3028
3029       # Depth is negative and decreasing further from the camera
3030       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]
3031
3032    @bug: All attributes are read only at the moment.
3033
3034    .. attribute:: name
3035
3036       The scene's name, (read-only).
3037
3038       :type: string
3039
3040    .. attribute:: objects
3041
3042       A list of objects in the scene, (read-only).
3043
3044       :type: :class:`CListValue` of :class:`KX_GameObject`
3045
3046    .. attribute:: objectsInactive
3047
3048       A list of objects on background layers (used for the addObject actuator), (read-only).
3049
3050       :type: :class:`CListValue` of :class:`KX_GameObject`
3051
3052    .. attribute:: lights
3053
3054       A list of lights in the scene, (read-only).
3055
3056       :type: :class:`CListValue` of :class:`KX_LightObject`
3057
3058    .. attribute:: cameras
3059
3060       A list of cameras in the scene, (read-only).
3061
3062       :type: :class:`CListValue` of :class:`KX_Camera`
3063
3064    .. attribute:: active_camera
3065
3066       The current active camera.
3067
3068       :type: :class:`KX_Camera`
3069       
3070       .. note::
3071          
3072          This can be set directly from python to avoid using the :class:`KX_SceneActuator`.
3073
3074    .. attribute:: suspended
3075
3076       True if the scene is suspended, (read-only).
3077
3078       :type: boolean
3079
3080    .. attribute:: activity_culling
3081
3082       True if the scene is activity culling.
3083
3084       :type: boolean
3085
3086    .. attribute:: activity_culling_radius
3087
3088       The distance outside which to do activity culling. Measured in manhattan distance.
3089
3090       :type: float
3091
3092    .. attribute:: dbvt_culling
3093
3094       True when Dynamic Bounding box Volume Tree is set (read-only).
3095
3096       :type: boolean
3097
3098    .. attribute:: pre_draw
3099
3100       A list of callables to be run before the render step.
3101
3102       :type: list
3103
3104    .. attribute:: post_draw
3105
3106       A list of callables to be run after the render step.
3107
3108       :type: list
3109
3110    .. method:: addObject(object, other, time=0)
3111
3112       Adds an object to the scene like the Add Object Actuator would.
3113
3114       :arg object: The object to add
3115       :type object: :class:`KX_GameObject` or string
3116       :arg other: The object's center to use when adding the object
3117       :type other: :class:`KX_GameObject` or string
3118       :arg time: The lifetime of the added object, in frames. A time of 0 means the object will last forever.
3119       :type time: integer
3120       :return: The newly added object.
3121       :rtype: :class:`KX_GameObject`
3122
3123    .. method:: end()
3124
3125       Removes the scene from the game.
3126
3127    .. method:: restart()
3128
3129       Restarts the scene.
3130
3131    .. method:: replace(scene)
3132
3133       Replaces this scene with another one.
3134
3135       :arg scene: The name of the scene to replace this scene with.
3136       :type scene: string
3137
3138    .. method:: suspend()
3139
3140       Suspends this scene.
3141
3142    .. method:: resume()
3143
3144       Resume this scene.
3145
3146    .. method:: get(key, default=None)
3147
3148       Return the value matching key, or the default value if its not found.
3149       :return: The key value or a default.
3150
3151 .. class:: KX_SceneActuator(SCA_IActuator)
3152
3153    Scene Actuator logic brick.
3154
3155    .. warning::
3156
3157       Scene actuators that use a scene name will be ignored if at game start, the named scene doesn't exist or is empty
3158
3159       This will generate a warning in the console:
3160
3161       .. code-block:: none
3162       
3163          Error: GameObject 'Name' has a SceneActuator 'ActuatorName' (SetScene) without scene
3164
3165    .. attribute:: scene
3166
3167       the name of the scene to change to/overlay/underlay/remove/suspend/resume.
3168
3169       :type: string
3170
3171    .. attribute:: camera
3172
3173       the camera to change to.
3174
3175       :type: :class:`KX_Camera` on read, string or :class:`KX_Camera` on write
3176       
3177       .. note::
3178          
3179          When setting the attribute, you can use either a :class:`KX_Camera` or the name of the camera.
3180
3181    .. attribute:: useRestart
3182
3183       Set flag to True to restart the sene.
3184
3185       :type: boolean
3186
3187    .. attribute:: mode
3188
3189       The mode of the actuator.
3190
3191       :type: integer from 0 to 5.
3192
3193 .. class:: KX_SoundActuator(SCA_IActuator)
3194
3195    Sound Actuator.
3196
3197    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.
3198
3199    .. attribute:: fileName
3200
3201       The filename of the sound this actuator plays.
3202
3203       :type: string
3204
3205    .. attribute:: volume
3206
3207       The volume (gain) of the sound.
3208
3209       :type: float
3210
3211    .. attribute:: pitch
3212
3213       The pitch of the sound.
3214
3215       :type: float
3216
3217    .. attribute:: rollOffFactor
3218
3219       The roll off factor. Rolloff defines the rate of attenuation as the sound gets further away.
3220
3221       :type: float
3222
3223    .. attribute:: looping
3224
3225       The loop mode of the actuator.
3226
3227       :type: integer
3228
3229    .. attribute:: position
3230
3231       The position of the sound as a list: [x, y, z].
3232
3233       :type: float array
3234
3235    .. attribute:: velocity
3236
3237       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].
3238
3239       :type: float array
3240
3241    .. attribute:: orientation
3242
3243       The orientation of the sound. When setting the orientation you can also use quaternion [float, float, float, float] or euler angles [float, float, float].
3244
3245       :type: 3x3 matrix [[float]]
3246
3247    .. attribute:: mode
3248
3249       The operation mode of the actuator. Can be one of :ref:`these constants<logic-sound-actuator>`
3250
3251       :type: integer
3252
3253 .. class:: KX_StateActuator(SCA_IActuator)
3254
3255    State actuator changes the state mask of parent object.
3256
3257    .. attribute:: operation
3258
3259       Type of bit operation to be applied on object state mask.
3260       
3261       You can use one of :ref:`these constants <state-actuator-operation>`
3262
3263       :type: integer
3264
3265    .. attribute:: mask
3266
3267       Value that defines the bits that will be modified by the operation.
3268
3269       The bits that are 1 in the mask will be updated in the object state.
3270
3271       The bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state.
3272
3273       :type: integer
3274
3275 .. class:: KX_TrackToActuator(SCA_IActuator)
3276
3277    Edit Object actuator in Track To mode.
3278
3279    .. warning::
3280    
3281       Track To Actuators will be ignored if at game start, the object to track to is invalid.
3282
3283       This will generate a warning in the console:
3284
3285       .. code-block:: none
3286
3287          GameObject 'Name' no object in EditObjectActuator 'ActuatorName'
3288
3289    .. attribute:: object
3290
3291       the object this actuator tracks.
3292
3293       :type: :class:`KX_GameObject` or None
3294
3295    .. attribute:: time
3296
3297       the time in frames with which to delay the tracking motion.
3298
3299       :type: integer
3300
3301    .. attribute:: use3D
3302
3303       the tracking motion to use 3D.
3304
3305       :type: boolean
3306
3307 .. class:: KX_VehicleWrapper(PyObjectPlus)
3308
3309    KX_VehicleWrapper
3310
3311    TODO - description
3312
3313    .. method:: addWheel(wheel, attachPos, attachDir, axleDir, suspensionRestLength, wheelRadius, hasSteering)
3314
3315       Add a wheel to the vehicle
3316
3317       :arg wheel: The object to use as a wheel.
3318       :type wheel: :class:`KX_GameObject` or a KX_GameObject name
3319       :arg attachPos: The position that this wheel will attach to.
3320       :type attachPos: vector of 3 floats
3321       :arg attachDir: The direction this wheel points.
3322       :type attachDir: vector of 3 floats
3323       :arg axleDir: The direction of this wheels axle.
3324       :type axleDir: vector of 3 floats
3325       :arg suspensionRestLength: TODO - Description
3326       :type suspensionRestLength: float
3327       :arg wheelRadius: The size of the wheel.
3328       :type wheelRadius: float
3329
3330    .. method:: applyBraking(force, wheelIndex)
3331
3332       Apply a braking force to the specified wheel
3333
3334       :arg force: the brake force
3335       :type force: float
3336
3337       :arg wheelIndex: index of the wheel where the force needs to be applied
3338       :type wheelIndex: integer
3339
3340    .. method:: applyEngineForce(force, wheelIndex)
3341
3342       Apply an engine force to the specified wheel
3343
3344       :arg force: the engine force
3345       :type force: float
3346
3347       :arg wheelIndex: index of the wheel where the force needs to be applied
3348       :type wheelIndex: integer
3349
3350    .. method:: getConstraintId()
3351
3352       Get the constraint ID
3353
3354       :return: the constraint id
3355       :rtype: integer
3356
3357    .. method:: getConstraintType()
3358
3359       Returns the constraint type.
3360
3361       :return: constraint type
3362       :rtype: integer
3363
3364    .. method:: getNumWheels()
3365
3366       Returns the number of wheels.
3367
3368       :return: the number of wheels for this vehicle
3369       :rtype: integer
3370
3371    .. method:: getWheelOrientationQuaternion(wheelIndex)
3372
3373       Returns the wheel orientation as a quaternion.
3374
3375       :arg wheelIndex: the wheel index
3376       :type wheelIndex: integer
3377
3378       :return: TODO Description
3379       :rtype: TODO - type should be quat as per method name but from the code it looks like a matrix
3380
3381    .. method:: getWheelPosition(wheelIndex)
3382
3383       Returns the position of the specified wheel
3384
3385       :arg wheelIndex: the wheel index
3386       :type wheelIndex: integer
3387       :return: position vector
3388       :rtype: list[x, y, z]
3389
3390    .. method:: getWheelRotation(wheelIndex)
3391
3392       Returns the rotation of the specified wheel
3393
3394       :arg wheelIndex: the wheel index
3395       :type wheelIndex: integer
3396
3397       :return: the wheel rotation
3398       :rtype: float
3399
3400    .. method:: setRollInfluence(rollInfluece, wheelIndex)
3401
3402       Set the specified wheel's roll influence.
3403       The higher the roll influence the more the vehicle will tend to roll over in corners.
3404
3405       :arg rollInfluece: the wheel roll influence
3406       :type rollInfluece: float
3407
3408       :arg wheelIndex: the wheel index
3409       :type wheelIndex: integer
3410
3411    .. method:: setSteeringValue(steering, wheelIndex)
3412
3413       Set the specified wheel's steering
3414
3415       :arg steering: the wheel steering
3416       :type steering: float
3417
3418       :arg wheelIndex: the wheel index
3419       :type wheelIndex: integer
3420
3421    .. method:: setSuspensionCompression(compression, wheelIndex)
3422
3423       Set the specified wheel's compression
3424
3425       :arg compression: the wheel compression
3426       :type compression: float
3427
3428       :arg wheelIndex: the wheel index
3429       :type wheelIndex: integer
3430
3431    .. method:: setSuspensionDamping(damping, wheelIndex)
3432
3433       Set the specified wheel's damping
3434
3435       :arg damping: the wheel damping
3436       :type damping: float
3437
3438       :arg wheelIndex: the wheel index
3439       :type wheelIndex: integer
3440
3441    .. method:: setSuspensionStiffness(stiffness, wheelIndex)
3442
3443       Set the specified wheel's stiffness
3444
3445       :arg stiffness: the wheel stiffness
3446       :type stiffness: float
3447
3448       :arg wheelIndex: the wheel index
3449       :type wheelIndex: integer
3450
3451    .. method:: setTyreFriction(friction, wheelIndex)
3452
3453       Set the specified wheel's tyre friction
3454
3455       :arg friction: the tyre friction
3456       :type friction: float
3457
3458       :arg wheelIndex: the wheel index
3459       :type wheelIndex: integer
3460
3461 .. class:: KX_VertexProxy(SCA_IObject)
3462
3463    A vertex holds position, UV, colour and normal information.
3464
3465    Note:
3466    The physics simulation is NOT currently updated - physics will not respond
3467    to changes in the vertex position.
3468
3469    .. attribute:: XYZ
3470
3471       The position of the vertex.
3472
3473       :type: list [x, y, z]
3474
3475    .. attribute:: UV
3476
3477       The texture coordinates of the vertex.
3478
3479       :type: list [u, v]
3480
3481    .. attribute:: normal
3482
3483       The normal of the vertex.
3484
3485       :type: list [nx, ny, nz]
3486
3487    .. attribute:: colour
3488
3489       The colour of the vertex.
3490
3491       :type: list [r, g, b, a]
3492
3493       Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
3494
3495    .. attribute:: color
3496
3497       Synonym for colour.
3498
3499    .. attribute:: x
3500
3501       The x coordinate of the vertex.
3502
3503       :type: float
3504
3505    .. attribute:: y
3506
3507       The y coordinate of the vertex.
3508
3509       :type: float
3510
3511    .. attribute:: z
3512
3513       The z coordinate of the vertex.
3514
3515       :type: float
3516
3517    .. attribute:: u
3518
3519       The u texture coordinate of the vertex.
3520
3521       :type: float
3522
3523    .. attribute:: v
3524
3525       The v texture coordinate of the vertex.
3526
3527       :type: float
3528
3529    .. attribute:: u2
3530
3531       The second u texture coordinate of the vertex.
3532
3533       :type: float
3534
3535    .. attribute:: v2
3536
3537       The second v texture coordinate of the vertex.
3538
3539       :type: float
3540
3541    .. attribute:: r
3542
3543       The red component of the vertex colour. 0.0 <= r <= 1.0.
3544
3545       :type: float
3546
3547    .. attribute:: g
3548
3549       The green component of the vertex colour. 0.0 <= g <= 1.0.
3550
3551       :type: float
3552
3553    .. attribute:: b
3554
3555       The blue component of the vertex colour. 0.0 <= b <= 1.0.
3556
3557       :type: float
3558
3559    .. attribute:: a
3560
3561       The alpha component of the vertex colour. 0.0 <= a <= 1.0.
3562
3563       :type: float
3564
3565    .. method:: getXYZ()
3566
3567       Gets the position of this vertex.
3568
3569       :return: this vertexes position in local coordinates.
3570       :rtype: list [x, y, z]
3571
3572    .. method:: setXYZ(pos)
3573
3574       Sets the position of this vertex.
3575
3576       :type:  list [x, y, z]
3577
3578       :arg pos: the new position for this vertex in local coordinates.
3579
3580    .. method:: getUV()
3581
3582       Gets the UV (texture) coordinates of this vertex.
3583
3584       :return: this vertexes UV (texture) coordinates.
3585       :rtype: list [u, v]
3586
3587    .. method:: setUV(uv)
3588
3589       Sets the UV (texture) coordinates of this vertex.
3590
3591       :type:  list [u, v]
3592
3593    .. method:: getUV2()
3594
3595       Gets the 2nd UV (texture) coordinates of this vertex.
3596
3597       :return: this vertexes UV (texture) coordinates.
3598       :rtype: list [u, v]
3599
3600    .. method:: setUV2(uv, unit)
3601
3602       Sets the 2nd UV (texture) coordinates of this vertex.
3603
3604       :type:  list [u, v]
3605
3606       :arg unit: optional argument, FLAT==1, SECOND_UV==2, defaults to SECOND_UV
3607       :arg unit:  integer
3608
3609    .. method:: getRGBA()
3610
3611       Gets the colour of this vertex.
3612
3613       The colour is represented as four bytes packed into an integer value.  The colour is
3614       packed as RGBA.
3615
3616       Since Python offers no way to get each byte without shifting, you must use the struct module to
3617       access colour in an machine independent way.
3618
3619       Because of this, it is suggested you use the r, g, b and a attributes or the colour attribute instead.
3620
3621       .. code-block:: python
3622
3623          import struct;
3624          col = struct.unpack('4B', struct.pack('I', v.getRGBA()))
3625          # col = (r, g, b, a)
3626          # black = (  0, 0, 0, 255)
3627          # white = (255, 255, 255, 255)
3628
3629       :return: packed colour. 4 byte integer with one byte per colour channel in RGBA format.
3630       :rtype: integer
3631
3632    .. method:: setRGBA(col)
3633
3634       Sets the colour of this vertex.
3635
3636       See getRGBA() for the format of col, and its relevant problems.  Use the r, g, b and a attributes
3637       or the colour attribute instead.
3638
3639       setRGBA() also accepts a four component list as argument col.  The list represents the colour as [r, g, b, a]
3640       with black = [0.0, 0.0, 0.0, 1.0] and white = [1.0, 1.0, 1.0, 1.0]
3641
3642       .. code-block:: python
3643
3644          v.setRGBA(0xff0000ff) # Red
3645          v.setRGBA(0xff00ff00) # Green on little endian, transparent purple on big endian
3646          v.setRGBA([1.0, 0.0, 0.0, 1.0]) # Red
3647          v.setRGBA([0.0, 1.0, 0.0, 1.0]) # Green on all platforms.
3648
3649       :arg col: the new colour of this vertex in packed RGBA format.
3650       :type col: integer or list [r, g, b, a]
3651
3652    .. method:: getNormal()
3653
3654       Gets the normal vector of this vertex.
3655
3656       :return: normalised normal vector.
3657       :rtype: list [nx, ny, nz]
3658
3659    .. method:: setNormal(normal)
3660
3661       Sets the normal vector of this vertex.
3662
3663       :type:  sequence of floats [r, g, b]
3664
3665       :arg normal: the new normal of this vertex.
3666
3667 .. class:: KX_VisibilityActuator(SCA_IActuator)
3668
3669    Visibility Actuator.
3670
3671    .. attribute:: visibility
3672
3673       whether the actuator makes its parent object visible or invisible.
3674
3675       :type: boolean
3676
3677    .. attribute:: useOcclusion
3678
3679       whether the actuator makes its parent object an occluder or not.
3680
3681       :type: boolean
3682
3683    .. attribute:: useRecursion
3684
3685       whether the visibility/occlusion should be propagated to all children of the object.
3686
3687       :type: boolean
3688
3689 .. class:: SCA_2DFilterActuator(SCA_IActuator)
3690
3691    Create, enable and disable 2D filters
3692
3693    The following properties don't have an immediate effect.
3694    You must active the actuator to get the result.
3695    The actuator is not persistent: it automatically stops itself after setting up the filter
3696    but the filter remains active. To stop a filter you must activate the actuator with 'type'
3697    set to :data:`~bge.logic.RAS_2DFILTER_DISABLED` or :data:`~bge.logic.RAS_2DFILTER_NOFILTER`.
3698
3699    .. attribute:: shaderText
3700
3701       shader source code for custom shader.
3702
3703       :type: string
3704
3705    .. attribute:: disableMotionBlur
3706
3707       action on motion blur: 0=enable, 1=disable.
3708
3709       :type: integer
3710
3711    .. attribute:: mode
3712
3713       Type of 2D filter, use one of :ref:`these constants <Two-D-FilterActuator-mode>`
3714
3715       :type: integer
3716
3717    .. attribute:: passNumber
3718
3719       order number of filter in the stack of 2D filters. Filters are executed in increasing order of passNb.
3720
3721       Only be one filter can be defined per passNb.
3722
3723       :type: integer (0-100)
3724
3725    .. attribute:: value
3726
3727       argument for motion blur filter.
3728
3729       :type: float (0.0-100.0)
3730
3731 .. class:: SCA_ANDController(SCA_IController)
3732
3733    An AND controller activates only when all linked sensors are activated.
3734
3735    There are no special python methods for this controller.
3736
3737 .. class:: SCA_ActuatorSensor(SCA_ISensor)
3738
3739    Actuator sensor detect change in actuator state of the parent object.
3740    It generates a positive pulse if the corresponding actuator is activated
3741    and a negative pulse if the actuator is deactivated.
3742
3743    .. attribute:: actuator
3744
3745       the name of the actuator that the sensor is monitoring.
3746
3747       :type: string
3748
3749 .. class:: SCA_AlwaysSensor(SCA_ISensor)
3750
3751    This sensor is always activated.
3752
3753 .. class:: SCA_DelaySensor(SCA_ISensor)
3754
3755    The Delay sensor generates positive and negative triggers at precise time, 
3756    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.
3757
3758    The duration parameter defines the length of the ON period following the OFF period.
3759    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.
3760
3761    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).
3762
3763    Use :class:`SCA_ISensor.reset` at any time to restart sensor.
3764
3765    .. attribute:: delay
3766
3767       length of the initial OFF period as number of frame, 0 for immediate trigger.
3768
3769       :type: integer.
3770
3771    .. attribute:: duration
3772
3773       length of the ON period in number of frame after the initial OFF period.
3774
3775       If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.
3776
3777       :type: integer
3778
3779    .. attribute:: repeat
3780
3781       1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
3782
3783       :type: integer
3784
3785 .. class:: SCA_JoystickSensor(SCA_ISensor)
3786
3787    This sensor detects player joystick events.
3788
3789    .. attribute:: axisValues
3790
3791       The state of the joysticks axis as a list of values :data:`numAxis` long. (read-only).
3792
3793       :type: list of ints.
3794
3795       Each spesifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing.
3796       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.
3797
3798       * left:[-32767, 0, ...]
3799       * right:[32767, 0, ...]
3800       * up:[0, -32767, ...]
3801       * down:[0, 32767, ...]
3802
3803    .. attribute:: axisSingle
3804
3805       like :data:`axisValues` but returns a single axis value that is set by the sensor. (read-only).
3806
3807       :type: integer
3808
3809       .. note::
3810          
3811          Only use this for "Single Axis" type sensors otherwise it will raise an error.
3812
3813    .. attribute:: hatValues
3814
3815       The state of the joysticks hats as a list of values :data:`numHats` long. (read-only).
3816
3817       :type: list of ints
3818
3819       Each spesifying the direction of the hat from 1 to 12, 0 when inactive.
3820
3821       Hat directions are as follows...
3822
3823       * 0:None
3824       * 1:Up
3825       * 2:Right
3826       * 4:Down
3827       * 8:Left
3828       * 3:Up - Right
3829       * 6:Down - Right
3830       * 12:Down - Left
3831       * 9:Up - Left
3832
3833    .. attribute:: hatSingle
3834
3835       Like :data:`hatValues` but returns a single hat direction value that is set by the sensor. (read-only).
3836
3837       :type: integer
3838
3839    .. attribute:: numAxis
3840
3841       The number of axes for the joystick at this index. (read-only).
3842
3843       :type: integer
3844
3845    .. attribute:: numButtons
3846
3847       The number of buttons for the joystick at this index. (read-only).
3848
3849       :type: integer
3850
3851    .. attribute:: numHats
3852
3853       The number of hats for the joystick at this index. (read-only).
3854
3855       :type: integer
3856
3857    .. attribute:: connected
3858
3859       True if a joystick is connected at this joysticks index. (read-only).
3860
3861       :type: boolean
3862
3863    .. attribute:: index
3864
3865       The joystick index to use (from 0 to 7). The first joystick is always 0.
3866
3867       :type: integer
3868
3869    .. attribute:: threshold
3870
3871       Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
3872
3873       :type: integer
3874
3875    .. attribute:: button
3876
3877       The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
3878
3879       :type: integer
3880
3881    .. attribute:: axis
3882
3883       The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection]
3884
3885       * axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control.
3886       * axisDirection: 0=right, 1=up, 2=left, 3=down.
3887
3888       :type: [integer, integer]
3889
3890    .. attribute:: hat
3891
3892       The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]
3893
3894       * hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat (4 max).
3895       * hatDirection: 1-12.
3896
3897       :type: [integer, integer]
3898
3899    .. method:: getButtonActiveList()
3900
3901       :return: A list containing the indicies of the currently pressed buttons.
3902       :rtype: list
3903
3904    .. method:: getButtonStatus(buttonIndex)
3905
3906       :arg buttonIndex: the button index, 0=first button
3907       :type buttonIndex: integer
3908       :return: The current pressed state of the specified button.
3909       :rtype: boolean
3910
3911 .. class:: SCA_KeyboardSensor(SCA_ISensor)
3912
3913    A keyboard sensor detects player key presses.
3914
3915    See module :mod:`bge.keys` for keycode values.
3916
3917    .. attribute:: key
3918
3919       The key code t