VS:SetObjectWallHeight: Difference between revisions
Jump to navigation
Jump to search
m (1 revision: vw2015) |
(fix typo) |
||
Line 6: | Line 6: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<desc> | <desc> | ||
Sets an object's height value in it's break record. | Sets an object's height value in it's break record. | ||
The | The object (objH) must be contained in wall (wallH) to succeed.</desc> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
Line 44: | Line 44: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<return> | <return> | ||
True or False upon successfull setting of the flag. | True or False upon successfull setting of the flag. | ||
False can occur for the following conditions: | False can occur for the following conditions: | ||
objH is null | : objH is null | ||
wallH is null | : wallH is null | ||
objH is not contained in wallH.</return> | : objH is not contained in wallH.</return> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
Revision as of 11:22, 21 September 2014
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Sets an object's height value in it's break record.
The object (objH) must be contained in wall (wallH) to succeed.
FUNCTION SetObjectWallHeight(
objH :HANDLE;
wallH :HANDLE;
height :REAL)Coordinate)) : BOOLEAN;
def vs.SetObjectWallHeight(objH, wallH, height): return BOOLEAN
Parameters
objH HANDLE wallH HANDLE height REAL (Coordinate)
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