VS:GetObjectWallPerpOff

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

Description

Gets the perpendicular offset of an object in a wall.

FUNCTION GetObjectWallPerpOff(
                objectHandle              :HANDLE;
                wallHandle                :HANDLE;
                VAR perpendicularOffset   :REAL) : BOOLEAN;

def vs.GetObjectWallPerpOff(objectHandle, wallHandle):
    return (BOOLEAN, perpendicularOffset)

Parameters

objectHandle		HANDLE		The object in the wall.
wallHandle		HANDLE		The wall.
perpendicularOffset		REAL		Returns the perpendicular offset.

Return Value

Whether the call succeeded.

Version

Availability: from Vectorworks 2023