| AddCavity | Objects - Walls MiniCAD4.0 - obsolete as of VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE AddCavity
( pair :BOOLEAN; leftOffDistance :REAL (Coordinate); rightOffDistance :REAL (Coordinate); pairFill :LONGINT ) ; Python:
return None
def vs.AddCavity(pair, leftOffDistance, rightOffDistance, pairFill): Special Notes:
AddCavity is obsolete as of VectorWorks12.0
Description:
Procedure AddCavity creates a wall cavity in a new wall object. The newly defined cavity becomes the default for all subsequently defined walls.
To apply a bitmap fill pattern, use positive value corresponding to the index of the bitmap pattern. To apply a vector fill pattern, use the negative of the vector fill index (index * -1).
Fill patterns and their associated constants can be found in the VectorScript Appendix.Parameters:
pair Double line display mode. leftOffDistance Left edge offset from wall centerline. rightOffDistance Right edge offset from wall centerline. pairFill Fill index for filled cavities. Example:
{ Create wall object with 1" wide cavity using black pattern fill.} DoubLines(6"); AddCavity(True, 1", 2", 2); Wall(0, 1, 9, 1); { Create wall object with 1" wide cavity using a custom hatch fill.} DoubLines(6"); AddCavity(True, 1", 2", -Name2Index('My Hatch')); Wall(0, 1, 9, 1);
| AddSymToWall | Objects - Walls MiniCAD6.0 |
VectorScript Declaration:
PROCEDURE AddSymToWall
( wallHd :HANDLE; offDistance :REAL (Coordinate); heightDistance :REAL (Coordinate); flip :BOOLEAN; right :BOOLEAN; symbolName :STRING ) ; Python:
return None
def vs.AddSymToWall(wallHd, offDistance, heightDistance, flip, right, symbolName): Description:
Procedure AddSymToWall inserts a specified symbol into the referenced wall.Parameters:
wallHd Handle to wall. offDistance Offset distance from wall start. heightDistance Elevation of symbol. flip Flipped status of symbol. right Left-right orientation of symbol. symbolName Name of symbol to insert in wall. Example:
AddSymToWall(HandleToWall,3',0',FALSE,FALSE,'Door-1');See Also:
AddSymToWallEdge
| AddSymToWallEdge | Objects - Walls VectorWorks8.0 |
VectorScript Declaration:
PROCEDURE AddSymToWallEdge
( h :HANDLE; alongDistance :REAL (Coordinate); heightDistance :REAL (Coordinate); flip :BOOLEAN; right :BOOLEAN; symbolName :STRING; insertMode :INTEGER ) ; Python:
return None
def vs.AddSymToWallEdge(h, alongDistance, heightDistance, flip, right, symbolName, insertMode): Description:
Procedure AddSymToWallEdge inserts a symbol in the referenced wall using the specified parameters to define placement.
Table - Symbol Insertion Alignment
Alignment Constant Centerline 0 Left Edge 1 Right Edge 2 Parameters:
h Handle to wall. alongDistance Offset distance from wall start of insertion point. heightDistance Elevation of symbol. flip Flip orientation of symbol. right Left-right orientation of symbol. symbolName Name of symbol to be inserted. insertMode Edge insertion mode.
| AddWallBottomPeak | Objects - Walls VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE AddWallBottomPeak
( wallHd :HANDLE; offDistance :REAL (Coordinate); heightDistance :REAL (Coordinate) ) ; Python:
return None
def vs.AddWallBottomPeak(wallHd, offDistance, heightDistance): Description:
Adds a peak to the bottom of the referenced wall.Parameters:
wallHd Handle to wall. offDistance Offset distance of peak from wall start. heightDistance Height of peak. Example:
AddWallBottomPeak(h,24'0",2'6");
| AddWallPeak | Objects - Walls MiniCAD6.0 |
VectorScript Declaration:
PROCEDURE AddWallPeak
( wallHd :HANDLE; offDistance :REAL (Coordinate); heightDistance :REAL (Coordinate) ) ; Python:
return None
def vs.AddWallPeak(wallHd, offDistance, heightDistance): Description:
Procedure AddWallPeak creates a wall peak in the referenced wall object.Parameters:
wallHd Handle to wall. offDistance Offset distance from wall start. heightDistance Elevation of wall peak.
| BreakWall | Objects - Walls MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE BreakWall
( offsetDistance :REAL (Coordinate); breakWidthDistance :REAL (Coordinate); right :BOOLEAN ) ; Python:
return None
def vs.BreakWall(offsetDistance, breakWidthDistance, right): Description:
Procedure BreakWall creates a break in a wall object on the left or the right at a specified offset location.
Parameters:
offsetDistance Offset distance from wall start. breakWidthDistance Width of wall break. right Left-right edge status of break. Example:
MoveTo(2,3); WallTo(7,3); BreakWall(3",1",True); {creates a right hand 1" wall break 3" from the start of the wall}
| ClearCavities | Objects - Walls MiniCAD4.0 - obsolete as of VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE ClearCavities
; Python:
return None
def vs.ClearCavities(): Special Notes:
ClearCavities is obsolete as of VectorWorks12.5
Description:
Procedure ClearCavities resets the default cavity style of wall objects to no cavities.
Example:
DoubLines(6"); AddCavity(True,1",2",2); Wall(0,1,9,1); ClearCavities; Wall(0,2,11,2); {creates a wall with a cavity, then creates a wall without a cavity}
| ClearWallPeaks | Objects - Walls VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE ClearWallPeaks
( h:HANDLE ) ; Python:
return None
def vs.ClearWallPeaks(h): Description:
Removes all wall peaks from the referenced wall.Parameters:
h Handle to wall.
| ConvertToUnstyledWall | Objects - Walls VectorWorks12.0 |
VectorScript Declaration:
FUNCTION ConvertToUnstyledWall
( h:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.ConvertToUnstyledWall(h): Description:
Sets a wall to be unstyled.
| CreateWallFeature | Objects - Walls Vectorworks 2010 |
VectorScript Declaration:
FUNCTION CreateWallFeature
( wall :HANDLE; profile :HANDLE; wallFeatureType :INTEGER ) :HANDLE ; Python:
return HANDLE
def vs.CreateWallFeature(wall, profile, wallFeatureType): Description:
Creates a Wall Feature in the wall from the profile object. The Wall Feature can be a projection from the wall or a recess in the wall.Parameters:
wall The handle to the wall in which to create the Wall Feature. profile The handle to the object to use as the Wall Feature profile. wallFeatureType The Wall Feature type. 0 - Projection 1 - Recess Result:
The handle to the created Wall Feature.
| CreateWallStyle | Objects - Walls VectorWorks12.5 |
VectorScript Declaration:
FUNCTION CreateWallStyle
( wallStyleName:STRING ) :HANDLE ; Python:
return HANDLE
def vs.CreateWallStyle(wallStyleName): Description:
Creates a new Wall Style of the give name. If the name is already in use, the next available name will be used.Parameters:
wallStyleName The name of the new Wall Style. If the name is already in use, the next available name will be used. Result:
Returns a handle to the new Wall Style.Example:
PROCEDURE Example; CONST wallStyleName = 'Example Wall Style'; VAR wallStyleHandle :HANDLE; wdth :REAL; fill :LONGINT; pwLeft, pwRight, psLeft, psRight :INTEGER; boo :BOOLEAN; BEGIN wallStyleHandle := CreateWallStyle(wallStyleName); wdth := 1"; fill := 1; {solid white} pwLeft := 14; {in mils} pwRight := 14; {in mils} psLeft := 2; {solid black} psRight := 2; {solid black} boo := InsertNewComponent(wallStyleHandle, 1, wdth, fill, pwLeft, pwRight, psLeft, psRight); SetName(wallStyleHandle, wallStyleName); {Reset the wall style name.} END; RUN(Example);
| DeleteWallPeak | Objects - Walls Vectorworks 2014 |
VectorScript Declaration:
PROCEDURE DeleteWallPeak
( wallHandle :HANDLE; index :INTEGER ) ; Python:
return None
def vs.DeleteWallPeak(wallHandle, index): Description:
Deletes the wall peak at the given index number
| DeleteWallSym | Objects - Walls MiniCAD6.0 |
VectorScript Declaration:
FUNCTION DeleteWallSym
( symbolHd:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DeleteWallSym(symbolHd): Description:
Function DeleteWallSym deletes the referenced symbol from a wall object.Parameters:
symbolHd Handle to symbol.
| GetCWPanelFromPt | Objects - Walls Vectorworks 2014 |
VectorScript Declaration:
FUNCTION GetCWPanelFromPt
( hWall :HANDLE; VAR testPtX :REAL; VAR testPtY :REAL; includeBottomFrame :BOOLEAN; VAR centerPtX :REAL; VAR centerPtY :REAL; VAR width :REAL; VAR height :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, centerPt, width, height)
def vs.GetCWPanelFromPt(hWall, testPt, includeBottomFrame): Description:
Returns information about a panel in a crutain wall from a given point.
Used for placing objects inside a panel in a curtain wall. When passing the center point of the object in the wall, it will find the panel in the curtain wall and return a new center point and the height and width of the panel.Parameters:
hWall Handle to the curtain wall testPt Point to test on the curtian wall. Typically the center point of the object to be placed in the curtian wall panel. includeBottomFrame Include the bottom frame in the return height. centerPt Returns the center point of the rectangle in witch to place the object. width The width of the rectangle in which to place the object. height The height of the rectangle in which to place the object. Result:
Returns TRUE if hWall is a crutain wall and a panel is found.
Returns FALSE is hWall is not a curtiain wall or the test point is not found on the wall.
| GetLayerDeltaZOffset | Objects - Walls VectorWorks12.5 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetLayerDeltaZOffset
( theWall:HANDLE ) :REAL ; Python:
return REAL
def vs.GetLayerDeltaZOffset(theWall): Special Notes:
GetLayerDeltaZOffset is obsolete as of Vectorworks 2012
Description:
Returns the wall height's offset to the layer delta z.Parameters:
theWall The wall. See Also:
SetLayerDeltaZOffset
| GetLinkHeightToLayerDeltaZ | Objects - Walls VectorWorks12.5 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION GetLinkHeightToLayerDeltaZ
( theWall:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.GetLinkHeightToLayerDeltaZ(theWall): Special Notes:
GetLinkHeightToLayerDeltaZ is obsolete as of Vectorworks 2012
Description:
Returns whether or not the wall's height is linked to the layer delta z.Parameters:
theWall The wall. See Also:
SetLinkHeightToLayerDeltaZ
| GetNumOfWallBreaks | Objects - Walls VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetNumOfWallBreaks
( wallH :HANDLE; VAR numWallBreaks :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, numWallBreaks)
def vs.GetNumOfWallBreaks(wallH): Description:
Gets the number of breaks in a wall.
| GetNumWallPeaks | Objects - Walls VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetNumWallPeaks
( h:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetNumWallPeaks(h): Description:
Returns the number of peaks in the referenced wall.Parameters:
h Handle to wall. Result:
Returns the number of wall peaks.
| GetObjectWallHeight | Objects - Walls Vectorworks 2015 |
VectorScript Declaration:
FUNCTION GetObjectWallHeight
( objH :HANDLE; wallH :HANDLE; VAR height :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, height)
def vs.GetObjectWallHeight(objH, wallH): Description:
Gets an object's height value in it's break record.
The oject (objH) must be contained in wall (wallH) to succeed.Result:
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.
| GetObjectWallOffset | Objects - Walls Vectorworks 2015 |
VectorScript Declaration:
FUNCTION GetObjectWallOffset
( objH :HANDLE; wallH :HANDLE; VAR offset :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, offset)
def vs.GetObjectWallOffset(objH, wallH): Description:
Gets an object's offset value in it's break record.
The oject (objH) must be contained in wall (wallH) to succeed.Result:
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.
| GetObjExtentsInWall | Objects - Walls VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetObjExtentsInWall
( symH :HANDLE; wallH :HANDLE; VAR startPtX :REAL; VAR startPtY :REAL; VAR endPtX :REAL; VAR endPtY :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, startPt, endPt)
def vs.GetObjExtentsInWall(symH, wallH): Description:
Gets the extents of a Plugin object or symbol that is in a wall. Returns the object's start point and end point along the wall line.
| GetWallCapAttributesType | Objects - Walls Vectorworks 2010 |
VectorScript Declaration:
FUNCTION GetWallCapAttributesType
( wall:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetWallCapAttributesType(wall): Description:
Gets the wall cap attributes type of a wall or round wall. The wall cap attributes type determines whether the wall caps have the wall line attributes or the component lines attributes. If they have the component lines attributes, each wall component is capped with its own left line attributes.Parameters:
wall The handle to the wall or round wall. Result:
The wall cap attributes type.
0 - The wall cap attributes are the wall line attributes
1 - The wall cap attributes are the wall component lines attributesSee Also:
SetWallCapAttributesType
| GetWallCaps | Objects - Walls VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE GetWallCaps
( theWall :HANDLE; VAR leftCap :BOOLEAN; VAR rightCap :BOOLEAN; VAR round :BOOLEAN ) ; Python:
return (leftCap, rightCap, round)
def vs.GetWallCaps(theWall): Description:
Gets the wall's caps.Parameters:
theWall The wall. leftCap Returns whether or not the wall has a left cap. rightCap Returns whether or not the wall has a right cap. round Returns whether or not the wall's caps are round. See Also:
SetWallCaps
| GetWallCapsOffsets | Objects - Walls VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE GetWallCapsOffsets
( theWall :HANDLE; VAR leftCapLeftOffset :REAL; VAR leftCapRightOffset :REAL; VAR rightCapLeftOffset :REAL; VAR rightCapRightOffset :REAL ) ; Python:
return (leftCapLeftOffset, leftCapRightOffset, rightCapLeftOffset, rightCapRightOffset)
def vs.GetWallCapsOffsets(theWall): Description:
Get the wall's caps' offsets.Parameters:
theWall The wall. leftCapLeftOffset Returns the left offset of the left wall cap. leftCapRightOffset Returns the right offset of the left wall cap. rightCapLeftOffset Returns the left offset of the right wall cap. rightCapRightOffset Returns the right offset of the right wall cap. See Also:
SetWallCapsOffsets
| GetWallCompEndPts | Objects - Walls Vectorworks 2015 |
VectorScript Declaration:
PROCEDURE GetWallCompEndPts
( wall :HANDLE; componentIndex :INTEGER; VAR leftPointX :REAL; VAR leftPointY :REAL; VAR centerPointX :REAL; VAR centerPointY :REAL; VAR rightPointX :REAL; VAR rightPointY :REAL ) ; Python:
return (leftPoint, centerPoint, rightPoint)
def vs.GetWallCompEndPts(wall, componentIndex): Description:
Gets the end points of a wall component.Parameters:
wall The wall or round wall componentIndex The component index leftPoint Returns the left end point of the component centerPoint Returns the center end point of the component rightPoint Returns the right end point of the component Result:
NoneSee Also:
GetWallCompStartPts
| GetWallCompStartPts | Objects - Walls Vectorworks 2015 |
VectorScript Declaration:
PROCEDURE GetWallCompStartPts
( wall :HANDLE; componentIndex :INTEGER; VAR leftPointX :REAL; VAR leftPointY :REAL; VAR centerPointX :REAL; VAR centerPointY :REAL; VAR rightPointX :REAL; VAR rightPointY :REAL ) ; Python:
return (leftPoint, centerPoint, rightPoint)
def vs.GetWallCompStartPts(wall, componentIndex): Description:
Gets the start points of a wall component.Parameters:
wall The wall or round wall componentIndex The component index leftPoint Returns the left start point of the component centerPoint Returns the center start point of the component rightPoint Returns the right start point of the component Result:
NoneSee Also:
GetWallCompEndPts
| GetWallControlOffset | Objects - Walls VectorWorks8.5 - obsolete as of VectorWorks12.5 |
VectorScript Declaration:
FUNCTION GetWallControlOffset
:REAL ; Python:
return REAL
def vs.GetWallControlOffset(): Special Notes:
GetWallControlOffset is obsolete as of VectorWorks12.5
Description:
Returns the default wall control line offset value.
| GetWallCornerHeights | Objects - Walls Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE GetWallCornerHeights
( theWall :HANDLE; VAR startHeightTop :REAL; VAR startHeightBottom :REAL; VAR endHeightTop :REAL; VAR endHeightBottom :REAL ) ; Python:
return (startHeightTop, startHeightBottom, endHeightTop, endHeightBottom)
def vs.GetWallCornerHeights(theWall): Description:
Gets the corner heights of a wall or round wall.Parameters:
theWall The wall or round wall startHeightTop The height of the start top corner startHeightBottom The height of the start bottom corner endHeightTop The height of the end top corner endHeightBottom The height of the end bottom corner See Also:
SetWallCornerHeights
| GetWallHalfBreakInfo | Objects - Walls VectorWorks 2008 |
VectorScript Declaration:
FUNCTION GetWallHalfBreakInfo
( wallH :HANDLE; breakIndex :INTEGER; VAR startPtX :REAL; VAR startPtY :REAL; VAR centerPtX :REAL; VAR centerPtY :REAL; VAR endPtX :REAL; VAR endPtY :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, startPt, centerPt, endPt)
def vs.GetWallHalfBreakInfo(wallH, breakIndex): Description:
Gets the start point, center point and end point of a half break in a wall along the wall line.
| GetWallOverallHeights | Objects - Walls Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE GetWallOverallHeights
( theWall :HANDLE; VAR overallHeightTop :REAL; VAR overallHeightBottom :REAL ) ; Python:
return (overallHeightTop, overallHeightBottom)
def vs.GetWallOverallHeights(theWall): Description:
Gets the overall heights of a wall or round wall.Parameters:
theWall The wall or round wall overallHeightTop The overall height of the top overallHeightBottom The overall height of the bottom See Also:
SetWallOverallHeights
| GetWallPeak | Objects - Walls VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE GetWallPeak
( h :HANDLE; index :INTEGER; VAR xPeak :REAL; VAR yPeak :REAL; VAR zPeak :REAL ) ; Python:
return (xPeak, yPeak, zPeak)
def vs.GetWallPeak(h, index): Description:
Returns the coordinates of a wall peak in the referenced wall.Parameters:
h Handle to wall. index Index of wall peak. xPeak X-coordinate of wall peak. yPeak Y-coordinate of wall peak. zPeak Z-coordinate of wall peak.
| GetWallStyle | Objects - Walls VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetWallStyle
( theWall:HANDLE ) :STRING ; Python:
return STRING
def vs.GetWallStyle(theWall): Description:
Gets the name of the Wall Style for theWall.Parameters:
theWall The wall. See Also:
SetWallStyle
| GetWallThickness | Objects - Walls VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetWallThickness
( h :HANDLE; VAR thicknessDist :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, thicknessDist)
def vs.GetWallThickness(h): Description:
Gets the thickness of a wall
| GetWallWidth | Objects - Walls MiniCAD6.0 |
VectorScript Declaration:
FUNCTION GetWallWidth
:REAL ; Python:
return REAL
def vs.GetWallWidth(): Description:
Function GetWallWidth returns the default wall width setting of the document.
| HWallHeight | Objects - Walls MiniCAD6.0 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE HWallHeight
( wallHd :HANDLE; startHeightDistance :REAL (Coordinate); endHeightDistance :REAL (Coordinate) ) ; Python:
return None
def vs.HWallHeight(wallHd, startHeightDistance, endHeightDistance): Special Notes:
HWallHeight is obsolete as of Vectorworks 2012
Description:
Procedure HWallHeight sets the wall heights of the referenced wall object.
Parameters:
wallHd Handle to wall. startHeightDistance New start height of wall. endHeightDistance New end height of wall.
| HWallWidth | Objects - Walls MiniCAD6.0 |
VectorScript Declaration:
PROCEDURE HWallWidth
( wallHd :HANDLE; widthDistance :REAL (Coordinate) ) ; Python:
return None
def vs.HWallWidth(wallHd, widthDistance): Description:
Procedure HWallWidth sets the wall width of the referenced wall object.
Parameters:
wallHd Handle to wall. widthDistance New wall width. Example:
PROCEDURE Example; VAR targetWall, sourceWall :HANDLE; cnt1, cnt2, cavs :INTEGER; BEGIN targetWall := FSActLayer; MoveTo(0,0); WallTo(1,0); sourceWall := LNewObj; cavs := GetObjectVariableInt(sourceWall, 199); HWallWidth(targetWall, WallWidth(sourceWall)); SetObjectVariableInt(targetWall, 199, cavs); FOR cnt2 := 0 TO cavs - 1 DO BEGIN SetObjectVariableBoolean(targetWall, 240 + cnt2, GetObjectVariableBoolean(sourceWall, 240 + cnt2)); {cavity is pair} SetObjectVariableReal (targetWall, 200 + cnt2, GetObjectVariableReal (sourceWall, 200 + cnt2)); {left offset} SetObjectVariableReal (targetWall, 220 + cnt2, GetObjectVariableReal (sourceWall, 220 + cnt2)); {right offset} SetObjectVariableLongInt(targetWall, 260 + cnt2, GetObjectVariableLongInt(sourceWall, 260 + cnt2)); {cavity fill} SetObjectVariableInt (targetWall, 280 + cnt2, GetObjectVariableInt (sourceWall, 280 + cnt2)); {pen weight} SetObjectVariableInt (targetWall, 300 + cnt2, GetObjectVariableInt (sourceWall, 300 + cnt2)); {pen style} END; ResetObject(targetWall); DelObject(sourceWall); END; RUN(Example);
| InsertSymbol | Objects - Walls MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE InsertSymbol
( offsetDistance :REAL (Coordinate); heightDistance :REAL (Coordinate); flipped :BOOLEAN; right :BOOLEAN; capped :BOOLEAN; symbolName :STRING ) ; Python:
return None
def vs.InsertSymbol(offsetDistance, heightDistance, flipped, right, capped, symbolName): Description:
Procedure InsertSymbol places a specified symbol into a wall.
Parameters:
offsetDistance Offset distance from wall start. heightDistance Elevation of symbol. flipped Flip orientation of symbol. right Left-right orientation of symbol. capped Cap wall breaks. symbolName Name of symbol to be inserted in wall. Example:
MoveTo(3,1); WallTo(5',5'); InsertSymbol(1',False,False,True,'Door'); {inserts the symbol 'Door' at 1' from the start point of the last wall segment}See Also:
AddSymToWall AddSymToWallEdge
| IsCurtainWall | Objects - Walls Vectorworks 2014 |
VectorScript Declaration:
FUNCTION IsCurtainWall
( hWall:HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsCurtainWall(hWall): Description:
Use to check whether wall is being used as a curtain wall.Parameters:
hWall Handle to a wall object to check for curtain wall status Result:
Will return TRUE if hWall is set to be a curtain wall.
Will retrun FALSE if hWall is not a wall node or the wall is not set to be a curtain wall.
| IsWallPeakTop | Objects - Walls Vectorworks 2014 |
VectorScript Declaration:
FUNCTION IsWallPeakTop
( hWall :HANDLE; peakIndex :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.IsWallPeakTop(hWall, peakIndex): Description:
Returns true if specified peak (by index) of a wall is top.
| JoinWalls | Objects - Walls VectorWorks10.0 |
VectorScript Declaration:
FUNCTION JoinWalls
( firstWall :HANDLE; secondWall :HANDLE; firstWallX :REAL; firstWallY :REAL; secondWallX :REAL; secondWallY :REAL; joinModifier :INTEGER; capped :BOOLEAN; showAlerts :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.JoinWalls(firstWall, secondWall, firstWall, secondWall, joinModifier, capped, showAlerts): Description:
This function provides a VectorScript interface to the Wall Join Tool. The parameters firstWall and secondWall are used to specify the pick points that determine which ends of the walls are to be joined, similar to the points requested by the Wall Join Tool.Parameters:
firstWall The first wall of the join operation. For T joins this is the wall that is extended to meet the second wall. secondWall The second wall of the join operation. firstWall The first and second wall points are used to clarify corner joins. secondWall The first and second wall points are used to clarify corner joins. joinModifier Specifies the type of join: T-join = 1, L-join = 2, X-join = 3, and auto join = 4. capped True for capped joins, false for un-capped joins. showAlerts Show an alert dialog if the join operation fails.
| MoveWallByOffset | Objects - Walls VectorWorks10.0 |
VectorScript Declaration:
PROCEDURE MoveWallByOffset
( theWall :HANDLE; VAR offset :REAL ) ; Python:
return offset
def vs.MoveWallByOffset(theWall, offset): Description:
Available in Architect only. Moves the wall perpendicular to its definition line by the specified offset and maintains all wall connections. Wall movement may be constrained by the surrounding geometry so the actual amount of the offset is returned.Parameters:
theWall A handle to the wall to move. offset The distance to move the given wall. Negative offsets move the wall to the left and positive offsets move the wall to the right. The actual amount the wall was moved is returned in this field. Result:
The actual amount the wall was moved is passed back in the offset parameter.
| ReverseWallSides | Objects - Walls VectorWorks10.0 |
VectorScript Declaration:
PROCEDURE ReverseWallSides
( theWall:HANDLE ) ; Python:
return None
def vs.ReverseWallSides(theWall): Description:
Switch the left and right side of a wall by reversing the direction of the wall. This is an interface to the button with the same name on the Object Info palette.Parameters:
theWall Handle to the wall to operate on. Example:
PROCEDURE ReverseWallSidesExample; VAR center_pt, start_pt, end_pt :VECTOR; h :HANDLE; BEGIN center_pt.x := 0; center_pt.y := 0; start_pt.x := 100; start_pt.y := 0; end_pt.x := 0; end_pt.y := 100; RoundWall(center_pt.x, center_pt.y, start_pt.x, start_pt.y, end_pt.x, end_pt.y); h := LNewObj; ReverseWallSides(h); END; RUN(ReverseWallSidesExample);
| RoundWall | Objects - Walls MiniCAD7.0 |
VectorScript Declaration:
PROCEDURE RoundWall
( centerPtX :REAL; centerPtY :REAL; startPtX :REAL; startPtY :REAL; endPtX :REAL; endPtY :REAL ) ; Python:
return None
def vs.RoundWall(centerPt, startPt, endPt): Description:
Procedure RoundWall creates a counter-clockwise round wall.
Parameters:
centerPt Center point of wall arc. startPt Start point of wall arc. endPt End point of wall arc. Example:
PROCEDURE Example; VAR x1, y1, x2, y2, x3, y3 :REAL; lineHandle :HANDLE; BEGIN GetPt(x1, y1); GetPtL(x1, y1, x2, y2); MoveTo(x1, y1); LineTo(x2, y2); lineHandle := LNewObj; GetPtL(x2, y2, x3, y3); IF lineHandle <> NIL THEN DelObject(lineHandle); RoundWall(x1, y1, x2, y2, x3, y3); END; RUN(Example);See Also:
Wall
| SetLayerDeltaZOffset | Objects - Walls VectorWorks12.5 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION SetLayerDeltaZOffset
( theWall :HANDLE; layerDeltaZOffset :REAL ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLayerDeltaZOffset(theWall, layerDeltaZOffset): Special Notes:
SetLayerDeltaZOffset is obsolete as of Vectorworks 2012
Description:
Sets the wall height's offset to the layer delta z.Parameters:
theWall The wall. layerDeltaZOffset The wall height's offset to the layer delta z. Result:
Returns success status.See Also:
GetLayerDeltaZOffset
| SetLinkHeightToLayerDeltaZ | Objects - Walls VectorWorks12.5 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION SetLinkHeightToLayerDeltaZ
( theWall :HANDLE; linkToLayerDeltaZ :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetLinkHeightToLayerDeltaZ(theWall, linkToLayerDeltaZ): Special Notes:
SetLinkHeightToLayerDeltaZ is obsolete as of Vectorworks 2012
Description:
Sets whether or not the wall's height is linked to the layer delta z.Parameters:
theWall The wall. linkToLayerDeltaZ Whether or not the wall's height is linked to the layer delta z. Result:
Returns success status.See Also:
GetLinkHeightToLayerDeltaZ
| SetObjectAsCornerBreak | Objects - Walls Vectorworks 2010 |
VectorScript Declaration:
FUNCTION SetObjectAsCornerBreak
( objH :HANDLE; wallH :HANDLE; cornerBreak :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetObjectAsCornerBreak(objH, wallH, cornerBreak): Description:
Sets an object's corner break flag in it's corner break record.
Setting the flag to TRUE will force the object into the closest end of the wall and set the offset position of the break record to reflect this.
Setting the flag to FALSE will unset the corner flag, but no further updating to the object will occur.
The oject (objH) must be contained in wall (wallH) for the setting to succeed.Parameters:
objH The handle of the object to update. wallH The handle of the wall cotainting the object referenced in objH. cornerBreak Boolean value to set or unset the cornerBreak flag for the object. Result:
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.
| SetObjectWallHeight | Objects - Walls Vectorworks 2015 |
VectorScript Declaration:
FUNCTION SetObjectWallHeight
( objH :HANDLE; wallH :HANDLE; height :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetObjectWallHeight(objH, wallH, height): Description:
Sets an object's height value in it's break record.
The oject (objH) must be contained in wall (wallH) to succeed.Result:
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.
| SetObjectWallOffset | Objects - Walls Vectorworks 2010 |
VectorScript Declaration:
FUNCTION SetObjectWallOffset
( objH :HANDLE; wallH :HANDLE; offset :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetObjectWallOffset(objH, wallH, offset): Description:
Sets an object's offset value in it's break record.
The oject (objH) must be contained in wall (wallH) for the setting to succeed.Parameters:
objH Handle of object to set a new offset value for. wallH Handle of wall containing the object refernces in objH. offset Value of new offset for object within wall. Result:
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.
| SetWallCapAttributesType | Objects - Walls Vectorworks 2010 |
VectorScript Declaration:
PROCEDURE SetWallCapAttributesType
( wall :HANDLE; wallCapAttributesType :INTEGER ) ; Python:
return None
def vs.SetWallCapAttributesType(wall, wallCapAttributesType): Description:
Sets the wall cap attributes type of a wall or round wall. The wall cap attributes type determines whether the wall caps have the wall line attributes or the component lines attributes. If they have the component lines attributes, each wall component is capped with its own left line attributes.Parameters:
wall The handle to the wall or round wall. wallCapAttributesType The wall cap attributes type. 0 - The wall cap attributes are the wall line attributes 1 - The wall cap attributes are the wall component lines attributes See Also:
GetWallCapAttributesType
| SetWallCaps | Objects - Walls VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetWallCaps
( theWall :HANDLE; leftCap :BOOLEAN; rightCap :BOOLEAN; round :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallCaps(theWall, leftCap, rightCap, round): Description:
Set the wall's caps.Parameters:
theWall The wall. leftCap Whether or not the wall has a left cap. rightCap Whether or not the wall has a right cap. round Whether or not the wall's caps are round. Result:
Returns success status.See Also:
GetWallCaps
| SetWallCapsOffsets | Objects - Walls VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetWallCapsOffsets
( theWall :HANDLE; leftCapLeftDistance :REAL (Coordinate); leftCapRightDistance :REAL (Coordinate); rightCapLeftDistance :REAL (Coordinate); rightCapRightDistance :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallCapsOffsets(theWall, leftCapLeftDistance, leftCapRightDistance, rightCapLeftDistance, rightCapRightDistance): Description:
Set the wall's caps' offsets.Parameters:
theWall The wall. leftCapLeftDistance The left offset of the left wall cap. leftCapRightDistance The right offset of the left wall cap. rightCapLeftDistance The left offset of the right wall cap. rightCapRightDistance The right offset of the right wall cap. Result:
Returns success status.See Also:
GetWallCapsOffsets
| SetWallControlOffset | Objects - Walls VectorWorks8.5 - obsolete as of VectorWorks12.5 |
VectorScript Declaration:
PROCEDURE SetWallControlOffset
( offset:REAL ) ; Python:
return None
def vs.SetWallControlOffset(offset): Special Notes:
SetWallControlOffset is obsolete as of VectorWorks12.5
Description:
Sets the default wall control line offset value.Parameters:
offset New offset value.
| SetWallCornerHeights | Objects - Walls Vectorworks 2012 |
VectorScript Declaration:
FUNCTION SetWallCornerHeights
( theWall :HANDLE; startHeightTop :REAL (Coordinate); startHeightBottom :REAL (Coordinate); endHeightTop :REAL (Coordinate); endHeightBottom :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallCornerHeights(theWall, startHeightTop, startHeightBottom, endHeightTop, endHeightBottom): Description:
Sets the corner heights of a wall or round wall.Parameters:
theWall The wall or round wall startHeightTop The height of the start top corner startHeightBottom The height of the start bottom corner endHeightTop The height of the end top corner endHeightBottom The height of the end bottom corner Result:
Whether or not the call succeededSee Also:
GetWallCornerHeights
| SetWallHeights | Objects - Walls VectorWorks12.0 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
FUNCTION SetWallHeights
( h :HANDLE; startHtDistance :REAL (Coordinate); endHtDistance :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallHeights(h, startHtDistance, endHtDistance): Special Notes:
SetWallHeights is obsolete as of Vectorworks 2012
Description:
Sets the wall heights of an unstyled wall. Will return false for a styled wall.Example:
PROCEDURE Example; VAR h :HANDLE; boo :BOOLEAN; BEGIN CallTool(-208); h := FSActLayer; boo := SetWallHeights(h, 12, 23); END; RUN(Example);
| SetWallOverallHeights | Objects - Walls Vectorworks 2012 |
VectorScript Declaration:
FUNCTION SetWallOverallHeights
( theWall :HANDLE; botBoundType :INTEGER; botBoundStory :INTEGER; botLayerLevelType :STRING; botOffset :REAL (Coordinate); topBoundType :INTEGER; topBoundStory :INTEGER; topLayerLevelType :STRING; topOffset :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallOverallHeights(theWall, botBoundType, botBoundStory, botLayerLevelType, botOffset, topBoundType, topBoundStory, topLayerLevelType, topOffset): Description:
Sets the overall heights of a wall or round wall.Parameters:
theWall The wall or round wall botBoundType The type of the bottom bound 0 - Layer Z; 1 - Default Wall Height; 2 - Story botBoundStory The story of the bottom bound 0 - Object's story; 1 - Story above; 2 - Story below botLayerLevelType The layer level type of the bottom bound botOffset The offset of the bottom bound topBoundType The type of the top bound 0 - Layer Z; 1 - Default Wall Height; 2 - Story topBoundStory The story of the top bound 0 - Object's story; 1 - Story above; 2 - Story below topLayerLevelType The layer level type of the top bound topOffset The offset of the top bound Result:
Whether or not the call succeededSee Also:
GetWallOverallHeights
| SetWallStyle | Objects - Walls VectorWorks12.5 |
VectorScript Declaration:
FUNCTION SetWallStyle
( theWall :HANDLE; wallStyle :STRING; selectedOffDistance :REAL (Coordinate); replacingOffDistance :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallStyle(theWall, wallStyle, selectedOffDistance, replacingOffDistance): Description:
Applies the given Wall Style to the given wall, aligning to the given offsets.Parameters:
theWall The wall. wallStyle The Wall Style to apply. selectedOffDistance The offset of the wall to align to. replacingOffDistance The offset of the Wall Style to align to. Result:
Returns success status.See Also:
GetWallStyle
| SetWallThickness | Objects - Walls VectorWorks12.0 |
VectorScript Declaration:
FUNCTION SetWallThickness
( h :HANDLE; thicknessDistance :REAL (Coordinate) ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetWallThickness(h, thicknessDistance): Description:
Sets the thickness of an unstyled wall without components. Will return false for a styled wall or a wall with components. To change the thickness of a wall with components, add, remove or resize components with InsertNewComponent, DeleteComponent, and SetComponent Width
| SetWallWidth | Objects - Walls MiniCAD6.0 - obsolete as of VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE SetWallWidth
( widthDistance:REAL (Coordinate) ) ; Python:
return None
def vs.SetWallWidth(widthDistance): Special Notes:
SetWallWidth is obsolete as of VectorWorks12.0
Description:
Procedure SetWallWidth sets the default wall width of the document.
Parameters:
widthDistance New default wall width.
| Wall | Objects - Walls MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE Wall
( p1X :REAL; p1Y :REAL; p2X :REAL; p2Y :REAL ) ; Python:
return None
def vs.Wall(p1, p2): Description:
Procedure Wall creates a wall object in a Vectorworks document. The wall will adopt the current default settings for walls when created.
Parameters:
p1 Start point of wall. p2 End point of wall. See Also:
RoundWall
| WallCap | Objects - Walls MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE WallCap
( atStart :BOOLEAN; closed :BOOLEAN; round :BOOLEAN; rightOffDistance :REAL (Coordinate); leftOffDistance :REAL (Coordinate) ) ; Python:
return None
def vs.WallCap(atStart, closed, round, rightOffDistance, leftOffDistance): Description:
Procedure WallCap creates a wall cap on a newly created wall object.
Specifying nonzero values for the cap offset values will create angled wall caps.
Parameters:
atStart Start-end location of wall cap. closed Controls display status of cap. round Specifies flat or round cap. rightOffDistance Right extension of wall line beyond end point. leftOffDistance Left extension of wall line beyond end point. Example:
Wall(0,0,7',0); WallCap(True, True, False, 1.0', 0.0); {sets the cap status of the starting cap of the wall as flat cap, bevelled, with the right side extending 1' beyond the wall end point}
| WallFootPrint | Objects - Walls VectorWorks10.0 |
VectorScript Declaration:
FUNCTION WallFootPrint
( wallHandle:HANDLE ) :HANDLE ; Python:
return HANDLE
def vs.WallFootPrint(wallHandle): Description:
Returns the handle of a polyline representing the footprint of a wall.Parameters:
wallHandle Handle to the wall Result:
Returns the handle of a polyline representing the footprint of a wall.Example:
PROCEDURE GetWallFootPrint; VAR h1, h2 :HANDLE; BEGIN h1 := FSActLayer; h2 := WallFootPrint(h1); END; RUN(GetWallFootPrint);
| WallHeight | Objects - Walls MiniCAD6.0 - obsolete as of Vectorworks 2012 |
VectorScript Declaration:
PROCEDURE WallHeight
( wallHd :HANDLE; VAR startHt :REAL; VAR endHt :REAL ) ; Python:
return (startHt, endHt)
def vs.WallHeight(wallHd): Special Notes:
WallHeight is obsolete as of Vectorworks 2012
Description:
Procedure WallHeight returns the wall heights of the referenced wall object.
Parameters:
wallHd Handle to wall. startHt Returns start height of wall. endHt Returns end height of wall.
| WallPeak | Objects - Walls MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE WallPeak
( alongDistance :REAL (Coordinate); heightDistance :REAL (Coordinate) ) ; Python:
return None
def vs.WallPeak(alongDistance, heightDistance): Description:
Creates a wall peak of the specified height at a specified distance from the wall start point.
There is no error checking of the distance or peak height parameters; it is left to the programmer to ensure that the parameter values are valid.
Parameters:
alongDistance Location of peak (measured from wall start point). heightDistance Elevation of wall peak. Example:
SetZVal(0',8'); Wall(0,0,7,0); WallPeak(3'-6",9'-0"); {creates a 9' wall peak 3'-6" from the start point of the wall}
| WallTo | Objects - Walls MiniCAD4.0 |
VectorScript Declaration:
PROCEDURE WallTo
( pX :REAL; pY :REAL ) ; Python:
return None
def vs.WallTo(p): Description:
Procedure WallTo creates a wall object in a Vectorworks document. WallTo begins the wall at the current graphics pen position, with the end point at the specified location.
To explicitly set the start point of the wall, WallTo must be preceded by either Procedure MoveTo, LineTo, Wall, or WallTo. The procedure automatically performs a join/cleanup operation an intersection if the previous procedure was a wall creation procedure.Parameters:
p End point of wall. Example:
PROCEDURE Example; VAR x1, y1, x2, y2 :REAL; resourceID :LONGINT; wallStyleCnt :INTEGER; wallStyleName :STRING; wallStyleHand :HANDLE; BEGIN resourceID := BuildResourceList(127, 113, '', wallStyleCnt); IF wallStyleCnt > 0 THEN BEGIN wallStyleName := GetNameFromResourceList(resourceID, 1); AlrtDialog(wallStyleName); wallStyleHand := ImportResourceToCurrentFile(resourceID, 1); SetWallPrefStyle(wallStyleName); END ELSE BEGIN SetWallWidth(3.5"); END; GetPt(x1, y1); GetPtL(x1, y1, x2, y2); MoveTo(x1, y1); WallTo(x2, y2); END; RUN(Example);
| WallWidth | Objects - Walls MiniCAD6.0 |
VectorScript Declaration:
FUNCTION WallWidth
( wallHd:HANDLE ) :REAL ; Python:
return REAL
def vs.WallWidth(wallHd): Description:
Function WallWidth returns the wall width of the referenced wall object.
Parameters:
wallHd Handle to wall. See Also:
GetWallThickness HWallWidth