VS:SetComponentFollowBottomWallPeaks

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Sets the follow bottom wall peaks flag of a component in an object.

FUNCTION SetComponentFollowBottomWallPeaks(
                      obj                     :HANDLE;
                      componentIndex          :INTEGER;
                      followBottomWallPeaks   :BOOLEAN) : BOOLEAN;

def vs.SetComponentFollowBottomWallPeaks(obj, componentIndex, followBottomWallPeaks):
    return BOOLEAN

Parameters

obj		HANDLE		The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex		INTEGER		The index of the component.
followBottomWallPeaks		BOOLEAN		Whether or not the component will follow bottom wall peaks.

Version

Availability: from Vectorworks 2011

See Also

VS Functions:

VS:GetComponentFollowBottomWallPeaks

VS Functions: [[VS:GetComponentFollowBottomWallPeaks]]