[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [20185] trunk/blender/source/gameengine/ PyDoc/GameTypes.py: use epy deprecated field and link to attributes
Campbell Barton
ideasman42 at gmail.com
Wed May 13 14:26:55 CEST 2009
Revision: 20185
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=20185
Author: campbellbarton
Date: 2009-05-13 14:26:54 +0200 (Wed, 13 May 2009)
Log Message:
-----------
use epy deprecated field and link to attributes
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/GameTypes.py
Modified: trunk/blender/source/gameengine/PyDoc/GameTypes.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameTypes.py 2009-05-13 10:15:19 UTC (rev 20184)
+++ trunk/blender/source/gameengine/PyDoc/GameTypes.py 2009-05-13 12:26:54 UTC (rev 20185)
@@ -67,16 +67,15 @@
@group Deprecated: getOwner, setExecutePriority, getExecutePriority
"""
+ #--The following methods are deprecated--
def getOwner():
"""
Gets the game object associated with this logic brick.
- Deprecated: Use the "owner" property instead.
-
+ @deprecated: Use the L{owner} property instead.
@rtype: L{KX_GameObject}
"""
-
- #--The following methods are deprecated--
+
def setExecutePriority(priority):
"""
Sets the priority of this logic brick.
@@ -84,8 +83,7 @@
This determines the order controllers are evaluated, and actuators are activated.
Bricks with lower priority will be executed first.
- Deprecated: Use the "executePriority" property instead.
-
+ @deprecated: Use the L{executePriority} property instead.
@type priority: integer
@param priority: the priority of this logic brick.
"""
@@ -93,8 +91,7 @@
"""
Gets the execution priority of this logic brick.
- Deprecated: Use the "executePriority" property instead.
-
+ @deprecated: Use the L{executePriority} property instead.
@rtype: integer
@return: this logic bricks current priority.
"""
@@ -236,40 +233,35 @@
def getState():
"""
- DEPRECATED: use the state property
Get the controllers state bitmask, this can be used with the GameObject's state to test if the the controller is active.
This for instance will always be true however you could compare with a previous state to see when the state was activated.
GameLogic.getCurrentController().getState() & GameLogic.getCurrentController().getOwner().getState()
-
+ @deprecated: Use the L{state} property
@rtype: int
"""
def getSensors():
"""
- DEPRECATED: use the sensors property
Gets a list of all sensors attached to this controller.
-
+ @deprecated: use the L{sensors} property
@rtype: list [L{SCA_ISensor}]
"""
def getSensor(name):
"""
- DEPRECATED: use the sensors[name] property
Gets the named linked sensor.
-
+ @deprecated: use the L{sensors}[name] property
@type name: string
@rtype: L{SCA_ISensor}
"""
def getActuators():
"""
- DEPRECATED: use the actuators property
Gets a list of all actuators linked to this controller.
-
+ @deprecated: Use the L{actuators} property
@rtype: list [L{SCA_IActuator}]
"""
def getActuator(name):
"""
- DEPRECATED: use the actuators[name] property
Gets the named linked actuator.
-
+ @deprecated: use the L{actuators}[name] property
@type name: string
@rtype: L{SCA_IActuator}
"""
@@ -325,9 +317,8 @@
#--The following methods are deprecated--
def setAction(action, reset = True):
"""
- DEPRECATED: use the 'action' property
Sets the current action.
-
+ @deprecated: use the L{action} property
@param action: The name of the action to set as the current action.
@type action: string
@param reset: Optional parameter indicating whether to reset the
@@ -339,36 +330,33 @@
def setStart(start):
"""
- DEPRECATED: use the 'start' property
Specifies the starting frame of the animation.
-
+ @deprecated: Use the L{start} property
@param start: the starting frame of the animation
@type start: float
"""
def setEnd(end):
"""
- DEPRECATED: use the 'end' property
Specifies the ending frame of the animation.
-
+ @deprecated: use the L{end} property
@param end: the ending frame of the animation
@type end: float
"""
def setBlendin(blendin):
"""
- DEPRECATED: use the 'blendin' property
Specifies the number of frames of animation to generate
when making transitions between actions.
-
+ @deprecated: use the L{blendin} property
@param blendin: the number of frames in transition.
@type blendin: float
"""
def setPriority(priority):
"""
- DEPRECATED: use the 'priority' property
Sets the priority of this actuator.
+ @deprecated: Use use the L{priority} property
@param priority: Specifies the new priority. Actuators will lower
priority numbers will override actuators with higher
numbers.
@@ -376,131 +364,131 @@
"""
def setFrame(frame):
"""
- DEPRECATED: use the 'frame' property
Sets the current frame for the animation.
+ @deprecated: use the L{frame} property
@param frame: Specifies the new current frame for the animation
@type frame: float
"""
def setProperty(prop):
"""
- DEPRECATED: use the 'property' property
Sets the property to be used in FromProp playback mode.
+ @deprecated: use the L{property} property
@param prop: the name of the property to use.
@type prop: string.
"""
def setBlendtime(blendtime):
"""
- DEPRECATED: use the 'blendTime' property
Sets the internal frame timer.
-
+
Allows the script to directly modify the internal timer
used when generating transitions between actions.
+ @deprecated: use the L{blendTime} property
@param blendtime: The new time. This parameter must be in the range from 0.0 to 1.0.
@type blendtime: float
"""
def setType(mode):
"""
- DEPRECATED: use the 'type' property
Sets the operation mode of the actuator
+ @deprecated: use the L{type} property
@param mode: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
@type mode: integer
"""
def setContinue(cont):
"""
- DEPRECATED: use the 'continue' property
Set the actions continue option True or False. see getContinue.
+ @deprecated: use the L{continue} property
@param cont: The continue option.
@type cont: bool
"""
def getType():
"""
- DEPRECATED: use the 'type' property
Returns the operation mode of the actuator
-
+
+ @deprecated: use the L{type} property
@rtype: integer
@return: KX_ACTIONACT_PLAY, KX_ACTIONACT_PROPERTY, KX_ACTIONACT_FLIPPER, KX_ACTIONACT_LOOPSTOP, KX_ACTIONACT_LOOPEND
"""
def getContinue():
"""
- DEPRECATED: use the 'continue' property
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.
-
+
+ @deprecated: use the L{useContinue} property
@rtype: bool
"""
def getAction():
"""
- DEPRECATED: use the 'action' property
getAction() returns the name of the action associated with this actuator.
+ @deprecated: use the L{action} property
@rtype: string
"""
def getStart():
"""
- DEPRECATED: use the 'start' property
Returns the starting frame of the action.
+ @deprecated: use the L{start} property
@rtype: float
"""
def getEnd():
"""
- DEPRECATED: use the 'end' property
Returns the last frame of the action.
+ @deprecated: use the L{end} property
@rtype: float
"""
def getBlendin():
"""
- DEPRECATED: use the 'blendin' property
Returns the number of interpolation animation frames to be generated when this actuator is triggered.
+ @deprecated: use the L{blendin} property
@rtype: float
"""
def getPriority():
"""
- DEPRECATED: use the 'priority' property
Returns the priority for this actuator. Actuators with lower Priority numbers will
override actuators with higher numbers.
+ @deprecated: use the L{priority} property
@rtype: integer
"""
def getFrame():
"""
- DEPRECATED: use the 'frame' property
Returns the current frame number.
+ @deprecated: use the L{frame} property
@rtype: float
"""
def getProperty():
"""
- DEPRECATED: use the 'property' property
Returns the name of the property to be used in FromProp mode.
+ @deprecated: use the L{property} property
@rtype: string
"""
def setFrameProperty(prop):
"""
- DEPRECATED: use the 'frameProperty' property
+ @deprecated: use the L{frameProperty} property
@param prop: A string specifying the property of the object that will be updated with the action frame number.
@type prop: string
"""
def getFrameProperty():
"""
- DEPRECATED: use the 'frameProperty' property
Returns the name of the property that is set to the current frame number.
+ @deprecated: use the L{frameProperty} property
@rtype: string
"""
@@ -783,9 +771,9 @@
"""
def setAction(action, reset = True):
"""
- DEPRECATED: use the 'action' property
Sets the current action.
+ @deprecated: use the L{action} property
@param action: The name of the action to set as the current action.
@type action: string
@param reset: Optional parameter indicating whether to reset the
@@ -797,36 +785,36 @@
def setStart(start):
"""
- DEPRECATED: use the 'start' property
Specifies the starting frame of the animation.
+ @deprecated: use the L{start} property
@param start: the starting frame of the animation
@type start: float
"""
def setEnd(end):
"""
- DEPRECATED: use the 'end' property
Specifies the ending frame of the animation.
+ @deprecated: use the L{end} property
@param end: the ending frame of the animation
@type end: float
"""
def setBlendin(blendin):
"""
- DEPRECATED: use the 'blendin' property
Specifies the number of frames of animation to generate
when making transitions between actions.
+ @deprecated: use the L{blendin} property
@param blendin: the number of frames in transition.
@type blendin: float
"""
def setPriority(priority):
"""
- DEPRECATED: use the 'priority' property
Sets the priority of this actuator.
+ @deprecated: use the L{priority} property
@param priority: Specifies the new priority. Actuators will lower
priority numbers will override actuators with higher
numbers.
@@ -834,114 +822,114 @@
"""
def setFrame(frame):
"""
- DEPRECATED: use the 'frame' property
Sets the current frame for the animation.
+ @deprecated: use the L{frame} property
@param frame: Specifies the new current frame for the animation
@type frame: float
"""
def setProperty(prop):
"""
- DEPRECATED: use the 'property' property
Sets the property to be used in FromProp playback mode.
+ @deprecated: use the L{property} property
@param prop: the name of the property to use.
@type prop: string.
"""
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list