BGE API cleanup: shape action actuator.
authorBenoit Bolsee <benoit.bolsee@online.be>
Thu, 22 Jan 2009 17:40:47 +0000 (17:40 +0000)
committerBenoit Bolsee <benoit.bolsee@online.be>
Thu, 22 Jan 2009 17:40:47 +0000 (17:40 +0000)
source/gameengine/Converter/BL_ActionActuator.cpp
source/gameengine/Converter/BL_ActionActuator.h
source/gameengine/Converter/BL_ShapeActionActuator.cpp
source/gameengine/Converter/BL_ShapeActionActuator.h
source/gameengine/Ketsji/KX_PythonInit.cpp
source/gameengine/PyDoc/BL_ActionActuator.py
source/gameengine/PyDoc/BL_ShapeActionActuator.py

index c05f763cacbfe47725e2997fa4334b709ce36d8d..65d6892fa6da3120afc31f76e52ea29e2d7a34a1 100644 (file)
 #include "BL_SkinDeformer.h"
 #include "KX_GameObject.h"
 #include "STR_HashedString.h"
-#include "DNA_action_types.h"
 #include "DNA_nla_types.h"
-#include "DNA_actuator_types.h"
 #include "BKE_action.h"
+#include "DNA_action_types.h"
 #include "DNA_armature_types.h"
 #include "MEM_guardedalloc.h"
 #include "BLI_blenlib.h"
@@ -51,7 +50,6 @@
 #include "BKE_utildefines.h"
 #include "FloatValue.h"
 #include "PyObjectPlus.h"
-
 #include "blendef.h"
 
 #ifdef HAVE_CONFIG_H
