archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

doc corrections and add bge.types.KX_ArmatureSensor

Browse Source
This commit is contained in:
Campbell Barton
2012-11-21 08:53:04 +00:00
parent e6f9ef8f7d
commit 3370e3ca43
6 changed files with 22 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/python_api/rst/bge.logic.rst
View File

@@ -254,13 +254,6 @@ General functions
:rtype: list [float], len(getSpectrum()) == 512
.. function:: stopDSP()
Stops the sound driver using DSP effects.
Only the fmod sound driver supports this.
DSP can be computationally expensive.
.. function:: getMaxLogicFrame()
Gets the maximum number of logic frames per render frame.
@@ -493,31 +486,31 @@ See :class:`bge.types.KX_ConstraintActuator.option`
* Applicable to Distance constraint:
.. data:: KX_ACT_CONSTRAINT_NORMAL
.. data:: KX_CONSTRAINT_NORMAL
Activate alignment to surface
.. data:: KX_ACT_CONSTRAINT_DISTANCE
.. data:: KX_CONSTRAINT_DISTANCE
Activate distance control
.. data:: KX_ACT_CONSTRAINT_LOCAL
.. data:: KX_CONSTRAINT_LOCAL
Direction of the ray is along the local axis
* Applicable to Force field constraint:
.. data:: KX_ACT_CONSTRAINT_DOROTFH
.. data:: KX_CONSTRAINT_DOROTFH
Force field act on rotation as well
* Applicable to both:
.. data:: KX_ACT_CONSTRAINT_MATERIAL
.. data:: KX_CONSTRAINT_MATERIAL
Detect material rather than property
.. data:: KX_ACT_CONSTRAINT_PERMANENT
.. data:: KX_CONSTRAINTACT_PERMANENT
No deactivation if ray does not hit target
@@ -585,27 +578,27 @@ See :class:`bge.types.KX_ConstraintActuator.limit`
Set orientation of Z axis
.. data:: KX_ACT_CONSTRAINT_FHNX
.. data:: KX_CONSTRAINTACT_FHNX
Set force field along negative X axis
.. data:: KX_ACT_CONSTRAINT_FHNY
.. data:: KX_CONSTRAINTACT_FHNY
Set force field along negative Y axis
.. data:: KX_ACT_CONSTRAINT_FHNZ
.. data:: KX_CONSTRAINTACT_FHNZ
Set force field along negative Z axis
.. data:: KX_ACT_CONSTRAINT_FHPX
.. data:: KX_CONSTRAINTACT_FHPX
Set force field along positive X axis
.. data:: KX_ACT_CONSTRAINT_FHPY
.. data:: KX_CONSTRAINTACT_FHPY
Set force field along positive Y axis
.. data:: KX_ACT_CONSTRAINT_FHPZ
.. data:: KX_CONSTRAINTACT_FHPZ
Set force field along positive Z axis

98
doc/python_api/rst/bge.types.rst
View File

@@ -762,12 +762,6 @@ Types
:type: float
.. attribute:: useXY
axis this actuator is tracking, True=X, False=Y.
:type: boolean
.. attribute:: object
the object this actuator tracks.
@@ -1810,10 +1804,6 @@ Types
:type: list [r, g, b]
.. attribute:: colour
Synonym for color.
.. attribute:: lin_attenuation
The linear component of this light's attenuation. (SPOT and NORMAL lights only).
@@ -1898,11 +1888,6 @@ Types
:type: integer
.. method:: getNumMaterials()
:return: number of materials associated with this object
:rtype: integer
.. method:: getMaterialName(matid)
Gets the name of the specified material.
@@ -1943,11 +1928,6 @@ Types
:return: a vertex object.
:rtype: :class:`KX_VertexProxy`
.. method:: getNumPolygons()
:return: The number of polygon in the mesh.
:rtype: integer
.. method:: getPolygon(index)
Gets the specified polygon from the mesh.
@@ -2382,7 +2362,7 @@ Types
The polygon attributes are read-only, you need to retrieve the vertex proxy if you want
to change the vertex settings.
.. attribute:: matname
.. attribute:: material_name
The name of polygon material, empty if no material.
@@ -2394,13 +2374,13 @@ Types
:type: :class:`KX_PolygonMaterial` or :class:`KX_BlenderMaterial`
.. attribute:: texture
.. attribute:: texture_name
The texture name of the polygon.
:type: string
.. attribute:: matid
.. attribute:: material_id
The material index of the polygon, use this to retrieve vertex proxy from mesh proxy.
@@ -2631,18 +2611,6 @@ Types
:type: boolean
.. attribute:: lightlayer
Light layers this material affects.
:type: bitfield.
.. attribute:: triangle
Mesh data with this material is triangles. It's probably not safe to change this.
:type: boolean
.. attribute:: diffuse
The diffuse color of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0].
@@ -3228,13 +3196,7 @@ Types
Sound Actuator.
The :data:`startSound`, :data:`pauseSound` and :data:`stopSound` do not requirethe actuator to be activated - they act instantly provided that the actuator has been activated once at least.
.. attribute:: fileName
The filename of the sound this actuator plays.
:type: string
The :data:`startSound`, :data:`pauseSound` and :data:`stopSound` do not require the actuator to be activated - they act instantly provided that the actuator has been activated once at least.
.. attribute:: volume
@@ -3248,36 +3210,6 @@ Types
:type: float
.. attribute:: rollOffFactor
The roll off factor. Rolloff defines the rate of attenuation as the sound gets further away.
:type: float
.. attribute:: looping
The loop mode of the actuator.
:type: integer
.. attribute:: position
The position of the sound as a list: [x, y, z].
:type: float array
.. attribute:: velocity
The velocity of the emitter as a list: [x, y, z]. The relative velocity to the observer determines the pitch. List of 3 floats: [x, y, z].
:type: float array
.. attribute:: orientation
The orientation of the sound. When setting the orientation you can also use quaternion [float, float, float, float] or euler angles [float, float, float].
:type: 3x3 matrix [[float]]
.. attribute:: mode
The operation mode of the actuator. Can be one of :ref:`these constants<logic-sound-actuator>`
@@ -3546,10 +3478,6 @@ Types
Black = [0.0, 0.0, 0.0, 1.0], White = [1.0, 1.0, 1.0, 1.0]
.. attribute:: colour
Synonym for color.
.. attribute:: x
The x coordinate of the vertex.
@@ -4270,24 +4198,6 @@ Types
:type: integer
.. method:: setSeed(seed)
Sets the seed of the random number generator.
If the seed is 0, the generator will produce the same value on every call.
:type seed: integer
.. method:: getSeed()
:return: The initial seed of the generator. Equal seeds produce equal random series.
:rtype: integer
.. method:: getLastDraw()
:return: The last random number generated.
:rtype: integer
.. class:: SCA_XNORController(SCA_IController)
An XNOR controller activates when all linked sensors are the same (activated or inative).

2
doc/python_api/rst/bgl.rst
View File

@@ -1510,7 +1510,7 @@ OpenGL}" and the online NeHe tutorials are two of the best resources.
:arg mode: Specifies a symbolic value representing a shading technique.
.. function:: glStencilFuc(func, ref, mask):
.. function:: glStencilFunc(func, ref, mask):
Set function and reference value for stencil testing