Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2015-09-08Cleanup: API docsCampbell Barton
2015-09-07Doc: PyAPI docs, quiet warnings, fix URL'sCampbell Barton
2015-09-07Doc: update Python 'gpu' module referenceCampbell Barton
- add missing uniforms. - add uniform types. - link to RNA equivalent. - remove 'value' from uniforms (they were wrong, better use module members anyway). - various corrections & edits. Fixes T45505
2015-09-03Cleanup: minor RST editsCampbell Barton
2015-09-03BGE docs: resolution & fullscreen changes don't work in the embedded playerSybren A. Stüvel
The documentation for bge.render.{setWindowSize,setFullScreen,getFullScreen} did not mention that those functions are no-ops when using the Blender- embedded player.
2015-08-25BGE: added bge.logic.{get,set}AnimRecordFrame functionsSybren A. Stüvel
By using getAnimRecordFrame(), game developers have access to the frame number used by the "Record animation" feature. This enables them to record additional information in Blender's F-Curves and ensuring perfect synchronization with the information already recorded by Blender. The setAnimRecordFrame() can be used to change the frame number at which animations are recorded, for example to introduce delays the recording that do not require delays in the actual game/simulation run. The getter/setter functions in KX_KetsjiEngine are not directly named after property they access (m_currentFrame). I found "current frame" to be too vague for a public interface, hence chose a more descriptive name. Reviewers: moguri, hg1, campbellbarton, panzergame, aligorith Reviewed By: panzergame, aligorith Differential Revision: https://developer.blender.org/D1449
2015-08-18Docs: function commentsCampbell Barton
2015-08-05Doc fix: rather then -> rather thanSybren A. Stüvel
2015-08-04BGE: Added getActionName() function to KX_GameObject()Mateo de Mayo
It works similar to getActionFrame(), you have to give a layer or not (for layer 0) as the argument and it returns the name of the animation that the object is currently playing. Example: ``` import bge own = bge.logic.getCurrentController().owner own.playAction("SomeAction",0,20) print(own.getActionName()) ``` >> SomeAction Here is an example file, just open the blend file with the terminal opened and press P, you can see how the current animation is being printed: {F217484} Reviewers: moguri, hg1, panzergame, campbellbarton Reviewed By: panzergame Subscribers: campbellbarton, hg1, #game_engine Projects: #game_engine Differential Revision: https://developer.blender.org/D1443
2015-08-01Docs: Python API, minor edits to download linkCampbell Barton
2015-08-01Docs: doxy cleanup/minor editsCampbell Barton
2015-07-29Add mathutils.bvhtree APICampbell Barton
Originally D966 by @lukastoenne, with own additions - trees can be initialized from Object's, BMesh, or passed in as vert+polygon arrays. - original indices of ngons/faces are used. (instead of tessellated indices). - ray_cast, find_nearest methods - find overlapping faces between 2 trees
2015-07-27Doc fix: wolrd -> worldSybren A. Stüvel
The documentation for bge.types.KX_WorldInfo had two typos.
2015-07-22Fix: solved issue with "make doc_py"Sybren A. Stüvel
The error was "ValueError: Function <function normal_at_I0D at 0x7f2aad1feb70> has keyword-only arguments or annotations, use getfullargspec() API which can support them", and was first seen in eeeb845d33e81afbc8ed127e6ab4ae7b18472a54
2015-07-12Docs; Py API gotcha's sectionCampbell Barton
Minor corrections and cleanup
2015-07-07Remove redundant lists, link insteadCampbell Barton
2015-07-07Remove unnecessary constant infoCampbell Barton
Noting every constant as an int isnt helping, this is only meant to be passed to only.
2015-07-06BGE: bge.texture API documentation enhancementQuentin Wenger
This patch attempts to improve and review the documentation of bge.texture, as requested in the [[ http://wiki.blender.org/index.php/Dev:2.5/Source/Development/Todo/GameEngine#Video_Texture | TODO list ]]. More specifically, it - fixes the rst syntax, including titles of the examples bge.texture.py and bge.texture.1.py; - adds, standardizes and reviews description of the API elements, particularly signatures, types, etc. - adds SOURCE_* constants to the doc - splits the doc into thematical parts (Video, Image, Texture, and Filter Classes, Functions, Constants). Notes: - The parameter "mode" of ImageBuff.plot has to be described better. Actually, the whole set of IMB_BLEND_* constants (from IMB_imbuf.h) should be exposed to Python. I'll do that in a future diff, and complete the doc at the same moment (adding those IMB_BLEND_* constants to the Constants part of this doc). - The option of using webcams in VideoFFmpeg is still particularly not well documented. I am planning to make a proposal about fixing T18634 (and its corresponding TODO in the list) by integrating OpenCV in the BGE (and Blender?). The idea would then probably be to add a new class, f.ex. ImageWebcam, making this functionnality more specialized. So for now I don't think it is worth to document that part much. This patch fixes T44284 too. Reviewers: moguri, kupoman, campbellbarton, panzergame, lordloki Reviewed By: panzergame, lordloki Subscribers: hg1 Projects: #game_engine, #game_python, #documentation Maniphest Tasks: T44284 Differential Revision: https://developer.blender.org/D1352
2015-07-03BGE: Extend Python API for KX_BlenderMaterial (specular, diffuse…)Porteries Tristan
Add support for material diffuse, specular… in KX_BlenderMaterial python proxy. And use mathutils in KX_BlenderMaterial for the specular and diffuse color in KX_BlenderMaterial. Reviewers: sybren, brita_, kupoman, agoose77, dfelinto, moguri, campbellbarton, hg1 Reviewed By: moguri, campbellbarton, hg1 Subscribers: dfelinto Projects: #game_engine Differential Revision: https://developer.blender.org/D1298
2015-07-02Game Engine: Camera Lens Shift: support to change it during gameDalai Felinto
2015-07-01BGE: Remove KX_PolygonMaterial reference in documentation.Porteries Tristan
2015-06-30CMake: remove helper textCampbell Barton
Its out of date, better use the wiki building docs.
2015-06-28BGE: added clamping of angular velocity.Sybren A. Stüvel
Angular velocity clamping was missing from the BGE. It is implemented similarly to the linear velocity clamping. It is needed to be able to drive physical simulations of systems that have a limited rotational speed. Reviewed by: campbellbarton, panzergame, ton Differential Revision: https://developer.blender.org/D1365
2015-06-24BGE: Missing dot in 2d filter actuator documentation.Quentin Wenger
2015-06-24BGE: Fix 2dfilter actuator mode constants.Quentin Wenger
2015-06-23BGE: Fix 57065a, missing dots.Porteries Tristan
2015-06-23Minor tweaks to bge.constraints docsCampbell Barton
2015-06-23Update bge.constraints API docCampbell Barton
D1357 by @Matpi with edits.
2015-06-18update hand written rst docsCampbell Barton
- minor corrections - link to new manual - wrap lines at 120
2015-06-17BGE: remove outdated doc of KX_PolygonMaterial, update doc of KX_BlenderMaterialQuentin Wenger
This patch suppresses the outdated KX_PolygonMaterial.rst documentation file and moves the example contained in it into KX_BlenderMaterial.rst. The file KX_BlenderMaterial.rst receives some extra formatting changes (lists are not supported in methods arguments types). Reviewers: kupoman, campbellbarton, lordloki, panzergame, moguri Reviewed By: panzergame, moguri Projects: #game_engine Differential Revision: https://developer.blender.org/D1355
2015-06-16BGE: correct case for createConstraint keywordCampbell Barton
2015-06-16BGE: Fix for precision lost in setBackground/getBackground at Video TextureJorge Bernal
Now internally the variables are processed as floats avoiding int->float->char conversions that are causing precision lost. A check for int numbers is maintained to keep compatibility with old behaviour. Reviewers: ben2610, campbellbarton, moguri, hg1 Reviewed By: moguri, hg1 Subscribers: campbellbarton Projects: #game_engine Differential Revision: https://developer.blender.org/D1301
2015-06-15BGE: Fix T43918: adding submodule bge.app including attribute version.Porteries Tristan
This patch adds the submodule app to bge. apps contains constants similar to bpy.app, particularly version (tuple of three ints like 2.75.1). It was requested in T43918 and set as TODO. The patch also adds rst doc for the module. Reviewers: moguri, kupoman, lordloki, panzergame, campbellbarton Reviewed By: lordloki, panzergame, campbellbarton Subscribers: marcino15 Projects: #game_logic, #game_python, #game_engine Differential Revision: https://developer.blender.org/D1348
2015-06-06Revert "BGE : KX_VertexProxy support for more than 2 UV channel."Mitchell Stokes
This reverts commit fb0dd596e9a58f095730359a11759c40ea46be44. This commit reintroduced a deprecated API that we'd rather not see in a release. A better solution is being worked on.
2015-05-27BGE Python API: Completing doc for bge.types.KX_FontObjectQuentin Wenger
This adds description of the Font object and about its (only one) attribute, as well as an example of use. Reviewers: campbellbarton, fsiddi, dfelinto, moguri Reviewed By: dfelinto Subscribers: lordloki Projects: #documentation, #game_engine Differential Revision: https://developer.blender.org/D863
2015-05-20BGE: Some changes for the constraint documentThomas Szepe
* Change the constraint type alignment to vertical. * Changed PHY_CONE_TWIST_CONSTRAINT to the correct value. * Some minor changes.
2015-05-20BGE: Remove chapter in KX_WorldInfo python APIThomas Szepe
2015-05-20doxygen: corrections/updatesCampbell Barton
Also add depsgraph & physics
2015-05-20doxygen: update configCampbell Barton
2015-05-20doxygen: rename included files (they were ignored)Campbell Barton
2015-05-20BGE: Use CameCase code style for KX_WorldInfo python API.Porteries Tristan
2015-05-17Cleanup: pep8Campbell Barton
2015-05-12Doc: add bpy.utils.previewsCampbell Barton
Updated sphinx_doc_gen.py to better handle pure py-classes.
2015-05-12Doc: correct rst syntaxCampbell Barton
also remove some API docs from example
2015-05-12Doc: minor fixesCampbell Barton
- check for class/static methods assumed nonzero args. - subclass references and set-flag items are now sorted. - use 'order' for Py operator mix-ins, so operator settings don't show in random order.
2015-05-10BGE: Cleanup constraints documentationThomas Szepe
* Fixing Python example. Behavior has changed with Blender 2.74 * Adding missing return type * Fixing typo simbolic * Fixing note for upper/lower limit * Adding link to constraints constants
2015-05-06BGE : KX_VertexProxy support for more than 2 UV channel.Porteries Tristan
I have added an optional named "index" argument for methode get/setUV, I have also modified the and set to deprecated methodes setUV2 and getUV2 : the doc was wrong and the methode can't be called anyway because it declared as VARARG in the .h and convert directly the args value to a vector in the .cpp. Reviewers: sybren, lordloki, hg1 Reviewed By: lordloki, hg1 Subscribers: agoose77 Differential Revision: https://developer.blender.org/D1240
2015-05-04BGE: Added 'ghost' arg to KX_GameObject.suspendDynamics() methodSybren A. Stüvel
The implementation of this 'ghost' argument already existed in the C++ source, but wasn't exposed to Python yet.
2015-04-26BGE : addObject in python without reference object.Porteries Tristan
Making the reference argument optional for the addObject function. ``` scene.addObject("Cube") ``` This allows to keep the rotation, scale and position of the original object. To avoid layer problems with lights if the reference arguments is None, the new object have the same layer than the active layers in scene. Reviewers: lordloki, moguri, hg1, sybren Reviewed By: hg1, sybren Subscribers: agoose77 Projects: #game_engine Differential Revision: https://developer.blender.org/D1222
2015-04-24correcting typos in python api docsInes Almeida