Revision: 19562
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=19562
Author: campbellbarton
Date: 2009-04-06 15:13:25 +0200 (Mon, 06 Apr 2009)
Log Message:
-----------
BGE Epydocs were missing some functions
renamed KX_Light -> KX_LightObject
added some missing controllers
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/GameLogic.py
trunk/blender/source/gameengine/PyDoc/KX_Camera.py
trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
trunk/blender/source/gameengine/PyDoc/KX_MouseFocusSensor.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_AddObjectActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_DynamicActuator.py
trunk/blender/source/gameengine/PyDoc/KX_SCA_ReplaceMeshActuator.py
trunk/blender/source/gameengine/PyDoc/KX_Scene.py
trunk/blender/source/gameengine/PyDoc/KX_VertexProxy.py
trunk/blender/source/gameengine/PyDoc/SCA_MouseSensor.py
trunk/blender/source/gameengine/PyDoc/WhatsNew.py
Added Paths:
-----------
trunk/blender/source/gameengine/PyDoc/GameTypes.py
trunk/blender/source/gameengine/PyDoc/KX_LightObject.py
trunk/blender/source/gameengine/PyDoc/SCA_ActuatorSensor.py
trunk/blender/source/gameengine/PyDoc/SCA_NANDController.py
trunk/blender/source/gameengine/PyDoc/SCA_NORController.py
trunk/blender/source/gameengine/PyDoc/SCA_XNORController.py
trunk/blender/source/gameengine/PyDoc/SCA_XORController.py
Removed Paths:
-------------
trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py
trunk/blender/source/gameengine/PyDoc/KX_Light.py
Modified: trunk/blender/source/gameengine/PyDoc/GameLogic.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameLogic.py 2009-04-06 12:47:15 UTC (rev 19561)
+++ trunk/blender/source/gameengine/PyDoc/GameLogic.py 2009-04-06 13:13:25 UTC (rev 19562)
@@ -3,11 +3,18 @@
Documentation for the GameLogic Module.
=======================================
- There are only three importable modules in the game engine:
+ Modules available in the game engine:
- GameLogic
- L{GameKeys}
- L{Rasterizer}
+ - L{GameTypes}
+ Undocumented modules:
+ - VideoTexture
+ - CValue
+ - Expression
+ - PhysicsConstraints
+
All the other modules are accessible through the methods in GameLogic.
See L{WhatsNew} for updates, changes and new functionality in the Game Engine Python API.
@@ -18,7 +25,7 @@
# To get the game object this controller is on:
obj = co.getOwner()
- L{KX_GameObject} and L{KX_Camera} or L{KX_Light} methods are
+ L{KX_GameObject} and L{KX_Camera} or L{KX_LightObject} methods are
available depending on the type of object::
# To get a sensor linked to this controller.
# "sensorname" is the name of the sensor as defined in the Blender interface.
@@ -165,9 +172,19 @@
@var KX_DYN_DISABLE_RIGID_BODY: See L{KX_SCA_DynamicActuator}
@var KX_DYN_SET_MASS: See L{KX_SCA_DynamicActuator}
+ at group Input Status: KX_INPUT_NONE, KX_INPUT_JUST_ACTIVATED, KX_INPUT_ACTIVE, KX_INPUT_JUST_RELEASED
+ at var KX_INPUT_NONE: See L{SCA_MouseSensor}
+ at var KX_INPUT_JUST_ACTIVATED: See L{SCA_MouseSensor}
+ at var KX_INPUT_ACTIVE: See L{SCA_MouseSensor}
+ at var KX_INPUT_JUST_RELEASED: See L{SCA_MouseSensor}
+
+
+ at group Mouse Buttons: KX_MOUSE_BUT_LEFT, KX_MOUSE_BUT_MIDDLE, KX_MOUSE_BUT_RIGHT
+ at var KX_MOUSE_BUT_LEFT: See L{SCA_MouseSensor}
+ at var KX_MOUSE_BUT_MIDDLE: See L{SCA_MouseSensor}
+ at var KX_MOUSE_BUT_RIGHT: See L{SCA_MouseSensor}
"""
-
def getCurrentController():
"""
Gets the Python controller associated with this Python script.
Added: trunk/blender/source/gameengine/PyDoc/GameTypes.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameTypes.py (rev 0)
+++ trunk/blender/source/gameengine/PyDoc/GameTypes.py 2009-04-06 13:13:25 UTC (rev 19562)
@@ -0,0 +1,75 @@
+# $Id: GameLogic.py 19483 2009-03-31 21:03:15Z ben2610 $
+"""
+GameEngine Types
+================
+ at var BL_ActionActuator: L{BL_ActionActuator<BL_ActionActuator.BL_ActionActuator>}
+ at var BL_Shader: L{BL_Shader<BL_Shader.BL_Shader>}
+ at var BL_ShapeActionActuator: L{BL_ShapeActionActuator<BL_ShapeActionActuator.BL_ShapeActionActuator>}
+ at var CListValue: L{CListValue<CListValue.CListValue>}
+ at var CValue: L{CValue<CValue.CValue>}
+ at var KX_BlenderMaterial: L{KX_BlenderMaterial<KX_BlenderMaterial.KX_BlenderMaterial>}
+ at var KX_CDActuator: L{KX_CDActuator<KX_CDActuator.KX_CDActuator>}
+ at var KX_Camera: L{KX_Camera<KX_Camera.KX_Camera>}
+ at var KX_CameraActuator: L{KX_CameraActuator<KX_CameraActuator.KX_CameraActuator>}
+ at var KX_ConstraintActuator: L{KX_ConstraintActuator<KX_ConstraintActuator.KX_ConstraintActuator>}
+ at var KX_ConstraintWrapper: L{KX_ConstraintWrapper<KX_ConstraintWrapper.KX_ConstraintWrapper>}
+ at var KX_GameActuator: L{KX_GameActuator<KX_GameActuator.KX_GameActuator>}
+ at var KX_GameObject: L{KX_GameObject<KX_GameObject.KX_GameObject>}
+ at var KX_IpoActuator: L{KX_IpoActuator<KX_IpoActuator.KX_IpoActuator>}
+ at var KX_LightObject: L{KX_LightObject<KX_LightObject.KX_LightObject>}
+ at var KX_MeshProxy: L{KX_MeshProxy<KX_MeshProxy.KX_MeshProxy>}
+ at var KX_MouseFocusSensor: L{KX_MouseFocusSensor<KX_MouseFocusSensor.KX_MouseFocusSensor>}
+ at var KX_NearSensor: L{KX_NearSensor<KX_NearSensor.KX_NearSensor>}
+ at var KX_NetworkMessageActuator: L{KX_NetworkMessageActuator<KX_NetworkMessageActuator.KX_NetworkMessageActuator>}
+ at var KX_NetworkMessageSensor: L{KX_NetworkMessageSensor<KX_NetworkMessageSensor.KX_NetworkMessageSensor>}
+ at var KX_ObjectActuator: L{KX_ObjectActuator<KX_ObjectActuator.KX_ObjectActuator>}
+ at var KX_ParentActuator: L{KX_ParentActuator<KX_ParentActuator.KX_ParentActuator>}
+ at var KX_PhysicsObjectWrapper: L{KX_PhysicsObjectWrapper<KX_PhysicsObjectWrapper.KX_PhysicsObjectWrapper>}
+ at var KX_PolyProxy: L{KX_PolyProxy<KX_PolyProxy.KX_PolyProxy>}
+ at var KX_PolygonMaterial: L{KX_PolygonMaterial<KX_PolygonMaterial.KX_PolygonMaterial>}
+ at var KX_RadarSensor: L{KX_RadarSensor<KX_RadarSensor.KX_RadarSensor>}
+ at var KX_RaySensor: L{KX_RaySensor<KX_RaySensor.KX_RaySensor>}
+ at var KX_SCA_AddObjectActuator: L{KX_SCA_AddObjectActuator<KX_SCA_AddObjectActuator.KX_SCA_AddObjectActuator>}
+ at var KX_SCA_DynamicActuator: L{KX_SCA_DynamicActuator<KX_SCA_DynamicActuator.KX_SCA_DynamicActuator>}
+ at var KX_SCA_EndObjectActuator: L{KX_SCA_EndObjectActuator<KX_SCA_EndObjectActuator.KX_SCA_EndObjectActuator>}
+ at var KX_SCA_ReplaceMeshActuator: L{KX_SCA_ReplaceMeshActuator<KX_SCA_ReplaceMeshActuator.KX_SCA_ReplaceMeshActuator>}
+ at var KX_Scene: L{KX_Scene<KX_Scene.KX_Scene>}
+ at var KX_SceneActuator: L{KX_SceneActuator<KX_SceneActuator.KX_SceneActuator>}
+ at var KX_SoundActuator: L{KX_SoundActuator<KX_SoundActuator.KX_SoundActuator>}
+ at var KX_StateActuator: L{KX_StateActuator<KX_StateActuator.KX_StateActuator>}
+ at var KX_TouchSensor: L{KX_TouchSensor<KX_TouchSensor.KX_TouchSensor>}
+ at var KX_TrackToActuator: L{KX_TrackToActuator<KX_TrackToActuator.KX_TrackToActuator>}
+ at var KX_VehicleWrapper: L{KX_VehicleWrapper<KX_VehicleWrapper.KX_VehicleWrapper>}
+ at var KX_VertexProxy: L{KX_VertexProxy<KX_VertexProxy.KX_VertexProxy>}
+ at var KX_VisibilityActuator: L{KX_VisibilityActuator<KX_VisibilityActuator.KX_VisibilityActuator>}
+ at var PyObjectPlus: L{PyObjectPlus<PyObjectPlus.PyObjectPlus>}
+ at var SCA_2DFilterActuator: L{SCA_2DFilterActuator<SCA_2DFilterActuator.SCA_2DFilterActuator>}
+ at var SCA_ANDController: L{SCA_ANDController<SCA_ANDController.SCA_ANDController>}
+ at var SCA_ActuatorSensor: L{SCA_ActuatorSensor<SCA_ActuatorSensor.SCA_ActuatorSensor>}
+ at var SCA_AlwaysSensor: L{SCA_AlwaysSensor<SCA_AlwaysSensor.SCA_AlwaysSensor>}
+ at var SCA_DelaySensor: L{SCA_DelaySensor<SCA_DelaySensor.SCA_DelaySensor>}
+ at var SCA_ILogicBrick: L{SCA_ILogicBrick<SCA_ILogicBrick.SCA_ILogicBrick>}
+ at var SCA_IObject: L{SCA_IObject<SCA_IObject.SCA_IObject>}
+ at var SCA_ISensor: L{SCA_ISensor<SCA_ISensor.SCA_ISensor>}
+ at var SCA_JoystickSensor: L{SCA_JoystickSensor<SCA_JoystickSensor.SCA_JoystickSensor>}
+ at var SCA_KeyboardSensor: L{SCA_KeyboardSensor<SCA_KeyboardSensor.SCA_KeyboardSensor>}
+ at var SCA_MouseSensor: L{SCA_MouseSensor<SCA_MouseSensor.SCA_MouseSensor>}
+ at var SCA_NANDController: L{SCA_NANDController<SCA_NANDController.SCA_NANDController>}
+ at var SCA_NORController: L{SCA_NORController<SCA_NORController.SCA_NORController>}
+ at var SCA_ORController: L{SCA_ORController<SCA_ORController.SCA_ORController>}
+ at var SCA_PropertyActuator: L{SCA_PropertyActuator<SCA_PropertyActuator.SCA_PropertyActuator>}
+ at var SCA_PropertySensor: L{SCA_PropertySensor<SCA_PropertySensor.SCA_PropertySensor>}
+ at var SCA_PythonController: L{SCA_PythonController<SCA_PythonController.SCA_PythonController>}
+ at var SCA_RandomActuator: L{SCA_RandomActuator<SCA_RandomActuator.SCA_RandomActuator>}
+ at var SCA_RandomSensor: L{SCA_RandomSensor<SCA_RandomSensor.SCA_RandomSensor>}
+ at var SCA_XNORController: L{SCA_XNORController<SCA_XNORController.SCA_XNORController>}
+ at var SCA_XORController: L{SCA_XORController<SCA_XORController.SCA_XORController>}
+"""
+
+if 0:
+ # Use to print out all the links
+ for i in a.split('\n'):
+ if i.startswith('@var'):
+ var = i.split(' ')[1].split(':')[0]
+ print '@var %s: L{%s<%s.%s>}' % (var, var, var, var)
+
Deleted: trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py 2009-04-06 12:47:15 UTC (rev 19561)
+++ trunk/blender/source/gameengine/PyDoc/KX_ActuatorSensor.py 2009-04-06 13:13:25 UTC (rev 19562)
@@ -1,33 +0,0 @@
-# $Id$
-# Documentation for KX_ActuatorSensor
-from SCA_IActuator import *
-from SCA_ISensor import *
-from SCA_ILogicBrick import *
-
-class KX_ActuatorSensor(SCA_ISensor):
- """
- Actuator sensor detect change in actuator state of the parent object.
- It generates a positive pulse if the corresponding actuator is activated
- and a negative pulse if the actuator is deactivated.
-
- Properties:
-
- @ivar actuator: the name of the actuator that the sensor is monitoring.
- @type actuator: string
- """
- def getActuator():
- """
- DEPRECATED: use the actuator property
- Return the Actuator with which the sensor operates.
-
- @rtype: string
- """
- def setActuator(name):
- """
- DEPRECATED: use the actuator property
- Sets the Actuator with which to operate. If there is no Actuator
- of this name, the function has no effect.
-
- @param name: actuator name
- @type name: string
- """
Modified: trunk/blender/source/gameengine/PyDoc/KX_Camera.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_Camera.py 2009-04-06 12:47:15 UTC (rev 19561)
+++ trunk/blender/source/gameengine/PyDoc/KX_Camera.py 2009-04-06 13:13:25 UTC (rev 19562)
@@ -185,3 +185,25 @@
@param matrix: The new projection matrix for this camera.
"""
+ def enableViewport(viewport):
+ """
+ Use this camera to draw a viewport on the screen (for split screen games or overlay scenes). The viewport region is defined with L{setViewport}.
+
+ @type viewport: bool
+ @param viewport: the new viewport status
+ """
+ def setOnTop():
+ """
+ Set this cameras viewport ontop of all other viewport.
+ """
+ def setViewport(left, bottom, right, top):
+ """
+ Sets the region of this viewport on the screen in pixels.
+
+ Use L{Rasterizer.getWindowHeight} L{Rasterizer.getWindowWidth} to calculate values relative to the entire display.
+
+ @type left: int
+ @type bottom: int
+ @type right: int
+ @type top: int
+ """
Modified: trunk/blender/source/gameengine/PyDoc/KX_GameObject.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-06 12:47:15 UTC (rev 19561)
+++ trunk/blender/source/gameengine/PyDoc/KX_GameObject.py 2009-04-06 13:13:25 UTC (rev 19562)
@@ -442,5 +442,12 @@
If no hit, returns (None,None,None) or (None,None,None,None)
@@ Diff output truncated at 10240 characters. @@