Difference between revisions of "Set"

From PyMOLWiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
===DESCRIPTION===
 
===DESCRIPTION===
  "set" changes one of the PyMOL state variables,
+
'''set''' changes one of the PyMOL state variables,
+
 
 
===USAGE===
 
===USAGE===
  set name, [,value [,object-or-selection [,state ]]]
+
set name, [,value [,object-or-selection [,state ]]]
 
  set name = value  # (DEPRECATED)
 
 
   
 
   
 +
set name = value  # (DEPRECATED)
 +
 
===PYMOL API===
 
===PYMOL API===
 
<source lang="python">
 
<source lang="python">
  cmd.set ( string name, string value=1,
+
cmd.set ( string name, string value=1,
            string selection='', int state=0,
+
          string selection='', int state=0,
              int updates=1, quiet=1)
+
          int updates=1, quiet=1)
 
</source>
 
</source>
 +
 
===NOTES===
 
===NOTES===
  The default behavior (with a blank selection) changes the global
+
The default behavior (with a blank selection) changes the global settings database.  If the selection is 'all', then the settings database in all individual objects will be changed.  Likewise, for a given object, if state is zero, then the object database will be modified.  Otherwise, the settings database for the indicated state within the object will be modified.
  settings database.  If the selection is 'all', then the settings
 
  database in all individual objects will be changed.  Likewise, for
 
  a given object, if state is zero, then the object database will be
 
  modified.  Otherwise, the settings database for the indicated state
 
  within the object will be modified.
 
 
  If a selection is provided, then all objects in the selection will
 
  be affected.  
 
 
   
 
   
 +
If a selection is provided, then all objects in the selection will be affected.
 +
 
[[Category:Commands|set]]
 
[[Category:Commands|set]]

Revision as of 14:32, 29 January 2006

DESCRIPTION

set changes one of the PyMOL state variables,

USAGE

set name, [,value [,object-or-selection [,state ]]]

set name = value  # (DEPRECATED)

PYMOL API

cmd.set ( string name, string value=1,
          string selection='', int state=0,
          int updates=1, quiet=1)

NOTES

The default behavior (with a blank selection) changes the global settings database. If the selection is 'all', then the settings database in all individual objects will be changed. Likewise, for a given object, if state is zero, then the object database will be modified. Otherwise, the settings database for the indicated state within the object will be modified.

If a selection is provided, then all objects in the selection will be affected.