Difference between revisions of "Get"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | + | =DESCRIPTION= | |
| − | + | [[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= | |
| − | + | <source lang="python"> | |
get name [, selection [, state ]] | get name [, selection [, state ]] | ||
| + | </source> | ||
| − | === | + | =Examples= |
| + | <source lang="python"> | ||
| + | get opaque_background | ||
| − | get | + | get line_width |
| + | </source> | ||
| − | + | =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= | |
| − | |||
*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]] | [[Set]] | ||
[[Category:Commands|get]] | [[Category:Commands|get]] | ||
Revision as of 13:12, 20 May 2009
DESCRIPTION
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.