SetUserPref

Introduced

1.0

Description

Sets a user preference and returns the previous setting. Some of these user preference settings correspond to the available settings in the User Preference dialog box, and some correspond to preferences that can be set from the Main Control Panel. For a list of possible settings, see UserPreference.

Scripting Syntax

SetUserPref( Target, Value )

Parameters

Parameter

Type

Description

Target

UserPreference

User preference to set.

Value

Variant

New value for user preference. These values vary depending on what you specify for the UserPreference parameter.

See UserPreference for lists of possible values available for each UserPreference setting.

Return Value

Returns previous value (last value before update) as a Variant.

Examples

1. VBScript Example

dim prevval

' Current value of AutoInspect
LogMessage GetUserPref( siAutoInspect )

' Save old setting while turning on AutoInspect and display the new value
prevval = SetUserPref( siAutoInspect, False )
LogMessage GetUserPref( siAutoInspect )

' Restore former setting and display its value again
SetUserPref siAutoInspect, prevval
LogMessage GetUserPref( siAutoInspect )

' If your AutoInspect preference was enabled originally, the History Log 
' would display the following:
' 'INFO : "True"
' 'INFO : "False"
' 'INFO : "True"

2. VBScript Example

' Get a sphere and switch into T, Local and X/Z modes
CreatePrim "Sphere", "NurbsSurface"
TranslateTool
SetUserPref "3D_TRANSFO_REFERENTIAL_CHANGED", 2
SetUserPref "3D_TRANSFO_EDITED_AXIS_CHANGED", 5

See Also

GetUserPref

SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index