blender/source/gameengine/PyDoc/SCA_PropertyActuator.py

# $Id$
# Documentation for SCA_PropertyActuator
from SCA_IActuator import *

class SCA_PropertyActuator(SCA_IActuator):
	"""
	Property Actuator

	Properties:
	
	@ivar property: the property on which to operate.
	@type property: string
	@ivar value: the value with which the actuator operates.
	@type value: string
	"""
	def setProperty(prop):
		"""
		DEPRECATED: use the 'property' property
		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():
		"""
		DEPRECATED: use the 'property' property
		Returns the name of the property on which to operate.
		
		@rtype: string
		"""
	def setValue(value):
		"""
		DEPRECATED: use the 'value' property
		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():
		"""
		DEPRECATED: use the 'value' property
		Gets the value with which this actuator operates.
		
		@rtype: string
		"""