First batch of GE API cleanup.

The principle is to replace most get/set methods of logic bricks by direct property access. 
To make porting of game code easier, the properties have usually the same type and use than
the return values/parameters of the get/set methods. 
More details on http://wiki.blender.org/index.php/GameEngineDev/Python_API_Clean_Up

Old methods are still available but will produce deprecation warnings on the console: 

"<method> is deprecated, use the <property> property instead"

You can avoid these messages by turning on the "Ignore deprecation warnings" option in Game menu.

PyDoc is updated to include the new properties and display a deprecation warning
for the get/set methods that are being deprecated.

1 files changed, 10 insertions, 0 deletions

diff --git a/source/gameengine/PyDoc/SCA_PythonController.py b/source/gameengine/PyDoc/SCA_PythonController.py
index 6d91736d636..06f2b7e9d1d 100644
--- a/source/gameengine/PyDoc/SCA_PythonController.py
+++ b/source/gameengine/PyDoc/SCA_PythonController.py
@@ -6,6 +6,14 @@ class SCA_PythonController(SCA_IController):
 	"""
 	A Python controller uses a Python script to activate it's actuators,
 	based on it's sensors.
+	
+	Properties:
+	
+	@ivar script: the Python script this controller executes
+	@type script: string, read-only
+	@ivar state: the controllers state bitmask.
+	             This can be used with the GameObject's state to test if the controller is active.
+	@type state: integer
 	"""
 
 	def getSensors():
@@ -36,6 +44,7 @@ class SCA_PythonController(SCA_IController):
 		"""
 	def getScript():
 		"""
+		DEPRECATED: use the script property
 		Gets the Python script this controller executes.
 		
 		@rtype: string
@@ -48,6 +57,7 @@ class SCA_PythonController(SCA_IController):
 		"""
 	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()