Game Types (bge.types)
Introduction
This module contains the classes that appear as instances in the Game Engine. A script must interact with these classes if it is to affect the behaviour of objects in a game.
The following example would move an object (i.e. an instance of
KX_GameObject) one unit up.
# bge.types.SCA_PythonController
cont = bge.logic.getCurrentController()
# bge.types.KX_GameObject
obj = cont.owner
obj.worldPosition.z += 1
To run the code, it could be placed in a Blender text block and executed with
a SCA_PythonController logic brick.
Types
- BL_ArmatureBone(EXP_PyObjectPlus)
BL_ArmatureBoneBL_ArmatureBone.nameBL_ArmatureBone.connectedBL_ArmatureBone.hingeBL_ArmatureBone.inherit_scaleBL_ArmatureBone.bbone_segmentsBL_ArmatureBone.rollBL_ArmatureBone.headBL_ArmatureBone.tailBL_ArmatureBone.lengthBL_ArmatureBone.arm_headBL_ArmatureBone.arm_tailBL_ArmatureBone.arm_matBL_ArmatureBone.bone_matBL_ArmatureBone.parentBL_ArmatureBone.children
- BL_ArmatureChannel(EXP_PyObjectPlus)
BL_ArmatureChannelBL_ArmatureChannel.nameBL_ArmatureChannel.boneBL_ArmatureChannel.parentBL_ArmatureChannel.has_ikBL_ArmatureChannel.ik_dof_xBL_ArmatureChannel.ik_dof_yBL_ArmatureChannel.ik_dof_zBL_ArmatureChannel.ik_limit_xBL_ArmatureChannel.ik_limit_yBL_ArmatureChannel.ik_limit_zBL_ArmatureChannel.ik_rot_controlBL_ArmatureChannel.ik_lin_controlBL_ArmatureChannel.locationBL_ArmatureChannel.scaleBL_ArmatureChannel.rotation_quaternionBL_ArmatureChannel.rotation_eulerBL_ArmatureChannel.rotation_modeBL_ArmatureChannel.channel_matrixBL_ArmatureChannel.pose_matrixBL_ArmatureChannel.pose_headBL_ArmatureChannel.pose_tailBL_ArmatureChannel.ik_min_xBL_ArmatureChannel.ik_max_xBL_ArmatureChannel.ik_min_yBL_ArmatureChannel.ik_max_yBL_ArmatureChannel.ik_min_zBL_ArmatureChannel.ik_max_zBL_ArmatureChannel.ik_stiffness_xBL_ArmatureChannel.ik_stiffness_yBL_ArmatureChannel.ik_stiffness_zBL_ArmatureChannel.ik_stretchBL_ArmatureChannel.ik_rot_weightBL_ArmatureChannel.ik_lin_weightBL_ArmatureChannel.joint_rotation
- BL_ArmatureConstraint(EXP_PyObjectPlus)
BL_ArmatureConstraintBL_ArmatureConstraint.typeBL_ArmatureConstraint.nameBL_ArmatureConstraint.enforceBL_ArmatureConstraint.headtailBL_ArmatureConstraint.lin_errorBL_ArmatureConstraint.rot_errorBL_ArmatureConstraint.targetBL_ArmatureConstraint.subtargetBL_ArmatureConstraint.activeBL_ArmatureConstraint.ik_weightBL_ArmatureConstraint.ik_typeBL_ArmatureConstraint.ik_flagBL_ArmatureConstraint.ik_distBL_ArmatureConstraint.ik_mode
- BL_ArmatureObject(KX_GameObject)
- BL_Shader(EXP_PyObjectPlus)
BL_ShaderBL_Shader.enabledBL_Shader.objectCallbacksBL_Shader.bindCallbacksBL_Shader.setUniformfv()BL_Shader.delSource()BL_Shader.getFragmentProg()BL_Shader.getVertexProg()BL_Shader.isValid()BL_Shader.setAttrib()BL_Shader.setSampler()BL_Shader.setSource()BL_Shader.setSourceList()BL_Shader.setUniform1f()BL_Shader.setUniform1i()BL_Shader.setUniform2f()BL_Shader.setUniform2i()BL_Shader.setUniform3f()BL_Shader.setUniform3i()BL_Shader.setUniform4f()BL_Shader.setUniform4i()BL_Shader.setUniformDef()BL_Shader.setUniformMatrix3()BL_Shader.setUniformMatrix4()BL_Shader.setUniformiv()BL_Shader.setUniformEyef()BL_Shader.validate()
- BL_Texture(EXP_Value)
- EXP_ListValue(EXP_PropValue)
- EXP_PropValue(EXP_Value)
- EXP_PyObjectPlus
- EXP_Value(EXP_PyObjectPlus)
- KX_2DFilter(BL_Shader)
- KX_2DFilterOffScreen(EXP_Value)
- KX_2DFilterManager(EXP_PyObjectPlus)
- KX_BlenderMaterial(EXP_PyObjectPlus)
- KX_Camera(KX_GameObject)
KX_CameraKX_Camera.INSIDEKX_Camera.INTERSECTKX_Camera.OUTSIDEKX_Camera.lensKX_Camera.lodDistanceFactorKX_Camera.fovKX_Camera.ortho_scaleKX_Camera.nearKX_Camera.farKX_Camera.shift_xKX_Camera.shift_yKX_Camera.perspectiveKX_Camera.projection_matrixKX_Camera.modelview_matrixKX_Camera.camera_to_worldKX_Camera.world_to_cameraKX_Camera.useViewportKX_Camera.activityCullingKX_Camera.sphereInsideFrustum()KX_Camera.boxInsideFrustum()KX_Camera.pointInsideFrustum()KX_Camera.getCameraToWorld()KX_Camera.getWorldToCamera()KX_Camera.setOnTop()KX_Camera.setViewport()KX_Camera.getScreenPosition()KX_Camera.getScreenVect()KX_Camera.getScreenRay()
- KX_CharacterWrapper(EXP_PyObjectPlus)
KX_CharacterWrapperKX_CharacterWrapper.onGroundKX_CharacterWrapper.gravityKX_CharacterWrapper.fallSpeedKX_CharacterWrapper.maxJumpsKX_CharacterWrapper.jumpCountKX_CharacterWrapper.jumpSpeedKX_CharacterWrapper.maxSlopeKX_CharacterWrapper.walkDirectionKX_CharacterWrapper.jump()KX_CharacterWrapper.setVelocity()KX_CharacterWrapper.reset()
- KX_CollisionContactPoint(EXP_Value)
KX_CollisionContactPointKX_CollisionContactPoint.localPointAKX_CollisionContactPoint.localPointBKX_CollisionContactPoint.worldPointKX_CollisionContactPoint.normalKX_CollisionContactPoint.combinedFrictionKX_CollisionContactPoint.combinedRollingFrictionKX_CollisionContactPoint.combinedRestitutionKX_CollisionContactPoint.appliedImpulse
- KX_ConstraintWrapper(EXP_PyObjectPlus)
- KX_FontObject(KX_GameObject)
- KX_GameObject(SCA_IObject)
KX_GameObjectKX_GameObject.nameKX_GameObject.massKX_GameObject.frictionKX_GameObject.isSuspendDynamicsKX_GameObject.linearDampingKX_GameObject.angularDampingKX_GameObject.linVelocityMinKX_GameObject.linVelocityMaxKX_GameObject.angularVelocityMinKX_GameObject.angularVelocityMaxKX_GameObject.localInertiaKX_GameObject.parentKX_GameObject.groupMembersKX_GameObject.groupObjectKX_GameObject.collisionGroupKX_GameObject.collisionMaskKX_GameObject.collisionCallbacksKX_GameObject.sceneKX_GameObject.visibleKX_GameObject.layerKX_GameObject.cullingBoxKX_GameObject.culledKX_GameObject.colorKX_GameObject.physicsCullingKX_GameObject.logicCullingKX_GameObject.physicsCullingRadiusKX_GameObject.logicCullingRadiusKX_GameObject.occlusionKX_GameObject.positionKX_GameObject.orientationKX_GameObject.scalingKX_GameObject.localOrientationKX_GameObject.worldOrientationKX_GameObject.localScaleKX_GameObject.worldScaleKX_GameObject.localPositionKX_GameObject.worldPositionKX_GameObject.localTransformKX_GameObject.worldTransformKX_GameObject.localLinearVelocityKX_GameObject.worldLinearVelocityKX_GameObject.localAngularVelocityKX_GameObject.worldAngularVelocityKX_GameObject.gravityKX_GameObject.timeOffsetKX_GameObject.blenderObjectKX_GameObject.stateKX_GameObject.meshesKX_GameObject.batchGroupKX_GameObject.sensorsKX_GameObject.controllersKX_GameObject.actuatorsKX_GameObject.attrDictKX_GameObject.componentsKX_GameObject.childrenKX_GameObject.childrenRecursiveKX_GameObject.lifeKX_GameObject.debugKX_GameObject.debugRecursiveKX_GameObject.currentLodLevelKX_GameObject.lodManagerKX_GameObject.onRemoveKX_GameObject.loggerKX_GameObject.loggerNameKX_GameObject.endObject()KX_GameObject.replaceMesh()KX_GameObject.setVisible()KX_GameObject.setOcclusion()KX_GameObject.alignAxisToVect()KX_GameObject.getAxisVect()KX_GameObject.applyMovement()KX_GameObject.applyRotation()KX_GameObject.applyForce()KX_GameObject.applyTorque()KX_GameObject.getLinearVelocity()KX_GameObject.setLinearVelocity()KX_GameObject.getAngularVelocity()KX_GameObject.setAngularVelocity()KX_GameObject.getVelocity()KX_GameObject.getReactionForce()KX_GameObject.applyImpulse()KX_GameObject.setDamping()KX_GameObject.suspendPhysics()KX_GameObject.restorePhysics()KX_GameObject.suspendDynamics()KX_GameObject.restoreDynamics()KX_GameObject.enableRigidBody()KX_GameObject.disableRigidBody()KX_GameObject.setCcdMotionThreshold()KX_GameObject.setCcdSweptSphereRadius()KX_GameObject.setParent()KX_GameObject.removeParent()KX_GameObject.getPhysicsId()KX_GameObject.getPropertyNames()KX_GameObject.getDistanceTo()KX_GameObject.getVectTo()KX_GameObject.rayCastTo()KX_GameObject.rayCast()KX_GameObject.collide()KX_GameObject.setCollisionMargin()KX_GameObject.sendMessage()KX_GameObject.reinstancePhysicsMesh()KX_GameObject.replacePhysicsShape()KX_GameObject.get()KX_GameObject.playAction()KX_GameObject.stopAction()KX_GameObject.getActionFrame()KX_GameObject.getActionName()KX_GameObject.setActionFrame()KX_GameObject.isPlayingAction()KX_GameObject.addDebugProperty()
- KX_LibLoadStatus(EXP_PyObjectPlus)
- KX_LightObject(KX_GameObject)
- KX_LodLevel(EXP_PyObjectPlus)
- KX_LodManager(EXP_PyObjectPlus)
- KX_MeshProxy(EXP_Value)
- KX_NavMeshObject(KX_GameObject)
- KX_PolyProxy(SCA_IObject)
KX_PolyProxyKX_PolyProxy.material_nameKX_PolyProxy.materialKX_PolyProxy.texture_nameKX_PolyProxy.material_idKX_PolyProxy.v1KX_PolyProxy.v2KX_PolyProxy.v3KX_PolyProxy.v4KX_PolyProxy.visibleKX_PolyProxy.collideKX_PolyProxy.verticesKX_PolyProxy.getMaterialName()KX_PolyProxy.getMaterial()KX_PolyProxy.getTextureName()KX_PolyProxy.getMaterialIndex()KX_PolyProxy.getNumVertex()KX_PolyProxy.isVisible()KX_PolyProxy.isCollider()KX_PolyProxy.getVertexIndex()KX_PolyProxy.getMesh()
- KX_PythonComponent(EXP_Value)
- KX_Scene(EXP_PyObjectPlus)
KX_SceneKX_Scene.nameKX_Scene.objectsKX_Scene.objectsInactiveKX_Scene.lightsKX_Scene.camerasKX_Scene.textsKX_Scene.active_cameraKX_Scene.overrideCullingCameraKX_Scene.worldKX_Scene.filterManagerKX_Scene.suspendedKX_Scene.activityCullingKX_Scene.dbvt_cullingKX_Scene.pre_drawKX_Scene.post_drawKX_Scene.pre_draw_setupKX_Scene.onRemoveKX_Scene.gravityKX_Scene.loggerKX_Scene.loggerNameKX_Scene.addObject()KX_Scene.end()KX_Scene.restart()KX_Scene.replace()KX_Scene.suspend()KX_Scene.resume()KX_Scene.get()KX_Scene.drawObstacleSimulation()KX_Scene.convertBlenderObject()KX_Scene.convertBlenderObjectsList()KX_Scene.convertBlenderCollection()KX_Scene.convertBlenderAction()KX_Scene.unregisterBlenderAction()KX_Scene.addOverlayCollection()KX_Scene.removeOverlayCollection()KX_Scene.getGameObjectFromObject()
- KX_VehicleWrapper(EXP_PyObjectPlus)
KX_VehicleWrapperKX_VehicleWrapper.addWheel()KX_VehicleWrapper.applyBraking()KX_VehicleWrapper.applyEngineForce()KX_VehicleWrapper.getConstraintId()KX_VehicleWrapper.getConstraintType()KX_VehicleWrapper.getNumWheels()KX_VehicleWrapper.getWheelOrientationQuaternion()KX_VehicleWrapper.getWheelPosition()KX_VehicleWrapper.getWheelRotation()KX_VehicleWrapper.setRollInfluence()KX_VehicleWrapper.setSteeringValue()KX_VehicleWrapper.setSuspensionCompression()KX_VehicleWrapper.setSuspensionDamping()KX_VehicleWrapper.setSuspensionStiffness()KX_VehicleWrapper.setTyreFriction()KX_VehicleWrapper.rayMask
- KX_VertexProxy(SCA_IObject)
KX_VertexProxyKX_VertexProxy.XYZKX_VertexProxy.UVKX_VertexProxy.uvsKX_VertexProxy.normalKX_VertexProxy.colorKX_VertexProxy.colorsKX_VertexProxy.xKX_VertexProxy.yKX_VertexProxy.zKX_VertexProxy.uKX_VertexProxy.vKX_VertexProxy.u2KX_VertexProxy.v2KX_VertexProxy.rKX_VertexProxy.gKX_VertexProxy.bKX_VertexProxy.aKX_VertexProxy.getXYZ()KX_VertexProxy.getUV()KX_VertexProxy.getUV2()KX_VertexProxy.getRGBA()KX_VertexProxy.getNormal()
- SCA_2DFilterActuator(SCA_IActuator)
- SCA_ANDController(SCA_IController)
- SCA_ActionActuator(SCA_IActuator)
- SCA_ActuatorSensor(SCA_ISensor)
- SCA_AddObjectActuator(SCA_IActuator)
- SCA_AlwaysSensor(SCA_ISensor)
- SCA_ArmatureActuator(SCA_IActuator)
- SCA_ArmatureSensor(SCA_ISensor)
- SCA_CameraActuator(SCA_IActuator)
- SCA_CollisionSensor(SCA_ISensor)
- SCA_ConstraintActuator(SCA_IActuator)
SCA_ConstraintActuatorSCA_ConstraintActuator.dampSCA_ConstraintActuator.rotDampSCA_ConstraintActuator.directionSCA_ConstraintActuator.optionSCA_ConstraintActuator.timeSCA_ConstraintActuator.propNameSCA_ConstraintActuator.minSCA_ConstraintActuator.distanceSCA_ConstraintActuator.maxSCA_ConstraintActuator.rayLengthSCA_ConstraintActuator.limit
- SCA_DelaySensor(SCA_ISensor)
- SCA_DynamicActuator(SCA_IActuator)
- SCA_EndObjectActuator(SCA_IActuator)
- SCA_GameActuator(SCA_IActuator)
- SCA_IActuator(SCA_ILogicBrick)
- SCA_IController(SCA_ILogicBrick)
- SCA_ILogicBrick(EXP_Value)
- SCA_IObject(EXP_Value)
- SCA_ISensor(SCA_ILogicBrick)
- SCA_InputEvent(EXP_PyObjectPlus)
- SCA_JoystickSensor(SCA_ISensor)
SCA_JoystickSensorSCA_JoystickSensor.axisValuesSCA_JoystickSensor.axisSingleSCA_JoystickSensor.hatValuesSCA_JoystickSensor.hatSingleSCA_JoystickSensor.numAxisSCA_JoystickSensor.numButtonsSCA_JoystickSensor.numHatsSCA_JoystickSensor.connectedSCA_JoystickSensor.indexSCA_JoystickSensor.thresholdSCA_JoystickSensor.buttonSCA_JoystickSensor.axisSCA_JoystickSensor.hatSCA_JoystickSensor.getButtonActiveList()SCA_JoystickSensor.getButtonStatus()
- SCA_KeyboardSensor(SCA_ISensor)
- SCA_MouseActuator(SCA_IActuator)
SCA_MouseActuatorSCA_MouseActuator.reset()SCA_MouseActuator.visibleSCA_MouseActuator.use_axis_xSCA_MouseActuator.use_axis_ySCA_MouseActuator.thresholdSCA_MouseActuator.reset_xSCA_MouseActuator.reset_ySCA_MouseActuator.object_axisSCA_MouseActuator.local_xSCA_MouseActuator.local_ySCA_MouseActuator.sensitivitySCA_MouseActuator.limit_xSCA_MouseActuator.limit_ySCA_MouseActuator.angle
- SCA_MouseFocusSensor(SCA_MouseSensor)
SCA_MouseFocusSensorSCA_MouseFocusSensor.raySourceSCA_MouseFocusSensor.rayTargetSCA_MouseFocusSensor.rayDirectionSCA_MouseFocusSensor.hitObjectSCA_MouseFocusSensor.hitPositionSCA_MouseFocusSensor.hitNormalSCA_MouseFocusSensor.hitUVSCA_MouseFocusSensor.usePulseFocusSCA_MouseFocusSensor.useXRaySCA_MouseFocusSensor.maskSCA_MouseFocusSensor.propNameSCA_MouseFocusSensor.useMaterial
- SCA_MouseSensor(SCA_ISensor)
- SCA_NANDController(SCA_IController)
- SCA_NORController(SCA_IController)
- SCA_NearSensor(KX_CollisionSensor)
- SCA_NetworkMessageActuator(SCA_IActuator)
- SCA_NetworkMessageSensor(SCA_ISensor)
- SCA_ORController(SCA_IController)
- SCA_ObjectActuator(SCA_IActuator)
SCA_ObjectActuatorSCA_ObjectActuator.forceSCA_ObjectActuator.useLocalForceSCA_ObjectActuator.torqueSCA_ObjectActuator.useLocalTorqueSCA_ObjectActuator.dLocSCA_ObjectActuator.useLocalDLocSCA_ObjectActuator.dRotSCA_ObjectActuator.useLocalDRotSCA_ObjectActuator.linVSCA_ObjectActuator.useLocalLinVSCA_ObjectActuator.angVSCA_ObjectActuator.useLocalAngVSCA_ObjectActuator.dampingSCA_ObjectActuator.forceLimitXSCA_ObjectActuator.forceLimitYSCA_ObjectActuator.forceLimitZSCA_ObjectActuator.pidSCA_ObjectActuator.reference
- SCA_ParentActuator(SCA_IActuator)
- SCA_PropertyActuator(SCA_IActuator)
- SCA_PropertySensor(SCA_ISensor)
- SCA_PythonController(SCA_IController)
- SCA_PythonJoystick(EXP_PyObjectPlus)
SCA_PythonJoystickSCA_PythonJoystick.nameSCA_PythonJoystick.activeButtonsSCA_PythonJoystick.axisValuesSCA_PythonJoystick.hatValuesSCA_PythonJoystick.numAxisSCA_PythonJoystick.numButtonsSCA_PythonJoystick.numHatsSCA_PythonJoystick.startVibration()SCA_PythonJoystick.stopVibration()SCA_PythonJoystick.strengthLeftSCA_PythonJoystick.strengthRightSCA_PythonJoystick.durationSCA_PythonJoystick.isVibratingSCA_PythonJoystick.hasVibration
- SCA_PythonKeyboard(EXP_PyObjectPlus)
- SCA_PythonMouse(EXP_PyObjectPlus)
- SCA_RadarSensor(SCA_NearSensor)
- SCA_RandomActuator(SCA_IActuator)
SCA_RandomActuatorSCA_RandomActuator.seedSCA_RandomActuator.para1SCA_RandomActuator.para2SCA_RandomActuator.distributionSCA_RandomActuator.propNameSCA_RandomActuator.setBoolConst()SCA_RandomActuator.setBoolUniform()SCA_RandomActuator.setBoolBernouilli()SCA_RandomActuator.setIntConst()SCA_RandomActuator.setIntUniform()SCA_RandomActuator.setIntPoisson()SCA_RandomActuator.setFloatConst()SCA_RandomActuator.setFloatUniform()SCA_RandomActuator.setFloatNormal()SCA_RandomActuator.setFloatNegativeExponential()
- SCA_RandomSensor(SCA_ISensor)
- SCA_RaySensor(SCA_ISensor)
- SCA_ReplaceMeshActuator(SCA_IActuator)
- SCA_SceneActuator(SCA_IActuator)
- SCA_SoundActuator(SCA_IActuator)
SCA_SoundActuatorSCA_SoundActuator.volumeSCA_SoundActuator.timeSCA_SoundActuator.pitchSCA_SoundActuator.modeSCA_SoundActuator.soundSCA_SoundActuator.is3DSCA_SoundActuator.preloadSCA_SoundActuator.volume_maximumSCA_SoundActuator.volume_minimumSCA_SoundActuator.distance_referenceSCA_SoundActuator.distance_maximumSCA_SoundActuator.attenuationSCA_SoundActuator.cone_angle_innerSCA_SoundActuator.cone_angle_outerSCA_SoundActuator.cone_volume_outerSCA_SoundActuator.startSound()SCA_SoundActuator.pauseSound()SCA_SoundActuator.stopSound()
- SCA_StateActuator(SCA_IActuator)
- SCA_SteeringActuator(SCA_IActuator)
SCA_SteeringActuatorSCA_SteeringActuator.behaviorSCA_SteeringActuator.velocitySCA_SteeringActuator.accelerationSCA_SteeringActuator.turnspeedSCA_SteeringActuator.distanceSCA_SteeringActuator.targetSCA_SteeringActuator.navmeshSCA_SteeringActuator.selfterminatedSCA_SteeringActuator.enableVisualizationSCA_SteeringActuator.lockZVelocitySCA_SteeringActuator.pathUpdatePeriodSCA_SteeringActuator.pathLerpFactorSCA_SteeringActuator.path
- SCA_TrackToActuator(SCA_IActuator)
- SCA_VibrationActuator(SCA_IActuator)
- SCA_VisibilityActuator(SCA_IActuator)
- SCA_XNORController(SCA_IController)
- SCA_XORController(SCA_IController)