36 Commits

Author	SHA1	Message	Date
Campbell Barton	b6631b8be7	fixes for python api docs. ... also move foreach_get/set examples into their own py example files (prefer not to have example code built into blenders binary).	2013-09-18 05:20:43 +00:00
Mitchell Stokes	9afae77fed	BGE: Finally adding support for additive layer blending. ... Currently this is only for the Python API. The logic brick will be updated in a future commit.	2013-08-14 23:31:49 +00:00
Mitchell Stokes	851627f6e0	BGE: Updating the bge.logic.expandPath() documentation to better reflect its current behavior.	2013-08-13 07:48:07 +00:00
Mitchell Stokes	460d21af6f	BGE: Adding docs for bge.logic.getProfileInfo().	2013-03-19 04:56:51 +00:00
Dalai Felinto	748dd18de4	rst doc update: adding a link to Joystick class from bge.logic.joysticks ... (so one can find more about the joystick class without having to search joystick) code untested by the way. Sorry but I can no longer build sphinx docs here. I will try to fix that later.	2013-02-28 05:18:47 +00:00
Mitchell Stokes	84966c3d0a	BGE: Committing async LibLoad from Swiss. This does the lib loading in a separate thread to keep the BGE from freezing. Here is an example from the docs: ... # Print a message when an async LibLoad is done import bge def finished_cb(status): print("Library (%s) loaded in %.2fms." % (status.libraryName, status.timeTaken)) bge.logic.LibLoad('myblend.blend', 'Scene', async=True).onFinish = finished_cb LibLoad() now returns a KX_LibLoadStatus object for information on the library loading. LibNew() and LibFree() are unaffected by this commit. In other words, the async option only works for LibLoad(). Furthermore it only works for Scenes, not Actions or Meshes.	2012-12-22 05:38:32 +00:00
Mitchell Stokes	f2f2b6153a	BGE: Adding a Python interface for handling joysticks without needing logic bricks. These new SCA_PythonJoystick objects can be accessed using bge.logic.joysticks, which is a list of joysticks. The length of the list is the number of maximum supported joysticks, and indexes that do not have a joystick available are set to None. This means joysticks can be checked for using something like: ... if bge.logic.joysticks[0]: activate_player_one() if bge.logic.joysticks[1]: activate_player_two() etc.. The interface exposed by SCA_PythonJoystick is very similar to the joystick logic brick except for one key difference: axis values are normalized to a -1.0 to 1.0 range instead of -32767 to 32767, which is what the logic brick exposed.	2012-12-21 02:28:59 +00:00
Campbell Barton	4fe35721e6	bmesh operator api reference - add in 'bmesh' arg at the start of each operator, also use :class: references.	2012-11-28 01:14:11 +00:00
Mitchell Stokes	c6f98cfa95	BGE Docs: Adding docs for bge.logic.NextFrame() and bge.logic.PrintMemInfo() based on their doc strings. There was also an :rtype: in the bge.logic.setExitKey() docs that should have been :type:.	2012-11-22 22:38:31 +00:00
Mitchell Stokes	f90298bc0a	BGE Docs: Adding docs for the KX_GameObject.playAction() play_mode constants.	2012-11-22 21:52:30 +00:00
Mitchell Stokes	2765f1fffc	BGE Docs: Reordering the "Various" constants so they are in alphabetical order.	2012-11-22 21:37:12 +00:00
Mitchell Stokes	899290dd47	BGE Docs: Moving the KX_ArmatureSensor.type constant docs from bge.types.rst to bge.logic.rst where the rest of the constants docs are.	2012-11-22 11:09:42 +00:00
Mitchell Stokes	989b5983c8	BGE Docs: Changing ROT_* Armature Channel constants in the docs to be ROT_MODE_* to match the actual constants from bge.logic.	2012-11-22 09:20:36 +00:00
Mitchell Stokes	9b571c2d54	BGE Docs: Fixing indentation.	2012-11-22 09:12:21 +00:00
Campbell Barton	762016c746	indentation edits	2012-11-22 08:30:54 +00:00
Mitchell Stokes	74ffa7bb8a	BGE Docs: Adding some basic docs for the KX_STEERING_* constants. Right now just their names and values are in the docs, not what they actually do.	2012-11-22 08:22:46 +00:00
Mitchell Stokes	d9f6edff14	BGE Docs: Moving the BL_ArmatureChannel.rotation_mode constant docs from bge.types.rst to bge.logic.rst where the rest of the constants docs are.	2012-11-22 08:16:30 +00:00
Mitchell Stokes	8dd96bcefb	BGE Docs: Moving the BL_ArmatureConstraint constant docs from bge.types.rst to bge.logic.rst with the rest of the constants docs are.	2012-11-22 08:07:13 +00:00
Mitchell Stokes	5da6c02188	BGE Docs: Adding RM_* mode constants from KX_NavMeshObject.draw()	2012-11-22 08:01:02 +00:00
Mitchell Stokes	a660ebc16e	Moving the Armature Actuator constant docs from bge.types.rst to bge.logic.rst with the rest of the constants docs are. Not only is this more consistent, but it also makes Campbell's script happier.	2012-11-22 07:52:17 +00:00
Mitchell Stokes	6a5d5ed206	Some KX_CONSTRAINTACT_* constants were incorrectly documented as KX_CONSTRAINT_*.	2012-11-22 07:31:51 +00:00
Campbell Barton	b7f5c1c121	more bge reference api docstrings, leaving KX_FontObject and KX_NavMeshObject as TODO.	2012-11-22 06:04:12 +00:00
Campbell Barton	3370e3ca43	doc corrections and add bge.types.KX_ArmatureSensor	2012-11-21 08:53:04 +00:00
Alex Fraser	27c4c1f417	Added example of KX_GameObject subclassing to game engine docs.	2012-10-02 14:15:02 +00:00
Mitchell Stokes	7fb85e1fb7	BGE LibLoad: Allow the user to disable loading text datablocks if they want to attempt to increase security by not loading potential Python scripts.	2012-07-22 22:58:12 +00:00
Dalai Felinto	359917fb2b	pydoc cleanup + remove unused bge.logic constants ... + adding PINGPONG as action actuator constant in rst	2012-01-30 06:47:01 +00:00
Campbell Barton	67c15da97d	docs / clenup (no functional code changes) ... - added API examples for mathutils.Color/Euler/Quaternion/Matrix. - corrected own bad spelling matricies --> matrices. - minor pep8 edits. - update CMake ignore file list.	2011-10-17 02:20:53 +00:00
Campbell Barton	da6bc69ca9	fix [#28191] Exception when enabling a script for a newer Blender build	2011-08-09 14:16:22 +00:00
Campbell Barton	08e184f302	note to address issue raised by report [#28190].	2011-08-09 13:50:27 +00:00
Campbell Barton	f4293067c1	py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it.	2011-07-31 03:15:37 +00:00
Dalai Felinto	dfc661565a	patch [#27909] Added constants in bge.constraints by Solano Felicio (solano) + some changes in rst ... I named all the BGE modules with their actual names (e.g. Rasterizer, Video Texture, ...). so in the API index.html page they look more like the other Blender modules. I did the same for the bgl module. For bge.constraints this patch exposes the constants values for debug mode and createConstraints (they were hardcoded innts before). + making all the "todo" and #comments into rst comments (.. comments) Thanks Solano, it's great to get help to those tasks :)	2011-07-30 23:16:22 +00:00
Dalai Felinto	26d75618ef	patch [#27871] bge.texture documentation from Solano Felício (+ changes from me) it still needs work ... ... and I can't test rst in windows so for now let's pretend it builds. If someone can generate the docs and see how it goes please let me know. (plus a small fix for bge.logic rst)	2011-07-06 07:05:29 +00:00
Campbell Barton	ce914e51ab	fix [#27659] Segfault when adding None to a group	2011-06-14 09:41:29 +00:00
Campbell Barton	214f4e8c03	include some useful info in bge docs, by ZiauddinMK on IRC.	2011-06-14 07:46:38 +00:00
Mitchell Stokes	8d100c032e	Updating BGE dynamic loading docs: ... * Adding load_action and verbose keyword args for LibLoad() * Adding LibList()	2011-04-07 04:00:56 +00:00
Luca Bonavita	996efebbe3	== python api doc == ... First commit to make some structure in doc/ directory. - moved source/blender/python/doc -> doc/python_api - moved source/gameengine/PyDoc/*.rst -> doc/python_api/rst - modified accordingly sphinx_doc_gen.py and sphinx_doc_gen.sh (later on I'll try alternative/ scripts by neXyon as promised :) - source/gameengine/PyDoc/ is still there because contains epydoc stuff for the bge, will ask more and look into it later	2010-10-13 10:42:33 +00:00