Welcome to mirror list, hosted at ThFree Co, Russian Federation.

bge.types.KX_ObjectActuator.rst « bge_types « rst « python_api « doc - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: f3948578cd513c12690281dcf83010359732f08e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
KX_ObjectActuator(SCA_IActuator)
================================

base class --- :class:`SCA_IActuator`

.. class:: KX_ObjectActuator(SCA_IActuator)

   The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement, 
   velocity, or angular velocity to an object.
   Servo control allows to regulate force to achieve a certain speed target.

   .. attribute:: force

      The force applied by the actuator.

      :type: Vector((x, y, z))

   .. attribute:: useLocalForce

      A flag specifying if the force is local.

      :type: boolean

   .. attribute:: torque

      The torque applied by the actuator.

      :type: Vector((x, y, z))

   .. attribute:: useLocalTorque

      A flag specifying if the torque is local.

      :type: boolean

   .. attribute:: dLoc

      The displacement vector applied by the actuator.

      :type: Vector((x, y, z))

   .. attribute:: useLocalDLoc

      A flag specifying if the dLoc is local.

      :type: boolean

   .. attribute:: dRot

      The angular displacement vector applied by the actuator

      :type: Vector((x, y, z))
      
      .. note::
      
         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.

   .. attribute:: useLocalDRot

      A flag specifying if the dRot is local.

      :type: boolean

   .. attribute:: linV

      The linear velocity applied by the actuator.

      :type: Vector((x, y, z))

   .. attribute:: useLocalLinV

      A flag specifying if the linear velocity is local.

      :type: boolean
      
      .. note::
      
         This is the target speed for servo controllers.

   .. attribute:: angV

      The angular velocity applied by the actuator.

      :type: Vector((x, y, z))

   .. attribute:: useLocalAngV

      A flag specifying if the angular velocity is local.

      :type: boolean

   .. attribute:: damping

      The damping parameter of the servo controller.

      :type: short

   .. attribute:: forceLimitX

      The min/max force limit along the X axis and activates or deactivates the limits in the servo controller.

      :type: list [min(float), max(float), bool]

   .. attribute:: forceLimitY

      The min/max force limit along the Y axis and activates or deactivates the limits in the servo controller.

      :type: list [min(float), max(float), bool]

   .. attribute:: forceLimitZ

      The min/max force limit along the Z axis and activates or deactivates the limits in the servo controller.

      :type: list [min(float), max(float), bool]

   .. attribute:: pid

      The PID coefficients of the servo controller.

      :type: list of floats [proportional, integral, derivate]

   .. attribute:: reference

      The object that is used as reference to compute the velocity for the servo controller.

      :type: :class:`KX_GameObject` or None