2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19323...
[blender.git] / source / gameengine / PyDoc / KX_SCA_AddObjectActuator.py
index 56068fa..572b864 100644 (file)
@@ -9,6 +9,12 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
        @type object: KX_GameObject or None
        @ivar objectLastCreated: the last added object from this actuator (read only).
        @type objectLastCreated: KX_GameObject or None
+       @ivar time: the lifetime of added objects, in frames.
+       @type time: integer
+       @ivar linearVelocity: the initial linear velocity of added objects.
+       @type linearVelocity: list [vx, vy, vz]
+       @ivar angularVelocity: the initial angular velocity of added objects.
+       @type angularVelocity: list [vx, vy, vz]
        
        @warning: 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.
@@ -19,6 +25,7 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
        """
        def setObject(object):
                """
+               DEPRECATED: use the object property
                Sets the game object to add.
                
                A copy of the object will be added to the scene when the actuator is activated.
@@ -31,6 +38,7 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
                """
        def getObject(name_only = 0):
                """
+               DEPRECATED: use the object property
                Returns the name of the game object to be added.
                
                Returns None if no game object has been assigned to be added.
@@ -40,6 +48,7 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
                """
        def setTime(time):
                """
+               DEPRECATED: use the time property
                Sets the lifetime of added objects, in frames.
                
                If time == 0, the object will last forever.
@@ -49,12 +58,14 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
                """
        def getTime():
                """
+               DEPRECATED: use the time property
                Returns the lifetime of the added object, in frames.
                
                @rtype: integer
                """
        def setLinearVelocity(vx, vy, vz):
                """
+               DEPRECATED: use the linearVelocity property
                Sets the initial linear velocity of added objects.
                
                @type vx: float
@@ -66,12 +77,14 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
                """
        def getLinearVelocity():
                """
+               DEPRECATED: use the linearVelocity property
                Returns the initial linear velocity of added objects.
                
                @rtype: list [vx, vy, vz]
                """
        def setAngularVelocity(vx, vy, vz):
                """
+               DEPRECATED: use the angularVelocity property
                Sets the initial angular velocity of added objects.
                
                @type vx: float
@@ -83,14 +96,23 @@ class KX_SCA_AddObjectActuator(SCA_IActuator):
                """
        def getAngularVelocity():
                """
+               DEPRECATED: use the angularVelocity property
                Returns the initial angular velocity of added objects.
                
                @rtype: list [vx, vy, vz]
                """
        def getLastCreatedObject():
                """
+               DEPRECATED: use the objectLastCreated property
                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.
                """
+       def instantAddObject():
+               """
+               Returns the last object created by this actuator. The object can then be accessed from L{objectLastCreated}.
+               
+               @rtype: None
+               """
+