Merge branch 'fridaydemo' of github.com:rcoh/SmootLight into osc

1 files changed, 10 insertions, 0 deletions

diff --git a/behaviors/RestrictLocation.py b/behaviors/RestrictLocation.py
index f6c26ff..5e12440 100644
--- a/behaviors/RestrictLocation.py
+++ b/behaviors/RestrictLocation.py
@@ -6,6 +6,16 @@ import util.Strings as Strings
 import random
 import pdb
 class RestrictLocation(Behavior):
+    """RestrictLocation is a Behavior which does an action -- A ModifyParam, actually, when a certain
+    location based condition is met.  It takes arguments as follows:
+
+    <Action> -- Operation to perform, using ModifyParam syntax.  Use {val} to reference the variable
+    specified by ParamName.
+    <ParamName> -- the name of the parameter to modify.
+    <LocationRestriction> -- either a tuple of (xmin,ymin,xmax,ymax) or a python-correct conditional.  Use {x} and
+    {y} to reference x and y.  Use &lt; and &gt; to get < and > in XML.  EG:
+    <LocationRestriction>{x}&lt;0 or {x}&gt;800</LocationRestriction>"""
+
     def behaviorInit(self):
         action = self['Action']
         modifyParamArgs = {'ParamType': 'Sensor',