RemoveKeyOnKeyable

Introduced

v5.0

Description

Removes key frames from the keyable parameters at a given frame.

Note: If any of the keys cannot be removed the command raises an siErrCancelled error; see siErrorValueEnum for details. To avoid an error, wrap the call to RemoveKeyOnKeyable with the 'On Error Resume Next...On Error Goto 0' statements in VBScript or the 'try()...catch(e)' construction in JScript.

This command is very similiar to RemoveKey with the only difference being the input objects and the list of parameters on which the keys are removed.

Scripting Syntax

RemoveKeyOnKeyable( [InputObjs], [Time], [Tolerance], [Layer] );

Parameters

Parameter Type Description
InputObjs String Object name (anything selectable)

Default Value: Currently selected objects

Time Number Key frames are removed at this frame.

Default Value: Current frame

Tolerance Double Frame tolerance

Default Value: Nearest 0.5 frame (-1)

Possible Values:

Description:

> 0 Remove all keys between ( keyframe - tolerance and keyframe + tolerance )
0 Key must be exactly at frame
-1 Nearest 0.5 frame
Layer Integer Animation layer to remove keys from

Default Value: Current animation layer (-1)

See Also

RemoveKeyOnKeyable RemoveKeyOnMarkedKeyable