VS:GetObjectWallOffset
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Gets an object's offset value in it's break record.
The object (objH) must be contained in wall (wallH) to succeed.
FUNCTION GetObjectWallOffset(
objH :HANDLE;
wallH :HANDLE;
VAR offset :REAL) : BOOLEAN;
def vs.GetObjectWallOffset(objH, wallH): return (BOOLEAN, offset)
Parameters
objH HANDLE wallH HANDLE offset REAL
Return Value
True or False upon successfull setting of the flag.
False can occur for the following conditions:
- objH is null.
- wallH is null.
- objH is not contained in wallH.
Version
Availability: from Vectorworks 2015