diff options
author | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-06-02 16:43:27 +0400 |
---|---|---|
committer | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-06-02 16:43:27 +0400 |
commit | 976e3a1824622c11c0bc72110345fcceae75fd73 (patch) | |
tree | 27921d8ff9ae80ed3eb288ae702ff17902a6163d /source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py | |
parent | 474ec217aefd4057429d4cbde4c08768e833cfe5 (diff) |
Updates to GamePython Reference.
Added Actuator documentation.
Diffstat (limited to 'source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py')
-rw-r--r-- | source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py b/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py new file mode 100644 index 00000000000..eef08a3fd56 --- /dev/null +++ b/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py @@ -0,0 +1,68 @@ +# $Id$ +# Documentation for KX_SCA_AddObjectActuator +from SCA_IActuator import * + +class KX_SCA_AddObjectActuator(SCA_IActuator): + """ + Edit Object Actuator (in Add Object Mode) + + @warning: Add Object actuators 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. + + This will genereate a warning in the console: + + C{ERROR: GameObject I{OBName} has a AddObjectActuator I{ActuatorName} without object (in 'nonactive' layer)} + """ + def setObject(name): + """ + Sets the name of the game object to add. + + A copy of the named object will be added to the scene. + + If the named object does not exist, this function is ignored. + + @type name: string + """ + def getObject(): + """ + Returns the name of the game object to be added. + + @rtype: string + """ + def setTime(time): + """ + Sets the lifetime of added objects, in frames. + + @type time: integer + @param time: The minimum value for time is 0. + """ + def getTime(): + """ + Returns the lifetime of the added object, in frames. + + @rtype: integer + """ + def setLinearVelocity(vx, vy, vz): + """ + Sets the initial linear velocity of added objects. + + @type vx: float + @param vx: the x component of the initial linear velocity. + @type vy: float + @param vy: the y component of the initial linear velocity. + @type vz: float + @param vz: the z component of the initial linear velocity. + """ + def getLinearVelocity(): + """ + Returns the initial linear velocity of added objects. + + @rtype: list [vx, vy, vz] + """ + def getLastCreatedObject(): + """ + Returns the last object created by this actuator. + + @rtype: L{KX_GameObject} + @return: A L{KX_GameObject} or None if no object has been created. + """ |