Parameter.IsLocked

Introduced

v4.0

Description

Returns whether a parameter is locked or not. If there is only one lock level that is set on the object it will be consider locked. If the parameter is not locked false is returned.

C# Syntax

Boolean Parameter.IsLocked();

Scripting Syntax

oBoolean = Parameter.IsLocked();

Return Value

Boolean

Examples

JScript Example

/*
	This example demonstrates how to test a parameter to see whether it is locked
*/
NewScene(null, false);
var oObj = Application.ActiveSceneRoot.AddGeometry("Cone", "MeshSurface");
var oParam = oObj.subdivu;
LogMessage("Lock state: " + oParam.IsLocked());
oParam.SetLock(siLockLevelManipulation);
LogMessage("Lock state: " + oParam.IsLocked());
oParam.UnSetLock(siLockLevelManipulation);
// Expected results:
//INFO : Lock state: false
//INFO : Lock state: true