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
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2009-05-02 06:40:11 +0400
committerCampbell Barton <ideasman42@gmail.com>2009-05-02 06:40:11 +0400
commitef20036b847396940de475c16e364661690c63a7 (patch)
tree8650001e2d1d8e5513b281999ed370e6c943362a /source/gameengine/PyDoc
parent07abb9dee2aba5ed161c22f3ec45031f9fdb183a (diff)
BGE Py API patch from Mitchell Stokes, adds extra attributes and docs
Diffstat (limited to 'source/gameengine/PyDoc')
-rw-r--r--source/gameengine/PyDoc/GameLogic.py18
-rw-r--r--source/gameengine/PyDoc/KX_GameActuator.py2
-rw-r--r--source/gameengine/PyDoc/KX_ParentActuator.py2
-rw-r--r--source/gameengine/PyDoc/KX_SceneActuator.py2
-rw-r--r--source/gameengine/PyDoc/SCA_ILogicBrick.py2
5 files changed, 26 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py
index 85e94e63416..708dc29f137 100644
--- a/source/gameengine/PyDoc/GameLogic.py
+++ b/source/gameengine/PyDoc/GameLogic.py
@@ -187,6 +187,24 @@ Documentation for the GameLogic Module.
@var KX_DYN_DISABLE_RIGID_BODY: See L{KX_SCA_DynamicActuator}
@var KX_DYN_SET_MASS: See L{KX_SCA_DynamicActuator}
+@group Game Actuator: KX_GAME_LOAD, KX_GAME_START, KX_GAME_RESTART, KX_GAME_QUIT, KX_GAME_SAVECFG, KX_GAME_LOADCFG
+@var KX_Game_LOAD: See L{KX_GameActuator}
+@var KX_Game_START: See L{KX_GameActuator}
+@var KX_Game_RESTART: See L{KX_GameActuator}
+@var KX_Game_QUIT: See L{KX_GameActuator}
+@var KX_Game_SAVECFG: See L{KX_GameActuator}
+@var KX_Game_LOADCFG: See L{KX_GameActuator}
+
+@group Scene Actuator: KX_SCENE_RESTART, KX_SCENE_SET_SCENE, KX_SCENE_SET_CAMERA, KX_SCENE_ADD_FRONT_SCENE, KX_SCENE_ADD_BACK_SCENE, KX_SCENE_REMOVE_SCENE, KX_SCENE_SUSPEND, KX_SCENE_RESUME
+KX_SCENE_RESTART: See L{KX_SceneActuator}
+KX_SCENE_SET_SCENE: See L{KX_SceneActuator}
+KX_SCENE_SET_CAMERA: See L{KX_SceneActuator}
+KX_SCENE_ADD_FRONT_SCENE: See L{KX_SceneActuator}
+KX_SCENE_ADD_BACK_SCENE: See L{KX_SceneActuator}
+KX_SCENE_REMOVE_SCENE: See L{KX_SceneActuator}
+KX_SCENE_SUSPEND: See L{KX_SceneActuator}
+KX_SCENE_RESUME: See L{KX_SceneActuator}
+
@group Input Status: KX_INPUT_NONE, KX_INPUT_JUST_ACTIVATED, KX_INPUT_ACTIVE, KX_INPUT_JUST_RELEASED
@var KX_INPUT_NONE: See L{SCA_MouseSensor}
@var KX_INPUT_JUST_ACTIVATED: See L{SCA_MouseSensor}
diff --git a/source/gameengine/PyDoc/KX_GameActuator.py b/source/gameengine/PyDoc/KX_GameActuator.py
index fc5bd6005fc..0b329419ad7 100644
--- a/source/gameengine/PyDoc/KX_GameActuator.py
+++ b/source/gameengine/PyDoc/KX_GameActuator.py
@@ -10,6 +10,8 @@ class KX_GameActuator(SCA_IActuator):
@ivar file: the new .blend file to load
@type file: string.
+ @ivar mode: The mode of this actuator
+ @type mode: int from 0 to 5 L{GameLogic.Game Actuator}
"""
def getFile():
"""
diff --git a/source/gameengine/PyDoc/KX_ParentActuator.py b/source/gameengine/PyDoc/KX_ParentActuator.py
index 2f5d9515d0b..1e2bfe60a4f 100644
--- a/source/gameengine/PyDoc/KX_ParentActuator.py
+++ b/source/gameengine/PyDoc/KX_ParentActuator.py
@@ -7,6 +7,8 @@ class KX_ParentActuator(SCA_IActuator):
The parent actuator can set or remove an objects parent object.
@ivar object: the object this actuator sets the parent too.
@type object: KX_GameObject or None
+ @ivar mode: The mode of this actuator
+ @type mode: int from 0 to 1 L{GameLogic.Parent Actuator}
"""
def setObject(object):
"""
diff --git a/source/gameengine/PyDoc/KX_SceneActuator.py b/source/gameengine/PyDoc/KX_SceneActuator.py
index 6e27257533e..2429cd6fb80 100644
--- a/source/gameengine/PyDoc/KX_SceneActuator.py
+++ b/source/gameengine/PyDoc/KX_SceneActuator.py
@@ -18,6 +18,8 @@ class KX_SceneActuator(SCA_IActuator):
@ivar camera: the camera to change to.
When setting the attribute, you can use either a L{KX_Camera} or the name of the camera.
@type camera: L{KX_Camera} on read, string or L{KX_Camera} on write
+ @type mode: The mode of the actuator
+ @type mode: int from 0 to 5 L{GameLogic.Scene Actuator}
"""
def setUseRestart(flag):
"""
diff --git a/source/gameengine/PyDoc/SCA_ILogicBrick.py b/source/gameengine/PyDoc/SCA_ILogicBrick.py
index 2bfe407204a..a96e77c3249 100644
--- a/source/gameengine/PyDoc/SCA_ILogicBrick.py
+++ b/source/gameengine/PyDoc/SCA_ILogicBrick.py
@@ -11,6 +11,8 @@ class SCA_ILogicBrick(CValue):
@type executePriority: int
@ivar owner: The game object this logic brick is attached to (read only).
@type owner: L{KX_GameObject<KX_GameObject.KX_GameObject>} or None in exceptional cases.
+ @ivar name: The name of this logic brick (read only).
+ @type name: string
@group Deprecated: getOwner, setExecutePriority, getExecutePriority
"""