Apple Shake 4 - Manual (Page 104)

104 Chapter 2 Setting a Script’s Global Parameters
Application Environmental Variables
The default values of many of the global parameters can be customized via .h
preference files. For example, if you consistently set one or more global parameters to a
custom state whenever you create a new script, you can set custom defaults so that
new scripts are created with your preferred settings.
Custom global values you set with .h files are only applied to newly created scripts.
Once a script is saved, these values are saved within that script, and opening that script
recalls the global settings saved within.
Customizing Shake’s Default Settings
Unlike many applications that control user customizable settings with a preferences
window, Shake provides access to a wide variety of functionality using a system of
user-created preference files. For more information on creating and using custom
preference files, see Chapter 14, “
Customizing Shake .”
Script Environmental Variables
The following are variables with states that are not customized via .h files, and are only
saved within Shake scripts.
Custom Variable Loading Order
When you create .h files to customize Shake’s functionality, there is an order of
precedence used to load them.
• The default Shake settings found in the nreal.h and nrui.h files are loaded first.
• Settings in custom .h files load second, according to their own load order.
• Settings in .user files are loaded third.
• Finally, any variables found in a Shake script itself are loaded last, overwriting all
previous settings.
Global Parameter Type Purpose
SetTimeRange(const char *range) char Range of frames displayed in the Time Bar.
SetTime(float /*frameNumber*/) float The frame number of the current position of the
playhead.
SetFieldRendering(const char *mode) char Whether or not field rendering is turned on for
rendered output.
SetFps(const char *fps) char The frame rate of the script.
SetMotionBlur(const char *mb, const
char *st, const char *so) char Whether or not motion blur is turned on.
SetQuality(const char *quality) char The quality of the script, enables antialiasing for
certain functions.
SetProxyScale(const char *proxyScale,
const char *proxyRatio) char The default proxy scale of the script.