VS:GetComponentWallBottomOffset

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

Description

Gets the offset from wall bottom of a component in an object.

FUNCTION GetComponentWallBottomOffset(
                    obj                        :HANDLE;
                    componentIndex             :INTEGER;
                    VAR offsetFromWallBottom   :REAL) : BOOLEAN;

def vs.GetComponentWallBottomOffset(obj, componentIndex):
    return (BOOLEAN, offsetFromWallBottom)

Parameters

obj		HANDLE		The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.
componentIndex		INTEGER		The index of the component.
offsetFromWallBottom		REAL		Returns the offset from wall bottom of the component.

Version

Availability: from Vectorworks 2011

See Also

VS Functions:

VS:SetComponentWallBottomOffset

VS Functions: [[VS:SetComponentWallBottomOffset]]