@@ -843,11 +841,11 @@ PyObject* BL_ActionActuator::PySetType(PyObject* self,
     }
 
        switch (typeArg) {
-       case KX_ACT_ACTION_PLAY:
-       case KX_ACT_ACTION_FLIPPER:
-       case KX_ACT_ACTION_LOOPSTOP:
-       case KX_ACT_ACTION_LOOPEND:
-       case KX_ACT_ACTION_PROPERTY:
+       case ACT_ACTION_PLAY:
+       case ACT_ACTION_FLIPPER:
+       case ACT_ACTION_LOOP_STOP:
+       case ACT_ACTION_LOOP_END:
+       case ACT_ACTION_FROM_PROP:
                m_playtype = typeArg;
                break;
        default:
@@ -1033,7 +1031,7 @@ PyAttributeDef BL_ActionActuator::Attributes[] = {
        KX_PYATTRIBUTE_STRING_RW("frameProperty", 0, 31, false, BL_ActionActuator, m_framepropname),
        KX_PYATTRIBUTE_BOOL_RW("continue", BL_ActionActuator, m_end_reset),
        KX_PYATTRIBUTE_FLOAT_RW_CHECK("blendTime", 0, MAXFRAMEF, BL_ActionActuator, m_blendframe, CheckBlendTime),
-       KX_PYATTRIBUTE_ENUM_RW_CHECK("type",0,100,false,BL_ActionActuator,m_playtype,CheckType),
+       KX_PYATTRIBUTE_SHORT_RW_CHECK("type",0,100,false,BL_ActionActuator,m_playtype,CheckType),
        { NULL }        //Sentinel
 };
 
index 04bd9c803c5757f3f12f4d5b16f8759775929c7f..6e29110655315b202ec7381a9d687b1a316c2f73 100644 (file)
@@ -32,6 +32,7 @@
 
 #include "GEN_HashedPtr.h"
 #include "SCA_IActuator.h"
+#include "DNA_actuator_types.h"
 #include "MT_Point3.h"
 
 class BL_ActionActuator : public SCA_IActuator  
@@ -112,15 +113,6 @@ public:
        virtual PyObject* _getattr(const STR_String& attr);
        virtual int _setattr(const STR_String& attr, PyObject* value);
 
-       enum ActionActType
-       {
-               KX_ACT_ACTION_PLAY = 0,
-               KX_ACT_ACTION_FLIPPER = 2,
-               KX_ACT_ACTION_LOOPSTOP,
-               KX_ACT_ACTION_LOOPEND,
-               KX_ACT_ACTION_PROPERTY = 6
-       };
-
        /* attribute check */
        static int CheckFrame(void *self, const PyAttributeDef*)
        {
@@ -138,7 +130,7 @@ public:
        {
                BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
 
-               if (act->m_blendframe < act->m_blendin)
+               if (act->m_blendframe > act->m_blendin)
                        act->m_blendframe = act->m_blendin;
 
                return 0;
@@ -149,11 +141,11 @@ public:
                BL_ActionActuator* act = reinterpret_cast<BL_ActionActuator*>(self);
 
                switch (act->m_playtype) {
-                       case KX_ACT_ACTION_PLAY:
-                       case KX_ACT_ACTION_FLIPPER:
-                       case KX_ACT_ACTION_LOOPSTOP:
-                       case KX_ACT_ACTION_LOOPEND:
-                       case KX_ACT_ACTION_PROPERTY:
+                       case ACT_ACTION_PLAY:
+                       case ACT_ACTION_FLIPPER:
+                       case ACT_ACTION_LOOP_STOP:
+                       case ACT_ACTION_LOOP_END:
+                       case ACT_ACTION_FROM_PROP:
                                return 0;
                        default:
                                PyErr_SetString(PyExc_ValueError, "invalid type supplied");
index 46f3141be29cc8df5bcf3cc46b3afdb18d6ae593..df0a8c4f25e635abc2500ba9e129b7283ce26f89 100644 (file)
 
 #include "SCA_LogicManager.h"
 #include "BL_ShapeActionActuator.h"
-#include "BL_ActionActuator.h"
 #include "BL_ShapeDeformer.h"
 #include "KX_GameObject.h"
 #include "STR_HashedString.h"
-#include "DNA_action_types.h"
 #include "DNA_nla_types.h"
-#include "DNA_actuator_types.h"
+#include "DNA_action_types.h"
 #include "BKE_action.h"
 #include "DNA_armature_types.h"
 #include "MEM_guardedalloc.h"
@@ -51,6 +49,7 @@
 #include "BKE_utildefines.h"
 #include "FloatValue.h"
 #include "PyObjectPlus.h"
+#include "blendef.h"
 
 #ifdef HAVE_CONFIG_H
 #include <config.h>
@@ -471,16 +470,73 @@ PyMethodDef BL_ShapeActionActuator::Methods[] = {
        {NULL,NULL} //Sentinel
 };
 
+PyAttributeDef BL_ShapeActionActuator::Attributes[] = {
+       KX_PYATTRIBUTE_FLOAT_RW("start", 0, MAXFRAMEF, BL_ShapeActionActuator, m_startframe),
+       KX_PYATTRIBUTE_FLOAT_RW("end", 0, MAXFRAMEF, BL_ShapeActionActuator, m_endframe),
+       KX_PYATTRIBUTE_FLOAT_RW("blendin", 0, MAXFRAMEF, BL_ShapeActionActuator, m_blendin),
+       KX_PYATTRIBUTE_SHORT_RW("priority", 0, 100, false, BL_ShapeActionActuator, m_priority),
+       KX_PYATTRIBUTE_FLOAT_RW_CHECK("frame", 0, MAXFRAMEF, BL_ShapeActionActuator, m_localtime, CheckFrame),
+       KX_PYATTRIBUTE_STRING_RW("property", 0, 31, false, BL_ShapeActionActuator, m_propname),
+       KX_PYATTRIBUTE_STRING_RW("frameProperty", 0, 31, false, BL_ShapeActionActuator, m_framepropname),
+       KX_PYATTRIBUTE_FLOAT_RW_CHECK("blendTime", 0, MAXFRAMEF, BL_ShapeActionActuator, m_blendframe, CheckBlendTime),
+       KX_PYATTRIBUTE_SHORT_RW_CHECK("type",0,100,false,BL_ShapeActionActuator,m_playtype,CheckType),
+       { NULL }        //Sentinel
+};
+
+
 PyObject* BL_ShapeActionActuator::_getattr(const STR_String& attr) {
+       if (attr == "action")
+               return PyString_FromString(m_action->id.name+2);
+       PyObject* object = _getattr_self(Attributes, this, attr);
+       if (object != NULL)
+               return object;
        _getattr_up(SCA_IActuator);
 }
 
+int BL_ShapeActionActuator::_setattr(const STR_String& attr, PyObject* value) {
+       if (attr == "action")
+       {
+               if (!PyString_Check(value))
+               {
+                       PyErr_SetString(PyExc_ValueError, "expected a string");
+                       return 1;
+               }
+
+               STR_String val = PyString_AsString(value);
+               
+               if (val == "")
+               {
+                       m_action = NULL;
+                       return 0;
+               }
+
+               bAction *action;
+               
+               action = (bAction*)SCA_ILogicBrick::m_sCurrentLogicManager->GetActionByName(val);
+               
+
+               if (!action)
+               {
+                       PyErr_SetString(PyExc_ValueError, "action not found!");
+                       return 1;
+               }
+
+               m_action = action;
+               return 0;
+       }
+       int ret = _setattr_self(Attributes, this, attr, value);
+       if (ret >= 0)
+               return ret;
+       return SCA_IActuator::_setattr(attr, value);
+}
+
 /*     setStart                                                              */
 const char BL_ShapeActionActuator::GetAction_doc[] = 
 "getAction()\n"
 "\tReturns a string containing the name of the current action.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetAction(PyObject* self) {
+       ShowDeprecationWarning("getAction()", "the action property");
        if (m_action){
                return PyString_FromString(m_action->id.name+2);
        }
@@ -493,6 +549,7 @@ const char BL_ShapeActionActuator::GetProperty_doc[] =
 "\tReturns the name of the property to be used in FromProp mode.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetProperty(PyObject* self) {
+       ShowDeprecationWarning("getProperty()", "the property property");
        PyObject *result;
        
        result = Py_BuildValue("s", (const char *)m_propname);
@@ -506,6 +563,7 @@ const char BL_ShapeActionActuator::GetFrame_doc[] =
 "\tReturns the current frame number.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetFrame(PyObject* self) {
+       ShowDeprecationWarning("getFrame()", "the frame property");
        PyObject *result;
        
        result = Py_BuildValue("f", m_localtime);
@@ -519,6 +577,7 @@ const char BL_ShapeActionActuator::GetEnd_doc[] =
 "\tReturns the last frame of the action.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetEnd(PyObject* self) {
+       ShowDeprecationWarning("getEnd()", "the end property");
        PyObject *result;
        
        result = Py_BuildValue("f", m_endframe);
@@ -532,6 +591,7 @@ const char BL_ShapeActionActuator::GetStart_doc[] =
 "\tReturns the starting frame of the action.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetStart(PyObject* self) {
+       ShowDeprecationWarning("getStart()", "the start property");
        PyObject *result;
        
        result = Py_BuildValue("f", m_startframe);
@@ -546,6 +606,7 @@ const char BL_ShapeActionActuator::GetBlendin_doc[] =
 "\tgenerated when this actuator is triggered.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetBlendin(PyObject* self) {
+       ShowDeprecationWarning("getBlendin()", "the blendin property");
        PyObject *result;
        
        result = Py_BuildValue("f", m_blendin);
@@ -560,6 +621,7 @@ const char BL_ShapeActionActuator::GetPriority_doc[] =
 "\tPriority numbers will override actuators with higher numbers.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetPriority(PyObject* self) {
+       ShowDeprecationWarning("getPriority()", "the priority property");
        PyObject *result;
        
        result = Py_BuildValue("i", m_priority);
@@ -581,6 +643,7 @@ const char BL_ShapeActionActuator::SetAction_doc[] =
 PyObject* BL_ShapeActionActuator::PySetAction(PyObject* self, 
                                                                                          PyObject* args, 
                                                                                          PyObject* kwds) {
+       ShowDeprecationWarning("setAction()", "the action property");
        char *string;
        int     reset = 1;
 
@@ -615,6 +678,7 @@ const char BL_ShapeActionActuator::SetStart_doc[] =
 PyObject* BL_ShapeActionActuator::PySetStart(PyObject* self, 
                                                                                         PyObject* args, 
                                                                                         PyObject* kwds) {
+       ShowDeprecationWarning("setStart()", "the start property");
        float start;
        
        if (PyArg_ParseTuple(args,"f",&start))
@@ -636,6 +700,7 @@ const char BL_ShapeActionActuator::SetEnd_doc[] =
 PyObject* BL_ShapeActionActuator::PySetEnd(PyObject* self, 
                                                                                   PyObject* args, 
                                                                                   PyObject* kwds) {
+       ShowDeprecationWarning("setEnd()", "the end property");
        float end;
        
        if (PyArg_ParseTuple(args,"f",&end))
@@ -658,6 +723,7 @@ const char BL_ShapeActionActuator::SetBlendin_doc[] =
 PyObject* BL_ShapeActionActuator::PySetBlendin(PyObject* self, 
                                                                                           PyObject* args, 
                                                                                           PyObject* kwds) {
+       ShowDeprecationWarning("setBlendin()", "the blendin property");
        float blendin;
        
        if (PyArg_ParseTuple(args,"f",&blendin))
@@ -681,6 +747,7 @@ const char BL_ShapeActionActuator::SetBlendtime_doc[] =
 PyObject* BL_ShapeActionActuator::PySetBlendtime(PyObject* self, 
                                                                                                 PyObject* args, 
                                                                                                   PyObject* kwds) {
+       ShowDeprecationWarning("setBlendtime()", "the blendTime property");
        float blendframe;
        
        if (PyArg_ParseTuple(args,"f",&blendframe))
@@ -708,6 +775,7 @@ const char BL_ShapeActionActuator::SetPriority_doc[] =
 PyObject* BL_ShapeActionActuator::PySetPriority(PyObject* self, 
                                                                                                PyObject* args, 
                                                                                                PyObject* kwds) {
+       ShowDeprecationWarning("setPriority()", "the priority property");
        int priority;
        
        if (PyArg_ParseTuple(args,"i",&priority))
@@ -727,6 +795,7 @@ const char BL_ShapeActionActuator::GetFrameProperty_doc[] =
 "\tReturns the name of the property, that is set to the current frame number.\n";
 
 PyObject* BL_ShapeActionActuator::PyGetFrameProperty(PyObject* self) {
+       ShowDeprecationWarning("getFrameProperty()", "the frameProperty property");
        PyObject *result;
        
        result = Py_BuildValue("s", (const char *)m_framepropname);
@@ -743,6 +812,7 @@ const char BL_ShapeActionActuator::SetFrame_doc[] =
 PyObject* BL_ShapeActionActuator::PySetFrame(PyObject* self, 
                                                                                         PyObject* args, 
                                                                                         PyObject* kwds) {
+       ShowDeprecationWarning("setFrame()", "the frame property");
        float frame;
        
        if (PyArg_ParseTuple(args,"f",&frame))
@@ -769,6 +839,7 @@ const char BL_ShapeActionActuator::SetProperty_doc[] =
 PyObject* BL_ShapeActionActuator::PySetProperty(PyObject* self, 
                                                                                                PyObject* args, 
                                                                                                PyObject* kwds) {
+       ShowDeprecationWarning("setProperty()", "the property property");
        char *string;
        
        if (PyArg_ParseTuple(args,"s",&string))
@@ -790,6 +861,7 @@ const char BL_ShapeActionActuator::SetFrameProperty_doc[] =
 PyObject* BL_ShapeActionActuator::PySetFrameProperty(PyObject* self, 
                                                                                   PyObject* args, 
                                                                                   PyObject* kwds) {
+       ShowDeprecationWarning("setFrameProperty()", "the frameProperty property");
        char *string;
        
        if (PyArg_ParseTuple(args,"s",&string))
@@ -808,6 +880,7 @@ const char BL_ShapeActionActuator::GetType_doc[] =
 "getType()\n"
 "\tReturns the operation mode of the actuator.\n";
 PyObject* BL_ShapeActionActuator::PyGetType(PyObject* self) {
+       ShowDeprecationWarning("getType()", "the type property");
     return Py_BuildValue("h", m_playtype);
 }
 
@@ -819,6 +892,7 @@ const char BL_ShapeActionActuator::SetType_doc[] =
 PyObject* BL_ShapeActionActuator::PySetType(PyObject* self,
                                             PyObject* args,
                                             PyObject* kwds) {
+       ShowDeprecationWarning("setType()", "the type property");
        short typeArg;
                                                                                                              
     if (!PyArg_ParseTuple(args, "h", &typeArg)) {
index 30b2d41fc67e1574d3eebc3be5fe45288eb9b4a0..b521c0d98a6ea8ef87e59de0d4c655ac1942e8e3 100644 (file)
@@ -32,6 +32,7 @@
 
 #include "GEN_HashedPtr.h"
 #include "SCA_IActuator.h"
+#include "BL_ActionActuator.h"
 #include "MT_Point3.h"
 #include <vector>
 
@@ -103,6 +104,45 @@ public:
        KX_PYMETHOD_DOC(BL_ShapeActionActuator,SetType);
 
        virtual PyObject* _getattr(const STR_String& attr);
+       virtual int _setattr(const STR_String& attr, PyObject* value);
+
+       static int CheckBlendTime(void *self, const PyAttributeDef*)
+       {
+               BL_ShapeActionActuator* act = reinterpret_cast<BL_ShapeActionActuator*>(self);
+
+               if (act->m_blendframe > act->m_blendin)
+                       act->m_blendframe = act->m_blendin;
+
+               return 0;
+       }
+       static int CheckFrame(void *self, const PyAttributeDef*)
+       {
+               BL_ShapeActionActuator* act = reinterpret_cast<BL_ShapeActionActuator*>(self);
+
+               if (act->m_localtime < act->m_startframe)
+                       act->m_localtime = act->m_startframe;
+               else if (act->m_localtime > act->m_endframe)
+                       act->m_localtime = act->m_endframe;
+
+               return 0;
+       }
+       static int CheckType(void *self, const PyAttributeDef*)
+       {
+               BL_ShapeActionActuator* act = reinterpret_cast<BL_ShapeActionActuator*>(self);
+
+               switch (act->m_playtype) {
+                       case ACT_ACTION_PLAY:
+                       case ACT_ACTION_FLIPPER:
+                       case ACT_ACTION_LOOP_STOP:
+                       case ACT_ACTION_LOOP_END:
+                       case ACT_ACTION_FROM_PROP:
+                               return 0;
+                       default:
+                               PyErr_SetString(PyExc_ValueError, "invalid type supplied");
+                               return 1;
+               }
+
+       }
 
 protected:
 
index 0032d83c2ff7c773737e1b649004ad3c46087845..13f141dec13c1f53d9df4b9d8e1905da60967f9c 100644 (file)
@@ -963,11 +963,11 @@ PyObject* initGameLogic(KX_KetsjiEngine *engine, KX_Scene* scene) // quick hack
        KX_MACRO_addTypesToDict(d, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP,     KX_SoundActuator::KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP);
 
        /* 7. Action actuator                                                                                                      */
-       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_PLAY,     BL_ActionActuator::KX_ACT_ACTION_PLAY);
-       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_FLIPPER,     BL_ActionActuator::KX_ACT_ACTION_FLIPPER);
-       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_LOOPSTOP,     BL_ActionActuator::KX_ACT_ACTION_LOOPSTOP);
-       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_LOOPEND,     BL_ActionActuator::KX_ACT_ACTION_LOOPEND);
-       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_PROPERTY,     BL_ActionActuator::KX_ACT_ACTION_PROPERTY);
+       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_PLAY,        ACT_ACTION_PLAY);
+       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_FLIPPER,     ACT_ACTION_FLIPPER);
+       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_LOOPSTOP,    ACT_ACTION_LOOP_STOP);
+       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_LOOPEND,     ACT_ACTION_LOOP_END);
+       KX_MACRO_addTypesToDict(d, KX_ACTIONACT_PROPERTY,    ACT_ACTION_FROM_PROP);
        
        /*8. GL_BlendFunc */
        KX_MACRO_addTypesToDict(d, BL_ZERO, GL_ZERO);
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
index a26b276a2dab948757436083e3800da3d9f86d41..209ff4e5580ba2c927e4ee997db71b3e1e6d2c15 100644 (file)
@@ -4,10 +4,38 @@ from SCA_IActuator import *
 
 class BL_ShapeActionActuator(SCA_IActuator):
        """
-       ShapeAction Actuators apply an shape action to an mesh object.
+       ShapeAction Actuators apply an shape action to an mesh object.\
+
+       @ivar action: The name of the action to set as the current shape action.
+       @type action: string
+       @ivar start: Specifies the starting frame of the shape animation.
+       @type start: float
+       @type end: Specifies the ending frame of the shape animation.
+       @type end: float
+       @ivar blendin: Specifies the number of frames of animation to generate when making transitions between actions.
+       @type blendin: float
+       @ivar priority: Sets the priority of this actuator. Actuators will lower
+                                priority numbers will override actuators with higher
+                                numbers.
+       @type priority: integer
+       @ivar frame: Sets the current frame for the animation.
+       @type frame: float
+       @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 blendin.
+       @type blendTime: float
+       @ivar type: The operation mode of the actuator.
+                                       KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER,
+                                       KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
+       @type type: integer
+       @ivar frameProperty: The name of the property that is set to the current frame number.
+       @type frameProperty: string
+       
        """
        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.
@@ -21,6 +49,7 @@ class BL_ShapeActionActuator(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
@@ -29,6 +58,7 @@ class BL_ShapeActionActuator(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
@@ -36,6 +66,7 @@ class BL_ShapeActionActuator(SCA_IActuator):
                """
        def setBlendin(blendin):
                """
+               DEPRECATED: use the 'blendin' property
                Specifies the number of frames of animation to generate
                when making transitions between actions.
                
@@ -45,6 +76,7 @@ class BL_ShapeActionActuator(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
@@ -54,6 +86,7 @@ class BL_ShapeActionActuator(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
@@ -62,6 +95,7 @@ class BL_ShapeActionActuator(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.
@@ -70,6 +104,7 @@ class BL_ShapeActionActuator(SCA_IActuator):
 
        def setBlendtime(blendtime):
                """
+               DEPRECATED: use the 'blendTime' property
                Sets the internal frame timer.
                 
                Allows the script to directly modify the internal timer
@@ -81,37 +116,25 @@ class BL_ShapeActionActuator(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
                @type mode: integer
                """
        
-       def setContinue(cont):
-               """
-               Set the actions continue option True or False. see getContinue.
-
-               @param cont: The continue option.
-               @type cont: bool
-               """
-
        def getType():
                """
+               DEPRECATED: use the 'type' property
                Returns the operation mode of the actuator
            
                @rtype: integer
                @return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
                """
 
-       def getContinue():
-               """
-               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
-               """
-       
        def getAction():
                """
+               DEPRECATED: use the 'action' property
                getAction() returns the name of the action associated with this actuator.
                
                @rtype: string
@@ -119,24 +142,28 @@ class BL_ShapeActionActuator(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.
                
@@ -144,23 +171,27 @@ class BL_ShapeActionActuator(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