< Previous | | Manuals Home | Boris FX | Next >

SyPrefObj Reference

The SyLevel.Prefs() iterator produces instances of SyPrefObj. These objects offer a similar interface to SyObj, allowing the preference's value to be accessed or changed. The index cited in the constructor is the index into the preferences panel array.

The Prefs() object can also be used to access the preferences using the variable name, ie

hlev.Prefs().autosave

init (hlev, index) Create a preference object from its UI-table index

Type() Returns "PREF"

Index() the UI-table index

Name() the user-visible name of the preference

Variable() the variable name

Description() the tooltip text

Get() Get the preference's current value

Set(val) Change the preference's value. Must be within a BeginPref/AcceptPref block!

< Previous | | Manuals Home | Boris FX | Next >