diff options
author | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-06-02 16:43:27 +0400 |
---|---|---|
committer | Kester Maddock <Christopher.Maddock.1@uni.massey.ac.nz> | 2004-06-02 16:43:27 +0400 |
commit | 976e3a1824622c11c0bc72110345fcceae75fd73 (patch) | |
tree | 27921d8ff9ae80ed3eb288ae702ff17902a6163d /source/gameengine/PyDoc/SCA_PropertyActuator.py | |
parent | 474ec217aefd4057429d4cbde4c08768e833cfe5 (diff) |
Updates to GamePython Reference.
Added Actuator documentation.
Diffstat (limited to 'source/gameengine/PyDoc/SCA_PropertyActuator.py')
-rw-r--r-- | source/gameengine/PyDoc/SCA_PropertyActuator.py | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/source/gameengine/PyDoc/SCA_PropertyActuator.py b/source/gameengine/PyDoc/SCA_PropertyActuator.py new file mode 100644 index 00000000000..dc1233ddfb7 --- /dev/null +++ b/source/gameengine/PyDoc/SCA_PropertyActuator.py @@ -0,0 +1,38 @@ +# $Id$ +# Documentation for SCA_PropertyActuator +from SCA_IActuator import * + +class SCA_PropertyActuator(SCA_IActuator): + """ + Property Actuator + """ + def setProperty(prop): + """ + Set the property on which to operate. + + If there is no property of this name, the call is ignored. + + @type prop: string + @param prop: The name of the property to set. + """ + def getProperty(): + """ + Returns the name of the property on which to operate. + + @rtype: string + """ + def setValue(value): + """ + Set the value with which the actuator operates. + + If the value is not compatible with the type of the + property, the subsequent action is ignored. + + @type value: string + """ + def getValue(): + """ + Gets the value with which this actuator operates. + + @rtype: string + """ |