Welcome to mirror list, hosted at ThFree Co, Russian Federation.

SCA_PropertyActuator.py « PyDoc « gameengine « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 52aefcae651bb7aefaa6b4a482ead74524bae647 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# $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
		"""