BGE API - small changes
[blender.git] / source / gameengine / PyDoc / GameLogic.py
index 1996aa3f8a94ea65a5685a46211d4892e61437c5..74e7f85201891367be7d38d83ff6f25c91944cb6 100644 (file)
@@ -62,25 +62,29 @@ Documentation for the GameLogic Module.
                GameLogic.addActiveActuator(actuator, True)
                
        See the actuator's reference for available methods:
+               - L{2DFilterActuator<SCA_2DFilterActuator.SCA_2DFilterActuator>}
                - L{ActionActuator<BL_ActionActuator.BL_ActionActuator>}
                - L{AddObjectActuator<KX_SCA_AddObjectActuator.KX_SCA_AddObjectActuator>}
                - L{CameraActuator<KX_CameraActuator.KX_CameraActuator>}
                - L{CDActuator<KX_CDActuator.KX_CDActuator>}
                - L{ConstraintActuator<KX_ConstraintActuator.KX_ConstraintActuator>}
+               - L{DynamicActuator<KX_SCA_DynamicActuator.KX_SCA_DynamicActuator>}
                - L{EndObjectActuator<KX_SCA_EndObjectActuator.KX_SCA_EndObjectActuator>}
                - L{GameActuator<KX_GameActuator.KX_GameActuator>}
                - L{IpoActuator<KX_IpoActuator.KX_IpoActuator>}
                - L{NetworkMessageActuator<KX_NetworkMessageActuator.KX_NetworkMessageActuator>}
                - L{ObjectActuator<KX_ObjectActuator.KX_ObjectActuator>}
+               - L{ParentActuator<KX_ParentActuator.KX_ParentActuator>}
                - L{PropertyActuator<SCA_PropertyActuator.SCA_PropertyActuator>}
                - L{RandomActuator<SCA_RandomActuator.SCA_RandomActuator>}
                - L{ReplaceMeshActuator<KX_SCA_ReplaceMeshActuator.KX_SCA_ReplaceMeshActuator>}
                - L{SceneActuator<KX_SceneActuator.KX_SceneActuator>}
+               - L{ShapeActionActuator<BL_ShapeActionActuator.BL_ShapeActionActuator>}
                - L{SoundActuator<KX_SoundActuator.KX_SoundActuator>}
+               - L{StateActuator<KX_StateActuator.KX_StateActuator>}
                - L{TrackToActuator<KX_TrackToActuator.KX_TrackToActuator>}
                - L{VisibilityActuator<KX_VisibilityActuator.KX_VisibilityActuator>}
-               - L{DynamicActuator<KX_SCA_DynamicActuator.KX_SCA_DynamicActuator>}
-       
+
        Most logic brick's methods are accessors for the properties available in the logic buttons.
        Consult the logic bricks documentation for more information on how each logic brick works.
        
@@ -107,20 +111,31 @@ Documentation for the GameLogic Module.
 @var KX_PROPSENSOR_CHANGED:    Activate when the property changes
 @var KX_PROPSENSOR_EXPRESSION: Activate when the expression matches
 
-@group Constraint Actuator: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ
+
+
+
+@group Constraint Actuator: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ, KX_CONSTRAINTACT_DIRNX, KX_CONSTRAINTACT_DIRNY, KX_CONSTRAINTACT_DIRPX, KX_CONSTRAINTACT_DIRPY, KX_CONSTRAINTACT_ORIX, KX_CONSTRAINTACT_ORIY, KX_CONSTRAINTACT_ORIZ
 @var KX_CONSTRAINTACT_LOCX: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_LOCY: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_LOCZ: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_ROTX: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_ROTY: See L{KX_ConstraintActuator}
 @var KX_CONSTRAINTACT_ROTZ: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_DIRNX: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_DIRNY: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_DIRPX: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_DIRPY: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_ORIX: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_ORIY: See L{KX_ConstraintActuator}
+@var KX_CONSTRAINTACT_ORIZ: See L{KX_ConstraintActuator}
 
-@group IPO Actuator: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
+@group IPO Actuator: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND, KX_IPOACT_FROM_PROP
 @var KX_IPOACT_PLAY:    See L{KX_IpoActuator}
 @var KX_IPOACT_PINGPONG:        See L{KX_IpoActuator}
 @var KX_IPOACT_FLIPPER:         See L{KX_IpoActuator}
 @var KX_IPOACT_LOOPSTOP:        See L{KX_IpoActuator}
 @var KX_IPOACT_LOOPEND:         See L{KX_IpoActuator}
