Get: Difference between revisions

From PyMOLWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
===DESCRIPTION===
 
'''get''' returns the value of a setting.
[[get]] returns the value of a setting.


This command is very useful for determining the any setting(s) when writing a script.  For example, with this command you can find out if the background is opaque, where the light source is, etc.
This command is very useful for determining the any setting(s) when writing a script.  For example, with this command you can find out if the background is opaque, where the light source is, etc.


===USAGE===
=USAGE=  
 
<source lang="python">
get name [, selection [, state ]]
get name [, selection [, state ]]
</source>


===Example===
=Examples=
<source lang="python">
get opaque_background


get opaque_background
get line_width
</source>


===PYMOL API===
=PYMOL API=
<source lang="python">
<source lang="python">
print cmd.get(string name, string object, int state, int quiet)
print cmd.get(string name, string object, int state, int quiet)
</source>
</source>
          
          
===Notes===
=Notes=
 
*The API command will not print out and should be stored or used for comparison
*The API command will not print out and should be stored or used for comparison
*"get" currently only works with global, per-object, and per-state settings.  There is currently no way to retrieve per-atom settings.
*"get" currently only works with global, per-object, and per-state settings.  There is currently no way to retrieve per-atom settings.
=SEE ALSO=
[[Set]]
[[Category:Commands|Get]]

Latest revision as of 13:31, 17 November 2009

get returns the value of a setting.

This command is very useful for determining the any setting(s) when writing a script. For example, with this command you can find out if the background is opaque, where the light source is, etc.

USAGE

get name [, selection [, state ]]

Examples

get opaque_background

get line_width

PYMOL API

print cmd.get(string name, string object, int state, int quiet)

Notes

  • The API command will not print out and should be stored or used for comparison
  • "get" currently only works with global, per-object, and per-state settings. There is currently no way to retrieve per-atom settings.

SEE ALSO

Set