[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [54418] trunk/blender/doc/python_api: BGE: Splitting up the bge.types docs so they are not all on the same page.
Mitchell Stokes
mogurijin at gmail.com
Sun Feb 10 07:13:27 CET 2013
Revision: 54418
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=54418
Author: moguri
Date: 2013-02-10 06:13:26 +0000 (Sun, 10 Feb 2013)
Log Message:
-----------
BGE: Splitting up the bge.types docs so they are not all on the same page. This should make them much easier to browse.
Modified Paths:
--------------
trunk/blender/doc/python_api/rst/bge.types.rst
trunk/blender/doc/python_api/sphinx_doc_gen.py
Added Paths:
-----------
trunk/blender/doc/python_api/rst/bge_types/
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ActionActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ArmatureActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ArmatureBone.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ArmatureChannel.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ArmatureConstraint.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ArmatureObject.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_Shader.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.BL_ShapeActionActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.CListValue.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.CPropValue.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.CValue.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_BlenderMaterial.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_Camera.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_CameraActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_CharacterWrapper.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_ConstraintActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_FontObject.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_GameActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_GameObject.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_IpoActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_LibLoadStatus.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_LightObject.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_MeshProxy.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_NavMeshObject.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_NearSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_NetworkMessageActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_NetworkMessageSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_ParentActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_PolyProxy.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_PolygonMaterial.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_RadarSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_RaySensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SCA_AddObjectActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SCA_DynamicActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SCA_EndObjectActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SCA_ReplaceMeshActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_Scene.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SoundActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_SteeringActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_TouchSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_TrackToActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_VehicleWrapper.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_VertexProxy.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.KX_VisibilityActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.PyObjectPlus.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_2DFilterActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_ANDController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_ActuatorSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_AlwaysSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_DelaySensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_IActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_IController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_ILogicBrick.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_IObject.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_ISensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_JoystickSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_KeyboardSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_MouseSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_NANDController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_NORController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_ORController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_PropertyActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_PropertySensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_PythonController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_PythonJoystick.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_PythonKeyboard.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_RandomActuator.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_RandomSensor.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_XNORController.rst
trunk/blender/doc/python_api/rst/bge_types/bge.types.SCA_XORController.rst
Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst 2013-02-10 00:30:03 UTC (rev 54417)
+++ trunk/blender/doc/python_api/rst/bge.types.rst 2013-02-10 06:13:26 UTC (rev 54418)
@@ -31,5387 +31,8 @@
Types
*****
-.. class:: PyObjectPlus
+.. toctree::
+ :glob:
- PyObjectPlus base class of most other types in the Game Engine.
+ bge.types.*
- .. attribute:: invalid
-
- Test if the object has been freed by the game engine and is no longer valid.
-
- Normally this is not a problem but when storing game engine data in the GameLogic module,
- KX_Scenes or other KX_GameObjects its possible to hold a reference to invalid data.
- Calling an attribute or method on an invalid object will raise a SystemError.
-
- The invalid attribute allows testing for this case without exception handling.
-
- :type: boolean
-
-.. class:: CValue(PyObjectPlus)
-
- This class is a basis for other classes.
-
- .. attribute:: name
-
- The name of this CValue derived object (read-only).
-
- :type: string
-
-.. class:: CPropValue(CValue)
-
- This class has no python functions
-
-.. class:: SCA_ILogicBrick(CValue)
-
- Base class for all logic bricks.
-
- .. attribute:: executePriority
-
- This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
-
- :type: executePriority: int
-
- .. attribute:: owner
-
- The game object this logic brick is attached to (read-only).
-
- :type: :class:`KX_GameObject` or None in exceptional cases.
-
- .. attribute:: name
-
- The name of this logic brick (read-only).
-
- :type: string
-
-.. class:: SCA_PythonKeyboard(PyObjectPlus)
-
- The current keyboard.
-
- .. attribute:: events
-
- A dictionary containing the status of each keyboard event or key. (read-only).
-
- :type: dictionary {:ref:`keycode<keyboard-keys>`::ref:`status<input-status>`, ...}
-
- .. attribute:: active_events
-
- A dictionary containing the status of only the active keyboard events or keys. (read-only).
-
- :type: dictionary {:ref:`keycode<keyboard-keys>`::ref:`status<input-status>`, ...}
-
-
- .. function:: getClipboard()
-
- Gets the clipboard text.
-
- :rtype: string
-
- .. function:: setClipboard(text)
-
- Sets the clipboard text.
-
- :arg text: New clipboard text
- :type text: string
-
-.. class:: SCA_PythonMouse(PyObjectPlus)
-
- The current mouse.
-
- .. attribute:: events
-
- a dictionary containing the status of each mouse event. (read-only).
-
- :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...}
-
- .. attribute:: active_events
-
- a dictionary containing the status of only the active mouse events. (read-only).
-
- :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...}
-
- .. attribute:: position
-
- The normalized x and y position of the mouse cursor.
-
- :type: list [x, y]
-
- .. attribute:: visible
-
- The visibility of the mouse cursor.
-
- :type: boolean
-
-.. class:: SCA_PythonJoystick(PyObjectPlus)
-
- A Python interface to a joystick.
-
- .. attribute:: name
-
- The name assigned to the joystick by the operating system. (read-only)
-
- :type: string
-
- .. attribute:: activeButtons
-
- A list of active button values. (read-only)
-
- :type: list
-
- .. attribute:: axisValues
-
- The state of the joysticks axis as a list of values :data:`numAxis` long. (read-only).
-
- :type: list of ints.
-
- Each specifying the value of an axis between -1.0 and 1.0 depending on how far the axis is pushed, 0 for nothing.
- The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls.
-
- * left:[-1.0, 0.0, ...]
- * right:[1.0, 0.0, ...]
- * up:[0.0, -1.0, ...]
- * down:[0.0, 1.0, ...]
-
- .. attribute:: hatValues
-
- The state of the joysticks hats as a list of values :data:`numHats` long. (read-only).
-
- :type: list of ints
-
- Each specifying the direction of the hat from 1 to 12, 0 when inactive.
-
- Hat directions are as follows...
-
- * 0:None
- * 1:Up
- * 2:Right
- * 4:Down
- * 8:Left
- * 3:Up - Right
- * 6:Down - Right
- * 12:Down - Left
- * 9:Up - Left
-
- .. attribute:: numAxis
-
- The number of axes for the joystick at this index. (read-only).
-
- :type: integer
-
- .. attribute:: numButtons
-
- The number of buttons for the joystick at this index. (read-only).
-
- :type: integer
-
- .. attribute:: numHats
-
- The number of hats for the joystick at this index. (read-only).
-
- :type: integer
-
-.. class:: SCA_IObject(CValue)
-
- This class has no python functions
-
-.. class:: SCA_ISensor(SCA_ILogicBrick)
-
- Base class for all sensor logic bricks.
-
- .. attribute:: usePosPulseMode
-
- Flag to turn positive pulse mode on and off.
-
- :type: boolean
-
- .. attribute:: useNegPulseMode
-
- Flag to turn negative pulse mode on and off.
-
- :type: boolean
-
- .. attribute:: frequency
-
- The frequency for pulse mode sensors.
-
- :type: integer
-
- .. attribute:: level
-
- level Option whether to detect level or edge transition when entering a state.
- It makes a difference only in case of logic state transition (state actuator).
- A level detector will immediately generate a pulse, negative or positive
- depending on the sensor condition, as soon as the state is activated.
- A edge detector will wait for a state change before generating a pulse.
- note: mutually exclusive with :data:`tap`, enabling will disable :data:`tap`.
-
- :type: boolean
-
- .. attribute:: tap
-
- When enabled only sensors that are just activated will send a positive event,
- after this they will be detected as negative by the controllers.
- This will make a key thats held act as if its only tapped for an instant.
- note: mutually exclusive with :data:`level`, enabling will disable :data:`level`.
-
- :type: boolean
-
- .. attribute:: invert
-
- Flag to set if this sensor activates on positive or negative events.
-
- :type: boolean
-
- .. attribute:: triggered
-
- True if this sensor brick is in a positive state. (read-only).
-
- :type: boolean
-
- .. attribute:: positive
-
- True if this sensor brick is in a positive state. (read-only).
-
- :type: boolean
-
- .. attribute:: pos_ticks
-
- The number of ticks since the last positive pulse (read-only).
-
- :type: int
-
- .. attribute:: neg_ticks
-
- The number of ticks since the last negative pulse (read-only).
-
- :type: int
-
- .. attribute:: status
-
- The status of the sensor (read-only): can be one of :ref:`these constants<sensor-status>`.
-
- :type: int
-
- .. note::
-
- This convenient attribute combines the values of triggered and positive attributes.
-
- .. method:: reset()
-
- 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.
-
-.. class:: SCA_IController(SCA_ILogicBrick)
-
- Base class for all controller logic bricks.
-
- .. attribute:: state
-
- The controllers state bitmask. This can be used with the GameObject's state to test if the controller is active.
-
- :type: int bitmask
-
- .. attribute:: sensors
-
- A list of sensors linked to this controller.
-
- :type: sequence supporting index/string lookups and iteration.
-
- .. note::
-
- The sensors are not necessarily owned by the same object.
-
- .. note::
-
- When objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
-
- .. attribute:: actuators
-
- A list of actuators linked to this controller.
-
- :type: sequence supporting index/string lookups and iteration.
-
- .. note::
-
- The sensors are not necessarily owned by the same object.
-
- .. note::
-
- When objects are instanced in dupligroups links may be lost from objects outside the dupligroup.
-
- .. attribute:: useHighPriority
-
- When set the controller executes always before all other controllers that dont have this set.
-
- :type: boolen
-
- .. note::
-
- Order of execution between high priority controllers is not guaranteed.
-
-.. class:: SCA_IActuator(SCA_ILogicBrick)
-
- Base class for all actuator logic bricks.
-
-.. class:: BL_ActionActuator(SCA_IActuator)
-
- Action Actuators apply an action to an actor.
-
- .. attribute:: action
-
- The name of the action to set as the current action.
-
- :type: string
-
- .. attribute:: frameStart
-
- Specifies the starting frame of the animation.
-
- :type: float
-
- .. attribute:: frameEnd
-
- Specifies the ending frame of the animation.
-
- :type: float
-
- .. attribute:: blendIn
-
- Specifies the number of frames of animation to generate when making transitions between actions.
-
- :type: float
-
- .. attribute:: priority
-
- Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
-
- :type: integer
-
- .. attribute:: frame
-
- Sets the current frame for the animation.
-
- :type: float
-
- .. attribute:: propName
-
- Sets the property to be used in FromProp playback mode.
-
- :type: string
-
- .. attribute:: blendTime
-
- Sets the internal frame timer. This property must be in the range from 0.0 to blendIn.
-
- :type: float
-
- .. attribute:: mode
-
- The operation mode of the actuator. Can be one of :ref:`these constants<action-actuator>`.
-
- :type: integer
-
- .. attribute:: useContinue
-
- The actions continue option, True or False. When True, the action will always play from where last left off,
- otherwise negative events to this actuator will reset it to its start frame.
-
- :type: boolean
-
- .. attribute:: framePropName
-
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list