+@var KX_IPOACT_FROM_PROP:       See L{KX_IpoActuator}
 
 @group Random Distributions: KX_RANDOMACT_BOOL_CONST, KX_RANDOMACT_BOOL_UNIFORM, KX_RANDOMACT_BOOL_BERNOUILLI, KX_RANDOMACT_INT_CONST, KX_RANDOMACT_INT_UNIFORM, KX_RANDOMACT_INT_POISSON, KX_RANDOMACT_FLOAT_CONST, KX_RANDOMACT_FLOAT_UNIFORM, KX_RANDOMACT_FLOAT_NORMAL, KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
 @var KX_RANDOMACT_BOOL_CONST:          See L{SCA_RandomActuator}
@@ -183,8 +198,103 @@ Documentation for the GameLogic Module.
 @var KX_MOUSE_BUT_LEFT:                See L{SCA_MouseSensor}
 @var KX_MOUSE_BUT_MIDDLE:      See L{SCA_MouseSensor}
 @var KX_MOUSE_BUT_RIGHT:       See L{SCA_MouseSensor}
+
+@group States: KX_STATE1, KX_STATE10, KX_STATE11, KX_STATE12, KX_STATE13, KX_STATE14, KX_STATE15, KX_STATE16, KX_STATE17, KX_STATE18, KX_STATE19, KX_STATE2, KX_STATE20, KX_STATE21, KX_STATE22, KX_STATE23, KX_STATE24, KX_STATE25, KX_STATE26, KX_STATE27, KX_STATE28, KX_STATE29, KX_STATE3, KX_STATE30, KX_STATE4, KX_STATE5, KX_STATE6, KX_STATE7, KX_STATE8, KX_STATE9, KX_STATE_OP_CLR, KX_STATE_OP_CPY, KX_STATE_OP_NEG, KX_STATE_OP_SET
+@var KX_STATE1:
+@var KX_STATE10:
+@var KX_STATE11:
+@var KX_STATE12:
+@var KX_STATE13:
+@var KX_STATE14:
+@var KX_STATE15:
+@var KX_STATE16:
+@var KX_STATE17:
+@var KX_STATE18:
+@var KX_STATE19:
+@var KX_STATE2:
+@var KX_STATE20:
+@var KX_STATE21:
+@var KX_STATE22:
+@var KX_STATE23:
+@var KX_STATE24:
+@var KX_STATE25:
+@var KX_STATE26:
+@var KX_STATE27:
+@var KX_STATE28:
+@var KX_STATE29:
+@var KX_STATE3:
+@var KX_STATE30:
+@var KX_STATE4:
+@var KX_STATE5:
+@var KX_STATE6:
+@var KX_STATE7:
+@var KX_STATE8:
+@var KX_STATE9:
+@var KX_STATE_OP_CLR:
+@var KX_STATE_OP_CPY:
+@var KX_STATE_OP_NEG:
+@var KX_STATE_OP_SET:
+
+@group UNSORTED: BL_DST_ALPHA, BL_DST_COLOR, BL_ONE, BL_ONE_MINUS_DST_ALPHA, BL_ONE_MINUS_DST_COLOR, BL_ONE_MINUS_SRC_ALPHA, BL_ONE_MINUS_SRC_COLOR, BL_SRC_ALPHA, BL_SRC_ALPHA_SATURATE, BL_SRC_COLOR, BL_ZERO, CAM_POS, CONSTANT_TIMER, KX_ACT_CONSTRAINT_DISTANCE, KX_ACT_CONSTRAINT_DOROTFH, KX_ACT_CONSTRAINT_FHNX, KX_ACT_CONSTRAINT_FHNY, KX_ACT_CONSTRAINT_FHNZ, KX_ACT_CONSTRAINT_FHPX, KX_ACT_CONSTRAINT_FHPY, KX_ACT_CONSTRAINT_FHPZ, KX_ACT_CONSTRAINT_LOCAL, KX_ACT_CONSTRAINT_MATERIAL, KX_ACT_CONSTRAINT_NORMAL, KX_ACT_CONSTRAINT_PERMANENT, MODELMATRIX, MODELMATRIX_INVERSE, MODELMATRIX_INVERSETRANSPOSE, MODELMATRIX_TRANSPOSE, MODELVIEWMATRIX, MODELVIEWMATRIX_INVERSE, MODELVIEWMATRIX_INVERSETRANSPOSE, MODELVIEWMATRIX_TRANSPOSE, RAS_2DFILTER_BLUR, RAS_2DFILTER_CUSTOMFILTER, RAS_2DFILTER_DILATION, RAS_2DFILTER_DISABLED, RAS_2DFILTER_ENABLED, RAS_2DFILTER_EROSION, RAS_2DFILTER_GRAYSCALE, RAS_2DFILTER_INVERT, RAS_2DFILTER_LAPLACIAN, RAS_2DFILTER_MOTIONBLUR, RAS_2DFILTER_NOFILTER, RAS_2DFILTER_PREWITT, RAS_2DFILTER_SEPIA, RAS_2DFILTER_SHARPEN, RAS_2DFILTER_SOBEL, SHD_TANGENT, VIEWMATRIX, VIEWMATRIX_INVERSE, VIEWMATRIX_INVERSETRANSPOSE, VIEWMATRIX_TRANSPOSE
+@var BL_DST_ALPHA:
+@var BL_DST_COLOR:
+@var BL_ONE:
+@var BL_ONE_MINUS_DST_ALPHA:
+@var BL_ONE_MINUS_DST_COLOR:
+@var BL_ONE_MINUS_SRC_ALPHA:
+@var BL_ONE_MINUS_SRC_COLOR:
+@var BL_SRC_ALPHA:
+@var BL_SRC_ALPHA_SATURATE:
+@var BL_SRC_COLOR:
+@var BL_ZERO:
+@var CAM_POS:
+@var CONSTANT_TIMER:
+@var KX_ACT_CONSTRAINT_DISTANCE:
+@var KX_ACT_CONSTRAINT_DOROTFH:
+@var KX_ACT_CONSTRAINT_FHNX:
+@var KX_ACT_CONSTRAINT_FHNY:
+@var KX_ACT_CONSTRAINT_FHNZ:
+@var KX_ACT_CONSTRAINT_FHPX:
+@var KX_ACT_CONSTRAINT_FHPY:
+@var KX_ACT_CONSTRAINT_FHPZ:
+@var KX_ACT_CONSTRAINT_LOCAL:
+@var KX_ACT_CONSTRAINT_MATERIAL:
+@var KX_ACT_CONSTRAINT_NORMAL:
+@var KX_ACT_CONSTRAINT_PERMANENT:
+@var MODELMATRIX:
+@var MODELMATRIX_INVERSE:
+@var MODELMATRIX_INVERSETRANSPOSE:
+@var MODELMATRIX_TRANSPOSE:
+@var MODELVIEWMATRIX:
+@var MODELVIEWMATRIX_INVERSE:
+@var MODELVIEWMATRIX_INVERSETRANSPOSE:
+@var MODELVIEWMATRIX_TRANSPOSE:
+@var RAS_2DFILTER_BLUR:
+@var RAS_2DFILTER_CUSTOMFILTER:
+@var RAS_2DFILTER_DILATION:
+@var RAS_2DFILTER_DISABLED:
+@var RAS_2DFILTER_ENABLED:
+@var RAS_2DFILTER_EROSION:
+@var RAS_2DFILTER_GRAYSCALE:
+@var RAS_2DFILTER_INVERT:
+@var RAS_2DFILTER_LAPLACIAN:
+@var RAS_2DFILTER_MOTIONBLUR:
+@var RAS_2DFILTER_NOFILTER:
+@var RAS_2DFILTER_PREWITT:
+@var RAS_2DFILTER_SEPIA:
+@var RAS_2DFILTER_SHARPEN:
+@var RAS_2DFILTER_SOBEL:
+@var SHD_TANGENT:
+@var VIEWMATRIX:
+@var VIEWMATRIX_INVERSE:
+@var VIEWMATRIX_INVERSETRANSPOSE:
+@var VIEWMATRIX_TRANSPOSE:
 """
 
+# TODO
+# globalDict
+# error
+
 def getCurrentController():
        """
        Gets the Python controller associated with this Python script.
@@ -197,6 +307,14 @@ def getCurrentScene():
        
        @rtype: L{KX_Scene}
        """
+def getSceneList():
+       """
+       Gets a list of the current scenes loaded in the game engine.
+       
+       @note: Scenes in your blend file that have not been converted wont be in this list. This list will only contain scenes such as overlays scenes.
+       
+       @rtype: list of L{KX_Scene}
+       """
 def addActiveActuator(actuator, activate):
        """
        Activates the given actuator.
@@ -309,3 +427,7 @@ def getBlendFileList(path = "//"):
        @return: A list of filenames, with no directory prefix
        @rtype: list
        """
+def PrintGLInfo():
+       """
+       Prints GL Extension Info into the console
+       """
\ No newline at end of file