forked from bartvdbraak/blender
Pydoc: Fix multiple bpy.type modules
This commit is contained in:
parent
7bccd21afa
commit
447622f717
@ -35,4 +35,3 @@ Types
|
||||
:glob:
|
||||
|
||||
bge.types.*
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ActionActuator(SCA_IActuator)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: BL_ActionActuator(SCA_IActuator)
|
||||
@ -75,4 +73,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The name of the property that is set to the current frame number.
|
||||
|
||||
:type: string
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ArmatureActuator(SCA_IActuator)
|
||||
==================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: BL_ArmatureActuator(SCA_IActuator)
|
||||
@ -58,4 +56,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The influence this actuator will set on the constraint it controls.
|
||||
|
||||
:type: float.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ArmatureBone(PyObjectPlus)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: BL_ArmatureBone(PyObjectPlus)
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ArmatureChannel(PyObjectPlus)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: BL_ArmatureChannel(PyObjectPlus)
|
||||
@ -275,4 +273,3 @@ base class --- :class:`PyObjectPlus`
|
||||
.. note::
|
||||
|
||||
You can read the result of the calculation in rotation or euler_rotation attributes after setting this attribute.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ArmatureConstraint(PyObjectPlus)
|
||||
===================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: BL_ArmatureConstraint(PyObjectPlus)
|
||||
@ -126,4 +124,3 @@ base class --- :class:`PyObjectPlus`
|
||||
Additional mode for IK constraint. Currently only used for Distance constraint:
|
||||
|
||||
:type: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ArmatureObject(KX_GameObject)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_GameObject`
|
||||
|
||||
.. class:: BL_ArmatureObject(KX_GameObject)
|
||||
@ -31,4 +29,3 @@ base class --- :class:`KX_GameObject`
|
||||
This action is unecessary if a KX_ArmatureActuator with mode run is active
|
||||
or if an action is playing. Use this function in other cases. It must be called
|
||||
on each frame to ensure that the armature is updated continously.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_Shader(PyObjectPlus)
|
||||
=======================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: BL_Shader(PyObjectPlus)
|
||||
@ -227,4 +225,3 @@ base class --- :class:`PyObjectPlus`
|
||||
.. method:: validate()
|
||||
|
||||
Validate the shader object.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
BL_ShapeActionActuator(SCA_IActuator)
|
||||
=====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: BL_ShapeActionActuator(SCA_IActuator)
|
||||
|
@ -1,8 +1,6 @@
|
||||
CListValue(CPropValue)
|
||||
======================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`CPropValue`
|
||||
|
||||
.. class:: CListValue(CPropValue)
|
||||
@ -69,4 +67,3 @@ base class --- :class:`CPropValue`
|
||||
.. warning::
|
||||
|
||||
The id can't be stored as an integer in game object properties, as those only have a limited range that the id may not be contained in. Instead an id can be stored as a string game property and converted back to an integer for use in from_id lookups.
|
||||
|
||||
|
@ -1,11 +1,8 @@
|
||||
CPropValue(CValue)
|
||||
==================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`CValue`
|
||||
|
||||
.. class:: CPropValue(CValue)
|
||||
|
||||
This class has no python functions
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
CValue(PyObjectPlus)
|
||||
====================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: CValue(PyObjectPlus)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_ArmatureSensor(SCA_ISensor)
|
||||
==============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: KX_ArmatureSensor(SCA_ISensor)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_BlenderMaterial(PyObjectPlus)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_BlenderMaterial(PyObjectPlus)
|
||||
@ -182,4 +180,3 @@ base class --- :class:`PyObjectPlus`
|
||||
|
||||
:return: the material's index
|
||||
:rtype: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_Camera(KX_GameObject)
|
||||
========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_GameObject`
|
||||
|
||||
.. class:: KX_Camera(KX_GameObject)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_CameraActuator(SCA_IActuator)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_CameraActuator(SCA_IActuator)
|
||||
@ -44,4 +42,3 @@ base class --- :class:`SCA_IActuator`
|
||||
the object this actuator tracks.
|
||||
|
||||
:type: :class:`KX_GameObject` or None
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_CharacterWrapper(PyObjectPlus)
|
||||
=================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_CharacterWrapper(PyObjectPlus)
|
||||
@ -42,4 +40,3 @@ base class --- :class:`PyObjectPlus`
|
||||
.. method:: jump()
|
||||
|
||||
The character jumps based on it's jump speed.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_ConstraintActuator(SCA_IActuator)
|
||||
====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_ConstraintActuator(SCA_IActuator)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_ConstraintWrapper(PyObjectPlus)
|
||||
==================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_ConstraintWrapper(PyObjectPlus)
|
||||
@ -140,4 +138,3 @@ base class --- :class:`PyObjectPlus`
|
||||
- :class:`~bge.constraints.CONETWIST_CONSTRAINT`
|
||||
- :class:`~bge.constraints.VEHICLE_CONSTRAINT`
|
||||
- :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT`
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_FontObject(KX_GameObject)
|
||||
============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_GameObject`
|
||||
|
||||
.. class:: KX_FontObject(KX_GameObject)
|
||||
@ -29,4 +27,3 @@ base class --- :class:`KX_GameObject`
|
||||
The text displayed by this Font object.
|
||||
|
||||
:type: string
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_GameActuator(SCA_IActuator)
|
||||
==============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_GameActuator(SCA_IActuator)
|
||||
@ -20,4 +18,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The mode of this actuator. Can be on of :ref:`these constants <game-actuator>`
|
||||
|
||||
:type: Int
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_GameObject(SCA_IObject)
|
||||
==========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IObject`
|
||||
|
||||
.. class:: KX_GameObject(SCA_IObject)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_LibLoadStatus(PyObjectPlus)
|
||||
==============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_LibLoadStatus(PyObjectPlus)
|
||||
@ -48,4 +46,3 @@ base class --- :class:`PyObjectPlus`
|
||||
The amount of time, in seconds, the lib load took (0 until the operation is complete).
|
||||
|
||||
:type: float
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_LightObject(KX_GameObject)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_GameObject`
|
||||
|
||||
.. class:: KX_LightObject(KX_GameObject)
|
||||
@ -161,4 +159,3 @@ base class --- :class:`KX_GameObject`
|
||||
.. note::
|
||||
|
||||
Higher values result in a more focused light source.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_MeshProxy(SCA_IObject)
|
||||
=========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IObject`
|
||||
|
||||
.. class:: KX_MeshProxy(SCA_IObject)
|
||||
@ -131,4 +129,3 @@ base class --- :class:`SCA_IObject`
|
||||
:type uv_index: integer
|
||||
:arg uv_index_from: optional uv index to copy from, -1 to transform the current uv.
|
||||
:type uv_index_from: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_MouseActuator(SCA_IActuator)
|
||||
====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_MouseActuator(SCA_IActuator)
|
||||
@ -100,4 +98,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The current rotational offset caused by the mouse actuator in degrees.
|
||||
|
||||
:type: list (vector of 2 floats)
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_MouseFocusSensor(SCA_MouseSensor)
|
||||
====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_MouseSensor`
|
||||
|
||||
.. class:: KX_MouseFocusSensor(SCA_MouseSensor)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_NavMeshObject(KX_GameObject)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_GameObject`
|
||||
|
||||
.. class:: KX_NavMeshObject(KX_GameObject)
|
||||
@ -44,4 +42,3 @@ base class --- :class:`KX_GameObject`
|
||||
Rebuild the navigation mesh.
|
||||
|
||||
:return: None
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_NearSensor(KX_TouchSensor)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_TouchSensor`
|
||||
|
||||
.. class:: KX_NearSensor(KX_TouchSensor)
|
||||
@ -20,4 +18,3 @@ base class --- :class:`KX_TouchSensor`
|
||||
The near sensor deactivates when the object exceeds this distance.
|
||||
|
||||
:type: float
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_NetworkMessageActuator(SCA_IActuator)
|
||||
========================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_NetworkMessageActuator(SCA_IActuator)
|
||||
@ -32,4 +30,3 @@ base class --- :class:`SCA_IActuator`
|
||||
Send a property instead of a regular body message.
|
||||
|
||||
:type: boolean
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_NetworkMessageSensor(SCA_ISensor)
|
||||
====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: KX_NetworkMessageSensor(SCA_ISensor)
|
||||
@ -34,5 +32,3 @@ base class --- :class:`SCA_ISensor`
|
||||
The list of message bodies received. (read-only).
|
||||
|
||||
:type: list of strings
|
||||
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_ObjectActuator(SCA_IActuator)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_ObjectActuator(SCA_IActuator)
|
||||
@ -126,4 +124,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The object that is used as reference to compute the velocity for the servo controller.
|
||||
|
||||
:type: :class:`KX_GameObject` or None
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_ParentActuator(SCA_IActuator)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_ParentActuator(SCA_IActuator)
|
||||
@ -35,4 +33,3 @@ base class --- :class:`SCA_IActuator`
|
||||
Effective only if the shape is not added to the parent compound shape.
|
||||
|
||||
:type: boolean
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_PolyProxy(SCA_IObject)
|
||||
=========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IObject`
|
||||
|
||||
.. class:: KX_PolyProxy(SCA_IObject)
|
||||
@ -136,4 +134,3 @@ base class --- :class:`SCA_IObject`
|
||||
|
||||
:return: mesh proxy
|
||||
:rtype: :class:`MeshProxy`
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_RadarSensor(KX_NearSensor)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`KX_NearSensor`
|
||||
|
||||
.. class:: KX_RadarSensor(KX_NearSensor)
|
||||
@ -41,4 +39,3 @@ base class --- :class:`KX_NearSensor`
|
||||
|
||||
KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z,
|
||||
KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_RaySensor(SCA_ISensor)
|
||||
=========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: KX_RaySensor(SCA_ISensor)
|
||||
@ -75,4 +73,3 @@ base class --- :class:`SCA_ISensor`
|
||||
* KX_RAY_AXIS_NEG_X
|
||||
* KX_RAY_AXIS_NEG_Y
|
||||
* KX_RAY_AXIS_NEG_Z
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SCA_AddObjectActuator(SCA_IActuator)
|
||||
=======================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SCA_AddObjectActuator(SCA_IActuator)
|
||||
@ -52,4 +50,3 @@ base class --- :class:`SCA_IActuator`
|
||||
adds the object without needing to calling SCA_PythonController.activate()
|
||||
|
||||
.. note:: Use objectLastCreated to get the newly created object.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SCA_DynamicActuator(SCA_IActuator)
|
||||
=====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SCA_DynamicActuator(SCA_IActuator)
|
||||
@ -26,4 +24,3 @@ base class --- :class:`SCA_IActuator`
|
||||
the mass value for the KX_DYN_SET_MASS operation.
|
||||
|
||||
:type: float
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SCA_EndObjectActuator(SCA_IActuator)
|
||||
=======================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SCA_EndObjectActuator(SCA_IActuator)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IActuator`
|
||||
Edit Object Actuator (in End Object mode)
|
||||
|
||||
This actuator has no python methods.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SCA_ReplaceMeshActuator(SCA_IActuator)
|
||||
=========================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SCA_ReplaceMeshActuator(SCA_IActuator)
|
||||
@ -86,4 +84,3 @@ base class --- :class:`SCA_IActuator`
|
||||
.. method:: instantReplaceMesh()
|
||||
|
||||
Immediately replace mesh without delay.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_Scene(PyObjectPlus)
|
||||
======================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_Scene(PyObjectPlus)
|
||||
@ -183,4 +181,3 @@ base class --- :class:`PyObjectPlus`
|
||||
.. method:: drawObstacleSimulation()
|
||||
|
||||
Draw debug visualization of obstacle simulation.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SceneActuator(SCA_IActuator)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SceneActuator(SCA_IActuator)
|
||||
@ -46,4 +44,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The mode of the actuator.
|
||||
|
||||
:type: integer from 0 to 5.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SoundActuator(SCA_IActuator)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SoundActuator(SCA_IActuator)
|
||||
@ -112,4 +110,3 @@ base class --- :class:`SCA_IActuator`
|
||||
Stops the sound.
|
||||
|
||||
:return: None
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_StateActuator(SCA_IActuator)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_StateActuator(SCA_IActuator)
|
||||
@ -26,4 +24,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state.
|
||||
|
||||
:type: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_SteeringActuator(SCA_IActuator)
|
||||
==================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_SteeringActuator(SCA_IActuator)
|
||||
@ -68,4 +66,3 @@ base class --- :class:`SCA_IActuator`
|
||||
Path update period
|
||||
|
||||
:type: int
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_TouchSensor(SCA_ISensor)
|
||||
===========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: KX_TouchSensor(SCA_ISensor)
|
||||
@ -44,4 +42,3 @@ base class --- :class:`SCA_ISensor`
|
||||
The material of the object in the face hit by the ray. (read-only).
|
||||
|
||||
:type: string
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_TrackToActuator(SCA_IActuator)
|
||||
=================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_TrackToActuator(SCA_IActuator)
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_VehicleWrapper(PyObjectPlus)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_VehicleWrapper(PyObjectPlus)
|
||||
@ -163,4 +161,3 @@ base class --- :class:`PyObjectPlus`
|
||||
|
||||
:arg wheelIndex: the wheel index
|
||||
:type wheelIndex: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_VertexProxy(SCA_IObject)
|
||||
===========================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IObject`
|
||||
|
||||
.. class:: KX_VertexProxy(SCA_IObject)
|
||||
@ -206,4 +204,3 @@ base class --- :class:`SCA_IObject`
|
||||
:type: sequence of floats [r, g, b]
|
||||
|
||||
:arg normal: the new normal of this vertex.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_VisibilityActuator(SCA_IActuator)
|
||||
====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: KX_VisibilityActuator(SCA_IActuator)
|
||||
@ -26,4 +24,3 @@ base class --- :class:`SCA_IActuator`
|
||||
whether the visibility/occlusion should be propagated to all children of the object.
|
||||
|
||||
:type: boolean
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
KX_WorldInfo(PyObjectPlus)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: KX_WorldInfo(PyObjectPlus)
|
||||
|
@ -1,8 +1,6 @@
|
||||
PyObjectPlus
|
||||
============
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
.. class:: PyObjectPlus
|
||||
|
||||
PyObjectPlus base class of most other types in the Game Engine.
|
||||
@ -18,4 +16,3 @@ PyObjectPlus
|
||||
The invalid attribute allows testing for this case without exception handling.
|
||||
|
||||
:type: boolean
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_2DFilterActuator(SCA_IActuator)
|
||||
===================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: SCA_2DFilterActuator(SCA_IActuator)
|
||||
@ -46,4 +44,3 @@ base class --- :class:`SCA_IActuator`
|
||||
argument for motion blur filter.
|
||||
|
||||
:type: float (0.0-100.0)
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_ANDController(SCA_IController)
|
||||
==================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_ANDController(SCA_IController)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IController`
|
||||
An AND controller activates only when all linked sensors are activated.
|
||||
|
||||
There are no special python methods for this controller.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_ActuatorSensor(SCA_ISensor)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_ActuatorSensor(SCA_ISensor)
|
||||
@ -16,4 +14,3 @@ base class --- :class:`SCA_ISensor`
|
||||
the name of the actuator that the sensor is monitoring.
|
||||
|
||||
:type: string
|
||||
|
||||
|
@ -1,11 +1,8 @@
|
||||
SCA_AlwaysSensor(SCA_ISensor)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_AlwaysSensor(SCA_ISensor)
|
||||
|
||||
This sensor is always activated.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_DelaySensor(SCA_ISensor)
|
||||
============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_DelaySensor(SCA_ISensor)
|
||||
@ -36,4 +34,3 @@ base class --- :class:`SCA_ISensor`
|
||||
1 if the OFF-ON cycle should be repeated indefinately, 0 if it should run once.
|
||||
|
||||
:type: integer
|
||||
|
||||
|
@ -1,11 +1,8 @@
|
||||
SCA_IActuator(SCA_ILogicBrick)
|
||||
==============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ILogicBrick`
|
||||
|
||||
.. class:: SCA_IActuator(SCA_ILogicBrick)
|
||||
|
||||
Base class for all actuator logic bricks.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_IController(SCA_ILogicBrick)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ILogicBrick`
|
||||
|
||||
.. class:: SCA_IController(SCA_ILogicBrick)
|
||||
@ -52,4 +50,3 @@ base class --- :class:`SCA_ILogicBrick`
|
||||
.. note::
|
||||
|
||||
Order of execution between high priority controllers is not guaranteed.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_ILogicBrick(CValue)
|
||||
=======================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`CValue`
|
||||
|
||||
.. class:: SCA_ILogicBrick(CValue)
|
||||
@ -26,4 +24,3 @@ base class --- :class:`CValue`
|
||||
The name of this logic brick (read-only).
|
||||
|
||||
:type: string
|
||||
|
||||
|
@ -1,11 +1,8 @@
|
||||
SCA_IObject(CValue)
|
||||
===================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`CValue`
|
||||
|
||||
.. class:: SCA_IObject(CValue)
|
||||
|
||||
This class has no python functions
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_ISensor(SCA_ILogicBrick)
|
||||
============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ILogicBrick`
|
||||
|
||||
.. class:: SCA_ISensor(SCA_ILogicBrick)
|
||||
@ -98,4 +96,3 @@ base class --- :class:`SCA_ILogicBrick`
|
||||
Reset sensor internal state, effect depends on the type of sensor and settings.
|
||||
|
||||
The sensor is put in its initial state as if it was just activated.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_JoystickSensor(SCA_ISensor)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_JoystickSensor(SCA_ISensor)
|
||||
@ -130,4 +128,3 @@ base class --- :class:`SCA_ISensor`
|
||||
:type buttonIndex: integer
|
||||
:return: The current pressed state of the specified button.
|
||||
:rtype: boolean
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_KeyboardSensor(SCA_ISensor)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_KeyboardSensor(SCA_ISensor)
|
||||
@ -61,4 +59,3 @@ base class --- :class:`SCA_ISensor`
|
||||
:type keycode: integer
|
||||
:return: The state of the given key, can be one of :ref:`these constants<input-status>`
|
||||
:rtype: int
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_MouseSensor(SCA_ISensor)
|
||||
============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_MouseSensor(SCA_ISensor)
|
||||
@ -36,4 +34,3 @@ base class --- :class:`SCA_ISensor`
|
||||
:type button: int
|
||||
:return: The state of the given key, can be one of :ref:`these constants<input-status>`
|
||||
:rtype: int
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_NANDController(SCA_IController)
|
||||
===================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_NANDController(SCA_IController)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IController`
|
||||
An NAND controller activates when all linked sensors are not active.
|
||||
|
||||
There are no special python methods for this controller.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_NORController(SCA_IController)
|
||||
==================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_NORController(SCA_IController)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IController`
|
||||
An NOR controller activates only when all linked sensors are de-activated.
|
||||
|
||||
There are no special python methods for this controller.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_ORController(SCA_IController)
|
||||
=================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_ORController(SCA_IController)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IController`
|
||||
An OR controller activates when any connected sensor activates.
|
||||
|
||||
There are no special python methods for this controller.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_PropertyActuator(SCA_IActuator)
|
||||
===================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: SCA_PropertyActuator(SCA_IActuator)
|
||||
@ -26,4 +24,3 @@ base class --- :class:`SCA_IActuator`
|
||||
TODO - add constants to game logic dict!.
|
||||
|
||||
:type: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_PropertySensor(SCA_ISensor)
|
||||
===============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_PropertySensor(SCA_ISensor)
|
||||
@ -38,4 +36,3 @@ base class --- :class:`SCA_ISensor`
|
||||
the maximum value of the range used to evaluate the property when in interval mode.
|
||||
|
||||
:type: string
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_PythonController(SCA_IController)
|
||||
=====================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_PythonController(SCA_IController)
|
||||
@ -51,4 +49,3 @@ base class --- :class:`SCA_IController`
|
||||
|
||||
:arg actuator: The actuator to operate on.
|
||||
:type actuator: actuator or the actuator name as a string
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_PythonJoystick(PyObjectPlus)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: SCA_PythonJoystick(PyObjectPlus)
|
||||
@ -74,4 +72,3 @@ base class --- :class:`PyObjectPlus`
|
||||
The number of hats for the joystick at this index. (read-only).
|
||||
|
||||
:type: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_PythonKeyboard(PyObjectPlus)
|
||||
================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: SCA_PythonKeyboard(PyObjectPlus)
|
||||
@ -34,4 +32,3 @@ base class --- :class:`PyObjectPlus`
|
||||
|
||||
:arg text: New clipboard text
|
||||
:type text: string
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_PythonMouse(PyObjectPlus)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`PyObjectPlus`
|
||||
|
||||
.. class:: SCA_PythonMouse(PyObjectPlus)
|
||||
@ -32,4 +30,3 @@ base class --- :class:`PyObjectPlus`
|
||||
The visibility of the mouse cursor.
|
||||
|
||||
:type: boolean
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_RandomActuator(SCA_IActuator)
|
||||
=================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IActuator`
|
||||
|
||||
.. class:: SCA_RandomActuator(SCA_IActuator)
|
||||
@ -124,4 +122,3 @@ base class --- :class:`SCA_IActuator`
|
||||
The half-life 'time' is characterized by half_life.
|
||||
|
||||
:type half_life: float
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_RandomSensor(SCA_ISensor)
|
||||
=============================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_ISensor`
|
||||
|
||||
.. class:: SCA_RandomSensor(SCA_ISensor)
|
||||
@ -20,4 +18,3 @@ base class --- :class:`SCA_ISensor`
|
||||
The seed of the random number generator.
|
||||
|
||||
:type: integer
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_XNORController(SCA_IController)
|
||||
===================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_XNORController(SCA_IController)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IController`
|
||||
An XNOR controller activates when all linked sensors are the same (activated or inative).
|
||||
|
||||
There are no special python methods for this controller.
|
||||
|
||||
|
@ -1,8 +1,6 @@
|
||||
SCA_XORController(SCA_IController)
|
||||
==================================
|
||||
|
||||
.. module:: bge.types
|
||||
|
||||
base class --- :class:`SCA_IController`
|
||||
|
||||
.. class:: SCA_XORController(SCA_IController)
|
||||
@ -10,4 +8,3 @@ base class --- :class:`SCA_IController`
|
||||
An XOR controller activates when there is the input is mixed, but not when all are on or off.
|
||||
|
||||
There are no special python methods for this controller.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user