bartvdbraak/blender
1
0
Fork 4
Code Issues 4 Pull Requests 1 Actions 1 Packages Projects Releases Wiki Activity
e847bcf784
blender/source/gameengine/PyDoc
History
Campbell Barton e847bcf784 BGE Doc updates thanks to Roelf de Kock 
--- Notes from Roelf, maybe some other BGE devs could help resolve these
Here is what I have so far. I've left "TODO's" were there needs to be some more comments.

The following things also need to be resolved:

-KX_VehicleWrapper.getWheelOrientationQuaternion looks like it should return a quaternion but if I look at the code it looks like it returns a rotation matrix.

-I still need to find out what exactly KX_VehicleWrapper.getWheelRotation is. I've got the return type but I would like to add some explanation for what it actualy means (and units if any).

-BL_Shader.setNumberOfPasses ignores the parameter but from the comment in the code it looks like the parameter that is being set (it is harcoded to be =1) in setNumberOfPasses is not used. So I'm not sure if this method should be documented at all.
2009-05-11 21:35:38 +00:00
..
bge_api_validate_py.txt BGE API - small changes 2009-04-24 20:27:04 +00:00
BL_ActionActuator.py BGE Py API patch from Mitchell Stokes, add distance attribute to the radar sensor, dont use 'continue' because its a python keyword. 2009-05-02 04:53:01 +00:00
BL_Shader.py BGE Doc updates thanks to Roelf de Kock 2009-05-11 21:35:38 +00:00
BL_ShapeActionActuator.py - fixed errors with bge epydocs 2009-04-05 10:03:23 +00:00
CListValue.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
CPropValue.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
CValue.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
epy_docgen.sh BGE Doc updates thanks to Roelf de Kock 2009-05-11 21:35:38 +00:00
GameKeys.py BGE API - small changes 2009-04-24 20:27:04 +00:00
GameLogic.py moved py controller functions from SCA_PythonController to SCA_IController - the base controller class so python can get the sensors & actuators from any controller (not just SCA_PythonController types) 2009-05-06 09:12:08 +00:00
GameTypes.py SVN maintenance. 2009-04-13 19:33:22 +00:00
KX_BlenderMaterial.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
KX_Camera.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
KX_CameraActuator.py "object" and "objectLastCreated" attribute for actuators, deprecates getObject/setObject() & getLastCreatedObject() 2009-02-19 10:34:51 +00:00
KX_CDActuator.py - fixed errors with bge epydocs 2009-04-05 10:03:23 +00:00
KX_ConstraintActuator.py BGE PyAPI epydoc errors fixed 2009-04-24 07:45:17 +00:00
KX_ConstraintWrapper.py BGE api added place holder docs and CListValue docs. 2009-04-07 17:54:56 +00:00
KX_GameActuator.py BGE Py API patch from Mitchell Stokes, adds extra attributes and docs 2009-05-02 02:40:11 +00:00
KX_GameObject.py deprecate controller.getActuator(name) and controller.getSensor(name) for 2009-05-10 01:48:14 +00:00
KX_IpoActuator.py Added attributes for Ipo Actuator settings (replacing all methods) 2009-03-26 01:42:01 +00:00
KX_LightObject.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00
KX_MeshProxy.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
KX_MouseFocusSensor.py BGE MouseFocusSensor 2009-04-15 13:50:56 +00:00
KX_NearSensor.py BGE API cleanup: apply patch from Moguri: Near, Radar, Touch sensor updated. 2009-02-28 21:00:27 +00:00
KX_NetworkMessageActuator.py BGE API cleanup, patch from Moguri: RaySensor, NetworkMessageActuator, NetworkMessageSensor. 2009-03-31 19:02:01 +00:00
KX_NetworkMessageSensor.py BGE API cleanup, patch from Moguri: RaySensor, NetworkMessageActuator, NetworkMessageSensor. 2009-03-31 19:02:01 +00:00
KX_ObjectActuator.py BGE patch 17547 applied in trunk: Cleaned up pydoc for BGE, compiles now error free 2008-08-31 19:07:10 +00:00
KX_ParentActuator.py BGE Py API patch from Mitchell Stokes, adds extra attributes and docs 2009-05-02 02:40:11 +00:00
KX_PhysicsObjectWrapper.py BGE Doc updates thanks to Roelf de Kock 2009-05-11 21:35:38 +00:00
KX_PolygonMaterial.py Big patches: 2005-03-25 10:33:39 +00:00
KX_PolyProxy.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
KX_RadarSensor.py BGE API cleanup: apply patch from Moguri: Near, Radar, Touch sensor updated. 2009-02-28 21:00:27 +00:00
KX_RaySensor.py BGE API cleanup, patch from Moguri: RaySensor, NetworkMessageActuator, NetworkMessageSensor. 2009-03-31 19:02:01 +00:00
KX_SCA_AddObjectActuator.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00
KX_SCA_DynamicActuator.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00
KX_SCA_EndObjectActuator.py Updates to GamePython Reference. 2004-06-02 12:43:27 +00:00
KX_SCA_ReplaceMeshActuator.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00
KX_Scene.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
KX_SceneActuator.py moved py controller functions from SCA_PythonController to SCA_IController - the base controller class so python can get the sensors & actuators from any controller (not just SCA_PythonController types) 2009-05-06 09:12:08 +00:00
KX_SoundActuator.py BGE PyAPI epydoc errors fixed 2009-04-24 07:45:17 +00:00
KX_StateActuator.py BGE PyAPI epydoc errors fixed 2009-04-24 07:45:17 +00:00
KX_TouchSensor.py BGE api added place holder docs and CListValue docs. 2009-04-07 17:54:56 +00:00
KX_TrackToActuator.py - fixed errors with bge epydocs 2009-04-05 10:03:23 +00:00
KX_VehicleWrapper.py BGE Doc updates thanks to Roelf de Kock 2009-05-11 21:35:38 +00:00
KX_VertexProxy.py fix for a problem with setUV2 reported by cthames on blenderartist 2009-05-03 20:47:29 +00:00
KX_VisibilityActuator.py BGE: Occlusion culling and other performance improvements. 2009-04-13 20:08:33 +00:00
PyObjectPlus.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
Rasterizer.py BGE API - small changes 2009-04-24 20:27:04 +00:00
SCA_2DFilterActuator.py BGE Py API 2009-04-09 12:53:56 +00:00
SCA_ActuatorSensor.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00
SCA_AlwaysSensor.py Added Python module for Lights. 2004-05-30 11:09:46 +00:00
SCA_ANDController.py Updates to GamePython Reference. 2004-06-02 12:43:27 +00:00
SCA_DelaySensor.py - Attributes for the collision sensor: propertyName, materialCheck, pulseCollisions, objectHit and objectHitList. 2009-02-26 04:17:23 +00:00
SCA_IActuator.py Updates to GamePython Reference. 2004-06-02 12:43:27 +00:00
SCA_IController.py deprecate controller.getActuator(name) and controller.getSensor(name) for 2009-05-10 01:48:14 +00:00
SCA_ILogicBrick.py BGE Py API patch from Mitchell Stokes, adds extra attributes and docs 2009-05-02 02:40:11 +00:00
SCA_IObject.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
SCA_ISensor.py - Updated BGE docs to match the game engines class inheritance more closely. 2009-04-28 13:02:49 +00:00
SCA_JoystickSensor.py BGE Joystick Sensor 2009-04-07 06:23:45 +00:00
SCA_KeyboardSensor.py BGE Bugfix 2009-04-09 22:15:26 +00:00
SCA_MouseSensor.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00
SCA_NANDController.py SVN maintenance. 2009-04-13 19:33:22 +00:00
SCA_NORController.py SVN maintenance. 2009-04-13 19:33:22 +00:00
SCA_ORController.py Updates to GamePython Reference. 2004-06-02 12:43:27 +00:00
SCA_PropertyActuator.py First batch of GE API cleanup. 2008-12-29 16:36:58 +00:00
SCA_PropertySensor.py First batch of GE API cleanup. 2008-12-29 16:36:58 +00:00
SCA_PythonController.py moved py controller functions from SCA_PythonController to SCA_IController - the base controller class so python can get the sensors & actuators from any controller (not just SCA_PythonController types) 2009-05-06 09:12:08 +00:00
SCA_RandomActuator.py First batch of GE API cleanup. 2008-12-29 16:36:58 +00:00
SCA_RandomSensor.py Updated bge_api_validate_py.txt to check for undocumented attributes 2009-04-07 11:45:48 +00:00
SCA_XNORController.py SVN maintenance. 2009-04-13 19:33:22 +00:00
SCA_XORController.py SVN maintenance. 2009-04-13 19:33:22 +00:00
SConscript Scons epydos changed options 2009-04-19 22:02:48 +00:00
WhatsNew.py BGE Epydocs were missing some functions 2009-04-06 13:13:25 +00:00