== python api docs ==
* source/blender/python/doc/sphinx_doc_gen.py changed syntax for declating attributes type to use :type: instead of *type* os it * source/gameengine/Ketsji/KX_PythonInit.cpp While documenting I've found that we have two naming conventions for constraints in BGE python api, example: KX_CONSTRAINTACT_DIRPZ and KX_ACT_CONSTRAINT_FHPX: the right convention is KX_CONSTRAINTACT_xxx After talking with dalai and cambpell we agreed that this kind of change is better suited for NExyon GSoC so I marked as TODO Also, found 2 duplicate rows, fixed after askin nexyon * source/gameengine/PyDoc/bge.logic.rst there were 2 blocks for constraints, I've put them together in docs and fixed some other lines * source/gameengine/PyDoc/bge.types.rst first cleanup: mainly started using ":type:", it was mixed usage of *type* and **type** started cleaning some bullet list in a way that varibles link to the constant in appropriate page I'll continue later
This commit is contained in:
@@ -511,7 +511,7 @@ def rna2sphinx(BASEPATH):
|
||||
if prop.description:
|
||||
fw(" %s\n\n" % prop.description)
|
||||
type_descr = prop.get_type_description(class_fmt=":class:`%s`")
|
||||
fw(" *type* %s\n\n" % type_descr)
|
||||
fw(" :type: %s\n\n" % type_descr)
|
||||
|
||||
# python attributes
|
||||
py_properties = struct.get_py_properties()
|
||||
|
||||
@@ -1310,6 +1310,7 @@ PyObject* initGameLogic(KX_KetsjiEngine *engine, KX_Scene* scene) // quick hack
|
||||
KX_MACRO_addTypesToDict(d, KX_PROPSENSOR_EXPRESSION, SCA_PropertySensor::KX_PROPSENSOR_EXPRESSION);
|
||||
|
||||
/* 3. Constraint actuator */
|
||||
/* XXX, TODO NXBGE, move constants names from KX_ACT_CONSTRAINT_foo to KX_CONSTRAINTACT_foo */
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_LOCX, KX_ConstraintActuator::KX_ACT_CONSTRAINT_LOCX);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_LOCY, KX_ConstraintActuator::KX_ACT_CONSTRAINT_LOCY);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_LOCZ, KX_ConstraintActuator::KX_ACT_CONSTRAINT_LOCZ);
|
||||
@@ -1318,10 +1319,10 @@ PyObject* initGameLogic(KX_KetsjiEngine *engine, KX_Scene* scene) // quick hack
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_ROTZ, KX_ConstraintActuator::KX_ACT_CONSTRAINT_ROTZ);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRPX, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRPX);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRPY, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRPY);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRPY, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRPY);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRPZ, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRPZ);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRNX, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRNX);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRNY, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRNY);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRNY, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRNY);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_DIRNZ, KX_ConstraintActuator::KX_ACT_CONSTRAINT_DIRNZ);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_ORIX, KX_ConstraintActuator::KX_ACT_CONSTRAINT_ORIX);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_ORIY, KX_ConstraintActuator::KX_ACT_CONSTRAINT_ORIY);
|
||||
KX_MACRO_addTypesToDict(d, KX_CONSTRAINTACT_ORIZ, KX_ConstraintActuator::KX_ACT_CONSTRAINT_ORIZ);
|
||||
|
||||
@@ -305,8 +305,13 @@ Utility functions
|
||||
Constants
|
||||
=========
|
||||
|
||||
.. data:: KX_TRUE: True value used by some modules.
|
||||
.. data:: KX_FALSE: False value used by some modules.
|
||||
.. data:: KX_TRUE
|
||||
|
||||
True value used by some modules.
|
||||
|
||||
.. data:: KX_FALSE
|
||||
|
||||
False value used by some modules.
|
||||
|
||||
---------------
|
||||
Property Sensor
|
||||
@@ -339,19 +344,97 @@ Constraint Actuator
|
||||
See :class:`bge.types.KX_ConstraintActuator`
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_LOCX
|
||||
|
||||
Limit X coord.
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_LOCY
|
||||
|
||||
Limit Y coord
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_LOCZ
|
||||
|
||||
Limit Z coord
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_ROTX
|
||||
|
||||
Limit X rotation
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_ROTY
|
||||
|
||||
Limit Y rotation
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_ROTZ
|
||||
|
||||
Limit Z rotation
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_DIRNX
|
||||
|
||||
Set distance along negative X axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_DIRNY
|
||||
|
||||
Set distance along negative Y axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_DIRNZ
|
||||
|
||||
Set distance along negative Z axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_DIRPX
|
||||
|
||||
Set distance along positive X axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_DIRPY
|
||||
|
||||
Set distance along positive Y axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_DIRPZ
|
||||
|
||||
Set distance along positive Z axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_ORIX
|
||||
|
||||
Set orientation of X axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_ORIY
|
||||
|
||||
Set orientation of Y axis
|
||||
|
||||
.. data:: KX_CONSTRAINTACT_ORIZ
|
||||
|
||||
Set orientation of Z axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_FHNX
|
||||
|
||||
Set force field along negative X axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_FHNY
|
||||
|
||||
Set force field along negative Y axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_FHNZ
|
||||
|
||||
Set force field along negative Z axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_FHPX
|
||||
|
||||
Set force field along positive X axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_FHPY
|
||||
|
||||
Set force field along positive Y axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_FHPZ
|
||||
|
||||
Set force field along positive Z axis
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_DISTANCE
|
||||
.. data:: KX_ACT_CONSTRAINT_DOROTFH
|
||||
.. data:: KX_ACT_CONSTRAINT_LOCAL
|
||||
.. data:: KX_ACT_CONSTRAINT_MATERIAL
|
||||
.. data:: KX_ACT_CONSTRAINT_NORMAL
|
||||
.. data:: KX_ACT_CONSTRAINT_PERMANENT
|
||||
|
||||
|
||||
------------
|
||||
IPO Actuator
|
||||
------------
|
||||
@@ -555,23 +638,6 @@ See :class:`bge.types.KX_StateActuator`
|
||||
.. data:: RAS_2DFILTER_SHARPEN
|
||||
.. data:: RAS_2DFILTER_SOBEL
|
||||
|
||||
-------------------
|
||||
Constraint Actuator
|
||||
-------------------
|
||||
|
||||
.. data:: KX_ACT_CONSTRAINT_DISTANCE
|
||||
.. data:: KX_ACT_CONSTRAINT_DOROTFH
|
||||
.. data:: KX_ACT_CONSTRAINT_FHNX
|
||||
.. data:: KX_ACT_CONSTRAINT_FHNY
|
||||
.. data:: KX_ACT_CONSTRAINT_FHNZ
|
||||
.. data:: KX_ACT_CONSTRAINT_FHPX
|
||||
.. data:: KX_ACT_CONSTRAINT_FHPY
|
||||
.. data:: KX_ACT_CONSTRAINT_FHPZ
|
||||
.. data:: KX_ACT_CONSTRAINT_LOCAL
|
||||
.. data:: KX_ACT_CONSTRAINT_MATERIAL
|
||||
.. data:: KX_ACT_CONSTRAINT_NORMAL
|
||||
.. data:: KX_ACT_CONSTRAINT_PERMANENT
|
||||
|
||||
---------------
|
||||
Parent Actuator
|
||||
---------------
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user