~diresu/blender/blender-command-port

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/GameLogic.py

  • Committer: Dietrich Bollmann
  • Date: 2009-04-26 06:25:14 UTC
  • mfrom: (184.1.520)
  • Revision ID: diresu@web.de-20090426062514-ly27wepl1t5d7p8s
Update to state of blender repository from 2009-04-26 revision 19927.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# $Id: GameLogic.py 19620 2009-04-09 12:53:56Z campbellbarton $
 
1
# $Id: GameLogic.py 19920 2009-04-24 20:27:04Z campbellbarton $
2
2
"""
3
3
Documentation for the GameLogic Module.
4
4
=======================================
62
62
                GameLogic.addActiveActuator(actuator, True)
63
63
                
64
64
        See the actuator's reference for available methods:
 
65
                - L{2DFilterActuator<SCA_2DFilterActuator.SCA_2DFilterActuator>}
65
66
                - L{ActionActuator<BL_ActionActuator.BL_ActionActuator>}
66
67
                - L{AddObjectActuator<KX_SCA_AddObjectActuator.KX_SCA_AddObjectActuator>}
67
68
                - L{CameraActuator<KX_CameraActuator.KX_CameraActuator>}
68
69
                - L{CDActuator<KX_CDActuator.KX_CDActuator>}
69
70
                - L{ConstraintActuator<KX_ConstraintActuator.KX_ConstraintActuator>}
 
71
                - L{DynamicActuator<KX_SCA_DynamicActuator.KX_SCA_DynamicActuator>}
70
72
                - L{EndObjectActuator<KX_SCA_EndObjectActuator.KX_SCA_EndObjectActuator>}
71
73
                - L{GameActuator<KX_GameActuator.KX_GameActuator>}
72
74
                - L{IpoActuator<KX_IpoActuator.KX_IpoActuator>}
73
75
                - L{NetworkMessageActuator<KX_NetworkMessageActuator.KX_NetworkMessageActuator>}
74
76
                - L{ObjectActuator<KX_ObjectActuator.KX_ObjectActuator>}
 
77
                - L{ParentActuator<KX_ParentActuator.KX_ParentActuator>}
75
78
                - L{PropertyActuator<SCA_PropertyActuator.SCA_PropertyActuator>}
76
79
                - L{RandomActuator<SCA_RandomActuator.SCA_RandomActuator>}
77
80
                - L{ReplaceMeshActuator<KX_SCA_ReplaceMeshActuator.KX_SCA_ReplaceMeshActuator>}
78
81
                - L{SceneActuator<KX_SceneActuator.KX_SceneActuator>}
 
82
                - L{ShapeActionActuator<BL_ShapeActionActuator.BL_ShapeActionActuator>}
79
83
                - L{SoundActuator<KX_SoundActuator.KX_SoundActuator>}
 
84
                - L{StateActuator<KX_StateActuator.KX_StateActuator>}
80
85
                - L{TrackToActuator<KX_TrackToActuator.KX_TrackToActuator>}
81
86
                - L{VisibilityActuator<KX_VisibilityActuator.KX_VisibilityActuator>}
82
 
                - L{DynamicActuator<KX_SCA_DynamicActuator.KX_SCA_DynamicActuator>}
83
 
        
 
87
 
84
88
        Most logic brick's methods are accessors for the properties available in the logic buttons.
85
89
        Consult the logic bricks documentation for more information on how each logic brick works.
86
90
        
107
111
@var KX_PROPSENSOR_CHANGED:     Activate when the property changes
108
112
@var KX_PROPSENSOR_EXPRESSION:  Activate when the expression matches
109
113
 
110
 
@group Constraint Actuator: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ
 
114
 
 
115
 
 
116
 
 
117
@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
111
118
@var KX_CONSTRAINTACT_LOCX: See L{KX_ConstraintActuator}
112
119
@var KX_CONSTRAINTACT_LOCY: See L{KX_ConstraintActuator}
113
120
@var KX_CONSTRAINTACT_LOCZ: See L{KX_ConstraintActuator}
114
121
@var KX_CONSTRAINTACT_ROTX: See L{KX_ConstraintActuator}
115
122
@var KX_CONSTRAINTACT_ROTY: See L{KX_ConstraintActuator}
116
123
@var KX_CONSTRAINTACT_ROTZ: See L{KX_ConstraintActuator}
 
124
@var KX_CONSTRAINTACT_DIRNX: See L{KX_ConstraintActuator}
 
125
@var KX_CONSTRAINTACT_DIRNY: See L{KX_ConstraintActuator}
 
126
@var KX_CONSTRAINTACT_DIRPX: See L{KX_ConstraintActuator}
 
127
@var KX_CONSTRAINTACT_DIRPY: See L{KX_ConstraintActuator}
 
128
@var KX_CONSTRAINTACT_ORIX: See L{KX_ConstraintActuator}
 
129
@var KX_CONSTRAINTACT_ORIY: See L{KX_ConstraintActuator}
 
130
@var KX_CONSTRAINTACT_ORIZ: See L{KX_ConstraintActuator}
117
131
 
118
 
@group IPO Actuator: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
 
132
@group IPO Actuator: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND, KX_IPOACT_FROM_PROP
119
133
@var KX_IPOACT_PLAY:     See L{KX_IpoActuator}
120
134
@var KX_IPOACT_PINGPONG:         See L{KX_IpoActuator}
121
135
@var KX_IPOACT_FLIPPER:  See L{KX_IpoActuator}
122
136
@var KX_IPOACT_LOOPSTOP:         See L{KX_IpoActuator}
123
137
@var KX_IPOACT_LOOPEND:  See L{KX_IpoActuator}
 
138
@var KX_IPOACT_FROM_PROP:        See L{KX_IpoActuator}
124
139
 
125
140
@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
126
141
@var KX_RANDOMACT_BOOL_CONST:           See L{SCA_RandomActuator}
183
198
@var KX_MOUSE_BUT_LEFT:         See L{SCA_MouseSensor}
184
199
@var KX_MOUSE_BUT_MIDDLE:       See L{SCA_MouseSensor}
185
200
@var KX_MOUSE_BUT_RIGHT:        See L{SCA_MouseSensor}
 
201
 
 
202
@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
 
203
@var KX_STATE1:
 
204
@var KX_STATE10:
 
205
@var KX_STATE11:
 
206
@var KX_STATE12:
 
207
@var KX_STATE13:
 
208
@var KX_STATE14:
 
209
@var KX_STATE15:
 
210
@var KX_STATE16:
 
211
@var KX_STATE17:
 
212
@var KX_STATE18:
 
213
@var KX_STATE19:
 
214
@var KX_STATE2:
 
215
@var KX_STATE20:
 
216
@var KX_STATE21:
 
217
@var KX_STATE22:
 
218
@var KX_STATE23:
 
219
@var KX_STATE24:
 
220
@var KX_STATE25:
 
221
@var KX_STATE26:
 
222
@var KX_STATE27:
 
223
@var KX_STATE28:
 
224
@var KX_STATE29:
 
225
@var KX_STATE3:
 
226
@var KX_STATE30:
 
227
@var KX_STATE4:
 
228
@var KX_STATE5:
 
229
@var KX_STATE6:
 
230
@var KX_STATE7:
 
231
@var KX_STATE8:
 
232
@var KX_STATE9:
 
233
@var KX_STATE_OP_CLR:
 
234
@var KX_STATE_OP_CPY:
 
235
@var KX_STATE_OP_NEG:
 
236
@var KX_STATE_OP_SET:
 
237
 
 
238
@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
 
239
@var BL_DST_ALPHA:
 
240
@var BL_DST_COLOR:
 
241
@var BL_ONE:
 
242
@var BL_ONE_MINUS_DST_ALPHA:
 
243
@var BL_ONE_MINUS_DST_COLOR:
 
244
@var BL_ONE_MINUS_SRC_ALPHA:
 
245
@var BL_ONE_MINUS_SRC_COLOR:
 
246
@var BL_SRC_ALPHA:
 
247
@var BL_SRC_ALPHA_SATURATE:
 
248
@var BL_SRC_COLOR:
 
249
@var BL_ZERO:
 
250
@var CAM_POS:
 
251
@var CONSTANT_TIMER:
 
252
@var KX_ACT_CONSTRAINT_DISTANCE:
 
253
@var KX_ACT_CONSTRAINT_DOROTFH:
 
254
@var KX_ACT_CONSTRAINT_FHNX:
 
255
@var KX_ACT_CONSTRAINT_FHNY:
 
256
@var KX_ACT_CONSTRAINT_FHNZ:
 
257
@var KX_ACT_CONSTRAINT_FHPX:
 
258
@var KX_ACT_CONSTRAINT_FHPY:
 
259
@var KX_ACT_CONSTRAINT_FHPZ:
 
260
@var KX_ACT_CONSTRAINT_LOCAL:
 
261
@var KX_ACT_CONSTRAINT_MATERIAL:
 
262
@var KX_ACT_CONSTRAINT_NORMAL:
 
263
@var KX_ACT_CONSTRAINT_PERMANENT:
 
264
@var MODELMATRIX:
 
265
@var MODELMATRIX_INVERSE:
 
266
@var MODELMATRIX_INVERSETRANSPOSE:
 
267
@var MODELMATRIX_TRANSPOSE:
 
268
@var MODELVIEWMATRIX:
 
269
@var MODELVIEWMATRIX_INVERSE:
 
270
@var MODELVIEWMATRIX_INVERSETRANSPOSE:
 
271
@var MODELVIEWMATRIX_TRANSPOSE:
 
272
@var RAS_2DFILTER_BLUR:
 
273
@var RAS_2DFILTER_CUSTOMFILTER:
 
274
@var RAS_2DFILTER_DILATION:
 
275
@var RAS_2DFILTER_DISABLED:
 
276
@var RAS_2DFILTER_ENABLED:
 
277
@var RAS_2DFILTER_EROSION:
 
278
@var RAS_2DFILTER_GRAYSCALE:
 
279
@var RAS_2DFILTER_INVERT:
 
280
@var RAS_2DFILTER_LAPLACIAN:
 
281
@var RAS_2DFILTER_MOTIONBLUR:
 
282
@var RAS_2DFILTER_NOFILTER:
 
283
@var RAS_2DFILTER_PREWITT:
 
284
@var RAS_2DFILTER_SEPIA:
 
285
@var RAS_2DFILTER_SHARPEN:
 
286
@var RAS_2DFILTER_SOBEL:
 
287
@var SHD_TANGENT:
 
288
@var VIEWMATRIX:
 
289
@var VIEWMATRIX_INVERSE:
 
290
@var VIEWMATRIX_INVERSETRANSPOSE:
 
291
@var VIEWMATRIX_TRANSPOSE:
186
292
"""
187
293
 
 
294
# TODO
 
295
# globalDict
 
296
# error
 
297
 
188
298
def getCurrentController():
189
299
        """
190
300
        Gets the Python controller associated with this Python script.
197
307
        
198
308
        @rtype: L{KX_Scene}
199
309
        """
 
310
def getSceneList():
 
311
        """
 
312
        Gets a list of the current scenes loaded in the game engine.
 
313
        
 
314
        @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.
 
315
        
 
316
        @rtype: list of L{KX_Scene}
 
317
        """
200
318
def addActiveActuator(actuator, activate):
201
319
        """
202
320
        Activates the given actuator.
309
427
        @return: A list of filenames, with no directory prefix
310
428
        @rtype: list
311
429
        """
 
430
def PrintGLInfo():
 
431
        """
 
432
        Prints GL Extension Info into the console
 
433
        """
 
 
b'\\ No newline at end of file'