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]] is one of the most utilized commands.  PyMOL representations, states, options, etc. are changed with '''set'''.  Briefly, [[set]] changes one of the PyMOL state variables.  Currently there are over ''600'' [[:Category:Settings|PyMOL settings]]!
  
 
===USAGE===
 
===USAGE===
set name, [,value [,object-or-selection [,state ]]]
+
<source lang="python">
+
# set '''name''' to '''value'''
set name = value  # (DEPRECATED)
+
set name, [,value [,object-or-selection [,state ]]]
 +
 
 +
# alternative way to do the above.
 +
set name = value  # (DEPRECATED)
 +
</source>
  
 
===PYMOL API===
 
===PYMOL API===
 
<source lang="python">
 
<source lang="python">
cmd.set ( string name, string value=1,
+
cmd.set ( string name,  
          string selection='', int state=0,
+
    string value=1,
          int updates=1, quiet=1)
+
    string selection='',
 +
    int state=0,
 +
    int updates=1,
 +
    quiet=1)
 
</source>
 
</source>
  
Line 20: Line 27:
  
 
[[Category:Commands|set]]
 
[[Category:Commands|set]]
 +
[[Category:Settings]]

Revision as of 20:35, 19 September 2008

DESCRIPTION

set is one of the most utilized commands. PyMOL representations, states, options, etc. are changed with set. Briefly, set changes one of the PyMOL state variables. Currently there are over 600 PyMOL settings!

USAGE

# set '''name''' to '''value'''
set name, [,value [,object-or-selection [,state ]]]

# alternative way to do the above.
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.