BGE API cleanup: shape action actuator.
[blender.git] / source / gameengine / PyDoc / BL_ActionActuator.py
index 5d6ea51060bb4172e978628af2e645e48ed64da8..3e95befe16b8fc7849e1c6ee2b929b895dc9cde8 100644 (file)
@@ -23,7 +23,7 @@ class BL_ActionActuator(SCA_IActuator):
        @ivar property: Sets the property to be used in FromProp playback mode.
        @type property: string
        @ivar blendTime: Sets the internal frame timer. This property must be in
-                                               the range from 0.0 to 1.0.
+                                               the range from 0.0 to blendin.
        @type blendTime: float
        @ivar type: The operation mode of the actuator.
                                        KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER,
@@ -50,6 +50,7 @@ class BL_ActionActuator(SCA_IActuator):
        #--The following methods are deprecated--
        def setAction(action, reset = True):
                """
+               DEPRECATED: use the 'action' property
                Sets the current action.
                
                @param action: The name of the action to set as the current action.
@@ -63,6 +64,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def setStart(start):
                """
+               DEPRECATED: use the 'start' property
                Specifies the starting frame of the animation.
                
                @param start: the starting frame of the animation
@@ -71,6 +73,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def setEnd(end):
                """
+               DEPRECATED: use the 'end' property
                Specifies the ending frame of the animation.
                
                @param end: the ending frame of the animation
@@ -78,6 +81,7 @@ class BL_ActionActuator(SCA_IActuator):
                """
        def setBlendin(blendin):
                """
+               DEPRECATED: use the 'blendin' property
                Specifies the number of frames of animation to generate
                when making transitions between actions.
                
@@ -87,6 +91,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def setPriority(priority):
                """
+               DEPRECATED: use the 'priority' property
                Sets the priority of this actuator.
                
                @param priority: Specifies the new priority.  Actuators will lower
@@ -96,6 +101,7 @@ class BL_ActionActuator(SCA_IActuator):
                """
        def setFrame(frame):
                """
+               DEPRECATED: use the 'frame' property
                Sets the current frame for the animation.
                
                @param frame: Specifies the new current frame for the animation
@@ -104,6 +110,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def setProperty(prop):
                """
+               DEPRECATED: use the 'property' property
                Sets the property to be used in FromProp playback mode.
                
                @param prop: the name of the property to use.
@@ -112,6 +119,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def setBlendtime(blendtime):
                """
+               DEPRECATED: use the 'blendTime' property
                Sets the internal frame timer.
                 
                Allows the script to directly modify the internal timer
@@ -123,6 +131,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def setType(mode):
                """
+               DEPRECATED: use the 'type' property
                Sets the operation mode of the actuator
 
                @param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
@@ -131,6 +140,7 @@ class BL_ActionActuator(SCA_IActuator):
        
        def setContinue(cont):
                """
+               DEPRECATED: use the 'continue' property
                Set the actions continue option True or False. see getContinue.
 
                @param cont: The continue option.
@@ -139,6 +149,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def getType():
                """
+               DEPRECATED: use the 'type' property
                Returns the operation mode of the actuator
            
                @rtype: integer
@@ -147,6 +158,7 @@ class BL_ActionActuator(SCA_IActuator):
 
        def getContinue():
                """
+               DEPRECATED: use the 'continue' property
                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.
            
                @rtype: bool
@@ -154,6 +166,7 @@ class BL_ActionActuator(SCA_IActuator):
        
        def getAction():
                """
+               DEPRECATED: use the 'action' property
                getAction() returns the name of the action associated with this actuator.
                
                @rtype: string
@@ -161,24 +174,28 @@ class BL_ActionActuator(SCA_IActuator):
        
        def getStart():
                """
+               DEPRECATED: use the 'start' property
                Returns the starting frame of the action.
                
                @rtype: float
                """
        def getEnd():
                """
+               DEPRECATED: use the 'end' property
                Returns the last frame of the action.
                
                @rtype: float
                """
        def getBlendin():
                """
+               DEPRECATED: use the 'blendin' property
                Returns the number of interpolation animation frames to be generated when this actuator is triggered.
                
                @rtype: float
                """
        def getPriority():
                """
+               DEPRECATED: use the 'priority' property
                Returns the priority for this actuator.  Actuators with lower Priority numbers will
                override actuators with higher numbers.
                
@@ -186,23 +203,27 @@ class BL_ActionActuator(SCA_IActuator):
                """
        def getFrame():
                """
+               DEPRECATED: use the 'frame' property
                Returns the current frame number.
                
                @rtype: float
                """
        def getProperty():
                """
+               DEPRECATED: use the 'property' property
                Returns the name of the property to be used in FromProp mode.
                
                @rtype: string
                """
        def setFrameProperty(prop):
                """
+               DEPRECATED: use the 'frameProperty' property
                @param prop: A string specifying the property of the object that will be updated with the action frame number.
                @type prop: string
                """
        def getFrameProperty():
                """
+               DEPRECATED: use the 'frameProperty' property
                Returns the name of the property that is set to the current frame number.
                
                @rtype: string