Stair component parameters
General stair variables – available for listing and labels
Compatibility: introduced in ARCHICAD 21.
STAIR_AREA 
projected 2D area of the stair 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_BREAKMARK_GEOMETRY 
geometry of the breakmarks 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Compatibility: introduced in ARCHICAD 23. 
.breakMarks[m] 
(array) All shown breakmarks’ geometry. The array size depends on the Floor Plan Display Layout of the Stair. 
.breakMarks[m].isVisible 
(boolean) Visibility attribute of the part of the stair that this break mark cuts. 
.breakMarks[m].polyline2D{} 
(dictionary) 2D polyline in the project coordinate system. Contains only the part between the stair’s boundaries (without the extensions). The same data format as PolyOperations polylines, it can be sent directly to “StoreDictPolyline”. 
.breakMarks[m].polyline2D.isClosed 
(boolean) 1 – closed polyline, 0 – open polyline (the last point given as an extra edge). Breakmarks are always open polylines. 
.breakMarks[m].polyline2D.contour{} 
(dictionary) contains data of the polyline 
.breakMarks[m].polyline2D.contour.edges[n] 
(array) contains an embedded dictionary for each edge of the polyline. 
.breakMarks[m].polyline2D.contour.edges[n].type 
(integer) 0 – straight, 1 – curved (circular arc) 
.breakMarks[m].polyline2D.contour.edges[n].begPoint{} 
(dictionary) an embedded dictionary for the 2D coordinates of the beginning point of the edge 
.breakMarks[m].polyline2D.contour.edges[n].begPoint.x 
(float) 
.breakMarks[m].polyline2D.contour.edges[n].begPoint.y 
(float) 
.breakMarks[m].polyline2D.contour.edges[n].arcAngle 
(angle) central angle of the edge curve, positive counterclockwise, negative clockwise (not set for straight edges) 
STAIR_VOLUME 
area of the stair including all 3D parts 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_HEIGHT 
difference between maximum and minimum of Z coordinates 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_WALKLINE_LENGTH 
projected 2D length of the stair’s walking line 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_DEFAULT_WIDTH 
default width of stair (as set in the Stair Default Settings/Geometry and Positioning panel) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_DEFAULT_GOING_DEPTH 
default depth of going (as set in the Stair Default Settings/Geometry and Positioning panel) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_DEFAULT_RISER_HEIGHT 
default width of riser (as set in the Stair Default Settings/Geometry and Positioning panel) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_DEFAULT_TREAD_THICKNESS 
default tread thickness of stair (as set in the Stair Default Settings/Geometry and Positioning panel) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_NR_OF_TREADS_IN_FLIGHTS 
integer array with one dimension ([n]) number of treads in each flight of the stair (n = number of flights) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_NR_OF_RISERS_IN_FLIGHTS 
integer array with one dimension ([n]) number of risers in each flight of the stair (n = number of flights) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_NR_OF_RISERS 
number of risers regarding the whole stair 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_NR_OF_TREADS 
number of treads regarding the whole stair 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_LANDING_NUMBER 
number of landing sections regarding the whole stair 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_STAIR_GRADIENT 
stair inclination: the angle of the riser/going ratio in radian 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
length/angle array with two dimensions ([6][2]), collection of minimum and maximum values set in Stair Default Settings/Rules and Standards/Treads and Risers panel 
Project Preferences setting of the visibility of these values does not affect the variable. 
 [1][1] – [1][2]: Riser height (R) minimum and maximum value
 [2][1] – [2][2]: Going (G) minimum and maximum value
 [3][1] – [3][2]: 2 Riser + 1 Going (2*R + G) minimum and maximum value
 [4][1] – [4][2]: Riser / Going ratio (R / G) minimum and maximum value
 [5][1] – [5][2]: Riser + Going (R + G) minimum and maximum value
 [6][1] – [6][2]: Stair pitch minimum and maximum value

2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
boolean array with two dimensions ([6][2]), enable/disable status collection of limits in accordance with STAIR_RULE_LIMITS, set in Stair Default Settings/Rules and Standards/Treads and Risers panel 
Value indexes are parallel to STAIR_RULE_LIMITS. Possible values: 
 0 – limit option of the same index in STAIR_RULE_LIMITS is currently not used
 1 – limit option of the same index in STAIR_RULE_LIMITS is currently in use

General tread variables – available for listing and labels
Compatibility: introduced in ARCHICAD 21.
TREAD_STEP_INDEX 
step index of the selected (current) tread 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_GOING 
going length of the selected (current) tread 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_ELEVATION 
elevation to Project Zero of the selected (current) tread 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_AREA 
projected 2D area of the selected (current) tread 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_FRONT_AREA 
front surface area of the selected (current) tread 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_VOLUME 
volume of the selected (current) tread 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
array with one dimension ([n]), building materials of the selected (current) tread (n = number of building materials)
General riser variables – available for listing and labels
Compatibility: introduced in ARCHICAD 21.
RISER_STEP_INDEX 
step index of the selected (current) riser 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RISER_WIDTH 
polyline length of the selected (current) riser 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RISER_FRONT_AREA 
front surface area of the selected (current) riser 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RISER_VOLUME 
volume of the selected (current) riser 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
array with one dimension ([n]), building materials of the selected (current) riser (n = number of building materials)
Stair structure variables – available for listing and labels
Compatibility: introduced in ARCHICAD 21.
STRUCTURE_WIDTH 
width of the selected (current) structure component 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STRUCTURE_HEIGHT 
height of the selected (current) structure component (difference of min. and max. z) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STRUCTURE_3DLENGTH 
full 3D length of the selected (current) structure component 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STRUCTURE_VOLUME 
volume of the selected (current) structure component 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STRUCTURE_THICKNESS 
thickness of the selected (current) structure component 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Stair Model View Options variables
Related settings are available on the Model View Options/Stair and Railing options dialog.
Compatibility: introduced in ARCHICAD 21.
GLOB_MVO_STAIR_FLOOR_PLAN_OPT 
Stair MVO Floor Plan option: 0 – Floor Plan, 1 – Reflected Ceiling Plan 
2D 

3D 

UI 

Parameter 

Property 

Default 
1 
GLOB_MVO_STAIR_FLOOR_PLAN_COMP 
Stair MVO Component bitset 
2D 

3D 

UI 

Parameter 

Property 

Default 
1 
mask:
returns information about the visible stair components of the floor plan
mask = j1 + 2*j2 + 4*j3 + 8*j4 + 16*j5 + 32*j6 + 64*j7 + 128*j8 + 256*j9
, where each j can be 0 or 1.
j_{1}:
walking line
j_{2}:
numbering
j_{3}:
up/down text
j_{4}:
description
j_{5}:
tread accessories
j_{6}:
structure – beam
j_{7}:
structure – stringers
j_{8}:
structure – cantilevered
j_{9}:
structure – monolithic Compatibility: introduced in ARCHICAD 22.
GLOB_MVO_RAILING_PLAN_COMP 
Railing MVO Component bitset 
2D 

3D 

UI 

Parameter 

Property 

Default 
127 
mask = j1 + 2*j2 + 4*j3 + 8*j4 + 16*j5 + 32*j6 + 64*j7
, where each j can be 0 or 1.
mask:
returns information about the visible stair components of the floor plan
j_{1}:
posts
j_{2}:
toprail
j_{3}:
handrails
j_{4}:
rails
j_{5}:
inner posts
j_{6}:
balusters
j_{7}:
panels
Stair grid variables
Compatibility: introduced in ARCHICAD 21.
STAIR2D_FULL_TPOLYGON_GEOM 
array with two dimensions ([n][3]), data triplets of tread polygon nodes 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
n = number of treads * 5 nodes for each tread (in general):
 [n][1] – coordinate x of polygon node measured from stair origin
 [n][2] – coordinate y of polygon node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_FULL_TPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), additional data of the tread polygons, in accordance with STAIR2D_FULL_TPOLYGON_GEOM
n = number of treads * 5 nodes for each tread (in general):
 [n][1] – index of tread
 [n][2] – edge type starting from node (0 – leading, 1 – trailing, 2 – left, 3 – right, 4 – breakline, 1 – closing)
 [n][3] – visibility of the edge starting from the node (1 – visible, 0 – omitted)
 [n][4] – type of tread (0 – flight, 1 – landing)
STAIR2D_FULL_RPOLYLINE_GEOM 
array with two dimensions ([n][3]), data triplets of riser polyline nodes 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
n = number of risers * 2 nodes for each tread (in general):
 [n][1] – coordinate x of polyline node measured from stair origin
 [n][2] – coordinate y of polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_FULL_RPOLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), additional data of the riser polylines, in accordance with STAIR2D_FULL_RPOLYLINE_GEOM
n = number of risers * 2 nodes for each tread (in general):
STAIR2D_FULL_BOUNDARY_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of stair boundary polygon nodes
n = number of boundary nodes (5 in general):
 [n][1] – coordinate x of polygon node measured from stair origin
 [n][2] – coordinate y of polygon node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
The following globals are used to define the parts of the stair represented below the first breakmark.
STAIR2D_LOWER_TPOLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of tread polygon nodes of lower part, similar to STAIR2D_FULL_TPOLYGON_GEOM
STAIR2D_LOWER_TPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), additional data of tread polygon nodes of lower part, similar to STAIR2D_FULL_TPOLYGON_FLAGS
STAIR2D_LOWER_RPOLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of riser polyline nodes of lower part, similar to STAIR2D_FULL_RPOLYLINE_GEOM
STAIR2D_LOWER_RPOLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), additional data of riser polyline nodes of lower part, similar to STAIR2D_FULL_RPOLYLINE_FLAGS
STAIR2D_LOWER_BOUNDARY_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of stair boundary polygon nodes of lower part, similar to STAIR2D_FULL_BOUNDARY_GEOM
The following globals are used to define the parts of the stair represented between two breakmarks.
STAIR2D_MIDDLE_TPOLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of tread polygon nodes of middle part, similar to STAIR2D_FULL_TPOLYGON_GEOM
STAIR2D_MIDDLE_TPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), additional data of tread polygon nodes of middle part, similar to STAIR2D_FULL_TPOLYGON_FLAGS
STAIR2D_MIDDLE_RPOLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of riser polyline nodes of middle part, similar to STAIR2D_FULL_RPOLYLINE_GEOM
STAIR2D_MIDDLE_RPOLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), additional data of riser polyline nodes of middle part, similar to STAIR2D_FULL_RPOLYLINE_FLAGS
STAIR2D_MIDDLE_BOUNDARY_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of stair boundary polygon nodes of middle part, similar to STAIR2D_FULL_BOUNDARY_GEOM
The following globals are used to define the parts of the stair represented above the last breakmark.
STAIR2D_UPPER_TPOLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of tread polygon nodes of upper part, similar to STAIR2D_FULL_TPOLYGON_GEOM
STAIR2D_UPPER_TPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), additional data of tread polygon nodes of upper part, similar to STAIR2D_FULL_TPOLYGON_FLAGS
STAIR2D_UPPER_RPOLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of riser polyline nodes of upper part, similar to STAIR2D_FULL_RPOLYLINE_GEOM
STAIR2D_UPPER_RPOLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), additional data of riser polyline nodes of upper part, similar to STAIR2D_FULL_RPOLYLINE_FLAGS
STAIR2D_UPPER_BOUNDARY_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of stair boundary polygon nodes of upper part, similar to STAIR2D_FULL_BOUNDARY_GEOM
Stair walking line symbol variables
STAIR2D_FULL_WALKLINE_GEOM 
array with two dimensions ([n][3]), data triplets of stair walking line nodes, full length 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
n = number of polyline nodes for the full length of the walking line
 [n][1] – coordinate x of polyline node measured from stair origin
 [n][2] – coordinate y of polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_FULL_WALKLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][2]), additional data of stair walking line nodes, full length
n = number of polyline nodes for the full length of the walking line
mask:
returns information about the node position
j_{1}:
node is on trail end of first tread
j_{2}:
node is on lead end of landing
j_{3}:
node is on trail end of landing
j_{4}:
node is on lead end of last tread
 [n][1] – location mask of the node
 [n][2] – index of tread where the node is on trail end or above
STAIR2D_LOWER_WALKLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of stair walking line nodes, lower part (same logic as stair polygon slicing)
n = number of polyline nodes for the lower part of the walking line
 [n][1] – coordinate x of polyline node measured from stair origin
 [n][2] – coordinate y of polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_LOWER_WALKLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
integer array with two dimensions ([n][2]), additional data of stair walking line nodes, lower part
n = number of polyline nodes for the lower part of the walking line
mask:
returns information about the node position
j_{1}:
node is on trail end of first tread
j_{2}:
node is on lead end of landing
j_{3}:
node is on trail end of landing
j_{4}:
node is on lead end of last tread
 [n][1] – location mask of the node
 [n][2] – index of tread where the node is on trail end or above
STAIR2D_MIDDLE_WALKLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of stair walking line nodes, middle part
n = number of polyline nodes for the middle part of the walking line
 [n][1] – coordinate x of polyline node measured from stair origin
 [n][2] – coordinate y of polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_MIDDLE_WALKLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
integer array with two dimensions ([n][2]), additional data of stair walking line nodes, middle part
n = number of polyline nodes for the upper part of the walking line
mask:
returns information about the node position
j_{1}:
node is on trail end of first tread
j_{2}:
node is on lead end of landing
j_{3}:
node is on trail end of landing
j_{4}:
node is on lead end of last tread
 [n][1] – location mask of the node
 [n][2] – index of tread where the node is on trail end or above
STAIR2D_UPPER_WALKLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][2]), additional data of stair walking line nodes, upper part
n = number of polyline nodes for the upper part of the walking line
mask:
returns information about the node position
j_{1}:
node is on trail end of first tread
j_{2}:
node is on lead end of landing
j_{3}:
node is on trail end of landing
j_{4}:
node is on lead end of last tread
 [n][1] – location mask of the node
 [n][2] – index of tread where the node is on trail end or above
Stair break mark symbol variables
STAIR2D_BREAKMARK_GEOM 
array with two dimensions ([n][9]), data of breakmark polyline nodes 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
n = number of breakmarks * 5 nodesdata for each breakmark (maximum number of displayed breakmarks is 4):
 [n][1] – coordinate x of polyline start measured from stair origin
 [n][2] – coordinate y of polyline start measured from stair origin
 [n][3] – coordinate x of polyline end measured from stair origin
 [n][4] – coordinate y of polyline end measured from stair origin
 [n][5] – break mark angle calculated from the perpendicular of the walking line, in degrees (value updates with editing). See also STAIR2D_BREAKMARK_ANGLE.
 [n][6] – coordinate x of start extension measured from stair origin Compatibility: introduced in ARCHICAD 22.
 [n][7] – coordinate y of start extension measured from stair origin Compatibility: introduced in ARCHICAD 22.
 [n][8] – coordinate x of end extension measured from stair origin Compatibility: introduced in ARCHICAD 22.
 [n][9] – coordinate y of end extension measured from stair origin Compatibility: introduced in ARCHICAD 22.
STAIR2D_BREAKMARK_FLAGS 
integer array with two dimensions ([n][1]), additional data for breakmark polyline visibility 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
n = number of breakmarks visible in the current settings (maximum 4)
Attribute Set Index:
1:
break mark visible,
1:
break mark hidden
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
break mark angle in degrees (Real type value) as set in the Stair Settings dialog. Keeps the preset value even if the break mark is edited.
Rise and Run description variables
STAIR2D_DESCRIPTION_POSITION 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), containing information about the position and direction of the Description text
n:
position definition:
1:
center of first flight,
2:
center of first landing,
3:
center of last flight,
4:
center of last landing,
5:
center of stair.
 [n][1] – coordinate x of description position measured from stair origin
 [n][2] – coordinate y of description position measured from stair origin
 [n][3] – walking line normal vector x coordinate in description position
 [n][4] – walking line normal vector y coordinate in description position
Stair draining 2D variables
No slicing with breakmarks is present in the geometry of the following globals.
STAIR2D_EXT_TPOLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of extended tread polygon nodes (including draining). Similar structure as STAIR2D_FULL_TPOLYGON_GEOM
n = number of treads * 5 nodes for each tread (in general):
 [n][1] – coordinate x of extended tread polygon node measured from stair origin
 [n][2] – coordinate y of extended tread polygon node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_EXT_TPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), additional data of the tread extended polygons, in accordance with STAIR2D_EXT_TPOLYGON_GEOM. Similar structure as STAIR2D_FULL_TPOLYGON_FLAGS.
n = number of treads * 5 nodes for each tread (in general):
 [n][1] – index of tread
 [n][2] – edge type starting from node (0 – leading, 1 – trailing, 2 – left, 3 – right, 1 – closing)
 [n][3] – visibility of the edge starting from the node (1 – visible, 0 – omitted)
 [n][4] – type of tread (0 – flight, 1 – landing)
STAIR2D_EXT_RPOLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of extended riser polyline nodes (including draining). Similar structure as STAIR2D_FULL_RPOLYLINE_GEOM.
n = number of risers * 2 nodes for each tread (in general):
 [n][1] – coordinate x of polyline node measured from stair origin
 [n][2] – coordinate y of polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_EXT_RPOLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), additional data of the riser polylines, in accordance with STAIR2D_EXT_RPOLYLINE_GEOM. Similar structure as STAIR2D_FULL_RPOLYLINE_FLAGS.
n = number of risers * 2 nodes for each tread (in general):
STAIR2D_DRAIN_TPOLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), data triplets of drain polygon nodes. Similar structure as STAIR2D_FULL_TPOLYGON_GEOM.
n = number of treads * 5 nodes for each tread (in general):
 [n][1] – coordinate x of extended tread polygon node measured from stair origin
 [n][2] – coordinate y of extended tread polygon node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_DRAIN_TPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), additional data of the drain polygons, in accordance with STAIR2D_DRAIN_TPOLYGON_GEOM. Similar structure as STAIR2D_FULL_TPOLYGON_FLAGS.
n = number of treads * 5 nodes for each tread (in general):
 [n][1] – index of tread
 [n][2] – edge type starting from node
 0 – leading
 1 – trailing
 2 – left (+100 – draining side left, +200 – draining side left and “Stepped” type)
 3 – right (+100 – draining side right, +200 – draining side right and “Stepped” type)
 1 – closing
 [n][3] – visibility of the edge starting from the node (1 – visible, 0 – omitted)
 [n][4] – type of tread (0 – flight, 1 – landing)
Stair structure 2D variables – Beam Structures
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of structure polyline nodes of the current flight/landing in 2D, contains geometric data of the polyline nodes derived from the stair boundary: left boundary line, right boundary line and centerline.
 [n][1] – coordinate x of structure polyline node measured from stair origin
 [n][2] – coordinate y of structure polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of structure polyline nodes of the current flight/landing in 2D, contains group data of the polyline nodes.
 [n][1] – position flags, point n belongs to: 0 – left boundary, 1 – right boundary, 2 – center line
STAIR2D_STRUCT_ATTRIBUTES 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0, 0, 0, 0, 0, 0, 0] 
array with two dimensions ([2][7]), containing attributes settings of the visible ([1][n]) and invisible ([2][n]) parts of the structure.
 [n][1] – boundary line type index
 [n][2] – boundary pen index
 [n][3] – symbol fill type
 [n][4] – symbol fill pen
 [n][5] – symbol fill background pen
 [n][6] – symbol fill ON/OFF boolean control for Custom display only (STAIR2D_CUSTOMDISPLAY = 1)
 [n][7] – symbol part enable ON/OFF boolean control for Custom display only (STAIR2D_CUSTOMDISPLAY = 1).
Stair structure 2D variables – Monolithic Structure
Compatibility: introduced in ARCHICAD 22.
These globals are filled with values with respect to actual Floor Plan/Reflected Ceiling Plan View.
STAIR2D_FULL_SPOLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0, 0, 0] 
array with three dimensions ([n][3]), containing subpolygons of the stair 2D projection.
 [n][1] – coordinate x of structure polygon node measured from stair origin
 [n][2] – coordinate y of structure polygon node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
STAIR2D_FULL_SPOLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0, 0, 0] 
array with three dimensions ([n][3]), where n is the number of polygon nodes.
 [n][1] – index of subpolygon
 [n][2] – type of subpolygon
 1: Flight boundary – without connection
 2: Flight boundary – with connection
 3: Landing boundary – without connection
 4: Landing boundary – with connection
 5: Connection
 6: Draining
 [n][3] – type of subpolygon edge
 1: closing point (next point is new subpolygon)
 0: invisible edge (only bounds area)
 1: visible monolith edge (visible or hidden attribute set by STAIR2D_VISIBILITY)
 2: visible connection edge (visible or hidden attribute set by STAIR2D_VISIBILITY)
 3: visible connection detail edge (visible or hidden attribute set by STAIR2D_VISIBILITY)
A subpolygon of type Connection can have mixed monolith and connection edges.
STAIR2D_FULL_SPOLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0, 0] 
array with two dimensions ([n][2]), containing edges within the boundary.
 [2*i][1] – coordinate x of starting node measured from stair origin
 [2*i][2] – coordinate y of starting node measured from stair origin
 [2*i + 1][1] – coordinate x of end node measured from stair origin
 [2*i + 1][2] – coordinate y of end node measured from stair origin
STAIR2D_FULL_SPOLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with one dimension [n], where n is the number of nodes in STAIR2D_FULL_SPOLYLINE_GEOM.
 [n] – type of edge
 1: Going, cut with drain
 2: Going, full
 3: Going Nosing (slanted risers), cut with drain
 4: Going Nosing (slanted risers), full
 5: Landing Line, cut with drain
 6: Landing Line, full
 7: Connection
 8: Connection Detail
 9: Draining (stepped draining)
 10: Draining Nosing (draining with slanted steps)
STAIR2D_MONOLITH_ATTRIBUTES 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0, 0] 
array with two dimensions ([2][23]), containing attributes and visibility settings of the visible ([1][n]) and invisible ([2][n]) parts of the monolithic structure.
 [n][1] – Structure visibility (bool)
 [n][2] – Draining visibility (bool)
 [n][3] – Contour line type
 [n][4] – Contour line pen
 [n][5] – Structure Going visibility (bool)
 [n][6] – Landing Line visibility (bool)
 [n][7] – Going Line Type
 [n][8] – Going Line Pen
 [n][9] – Structure Going Nosing visibility (bool)
 [n][10] – Going Nosing line type
 [n][11] – Going Nosing line pen
 [n][12] – Connection visibility (bool)
 [n][13] – Connection line type
 [n][14] – Connection line pen
 [n][15] – Connection Detail line type
 [n][16] – Connection Detail line pen
 [n][17] – Draining Fill and Structure Fill visibility (bool)
 [n][18] – Structure fill type
 [n][19] – Structure fill pen
 [n][20] – Structure fill background pen
 [n][21] – Draining fill type
 [n][22] – Draining fill pen
 [n][23] – Draining fill background pen
General 2D related variables
STAIR2D_CURRSTORY_LOCATION 
information about the current story visibility of the stair 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
1:
below relevant story,
2:
first relevant story,
3:
interrelevant story,
4:
toplast relevant story,
5:
above relevant story.
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
array with one dimension ([5]), information about the display layout types of the stair according to STAIR2D_CURRSTORY_LOCATION
 [1] – below relevant story layout setting
 [2] – first relevant story layout setting
 [3] – interrelevant story layout setting
 [4] – toplast relevant story layout setting
 [5] – above relevant story layout setting
Layout setting values:
0:
invalid
1:
With Break Mark: Visible – Hidden
2:
No Break Mark: Visible
3:
Below Break Mark: Visible
4:
Above Break Mark: Visible
7:
No Break Mark: Hidden
8:
Above Break Mark: Hidden
9:
Below Break Mark: Hidden
13:
With Break Mark: All Visible
14:
With Break Mark: Hidden – Visible
5:
Multistory 2D: Visible Inbetween Break Marks
6:
Multistory 2D: Hidden – Visible – Hidden
10:
Multistory 2D: All Visible
11:
Multistory 2D: Hidden – Visible – None
12:
Multistory 2D: None – Visible – Hidden
STAIR2D_VISIBILITY 
type of the active attribute set of the current drawing. Usable in connection with Grid and Tread 2D symbol only. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
1:
‘Visible’ attribute set is in effect
0:
‘Hidden’ attribute set is in effect
STAIR2D_CUSTOMDISPLAY 
contains information about the model view settings of the stair 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
0:
stair is displayed according to Model View Option settings
1:
stair is displayed with custom settings
STAIR_START_WITH_RISER 
Boolean telling whether the stair starts with a riser. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Compatibility: introduced in ARCHICAD 22.
STAIR_END_WITH_RISER 
Boolean telling whether the stair ends with a riser. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Compatibility: introduced in ARCHICAD 22.
STAIR_TREAD_EXIST 
Boolean array ([2]) telling whether the stair has a Tread component. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Compatibility: introduced in ARCHICAD 22.
Treads customized in Edit mode don’t have effect on these values.
 [1] – on Flight
 [2] – on Landing
STAIR_RISER_EXIST 
Boolean array ([2]) telling whether the stair has a Riser component. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Compatibility: introduced in ARCHICAD 22.
Risers customized in Edit mode don’t have effect on these values.
 [1] – on Flight
 [2] – on Landing
STAIR_NOSING_EXIST 
Treads customized in Edit mode don’t have effect on these values. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Compatibility: introduced in ARCHICAD 22.
Risers customized in Edit mode don’t have effect on these values.
 [1] – on Flight
 [2] – on Landing
Stair 3D variables – available for 3D representation (and connecting viewpoints) only
Compatibility: introduced in ARCHICAD 21.
Stair riser 3D variables
RISER_HEIGHT 
3D height value of the selected riser 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RISER_THICKNESS 
3D thickness value of the selected riser 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
STAIR_RISER_GEOMETRY 
array with two dimensions ([n][3]), data triplets of stair riser polyline path node 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
n = number of nodes of the riser polyline path:
 [n][1] – coordinate x of polyline node measured from stair origin
 [n][2] – coordinate y of polyline node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([2][2]), contains data of starting and closing points of the ideal TUBE (modelling the riser in 3D)
The display segmentation of the tube does not affect the value of this variable. To achieve a correct model in all cases, this global can be used to calculate the actual starting and closing points of the tube following the segmented arc.
 [1][1] – coordinate x of starting node measured from stair origin
 [1][2] – coordinate y of starting node measured from stair origin
 [2][1] – coordinate x of closing node measured from stair origin
 [2][2] – coordinate y of closing node measured from stair origin
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
array with two dimensions ([2][2]), contains data of starting and closing points of the ideal TUBE (modelling the riser in 3D)
In case Slanting is set to 0, the value of this global is 90 degrees.
Stair tread 2D3D variables
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
3D thickness value of the selected tread, contains data of starting and closing points of the ideal TUBE (modelling the riser in 3D)
In case Slanting is set to 0, the value of this global is 90 degrees.
STAIR_TREAD_GEOMETRY 
array with two dimensions ([n][3]), data triplets of stair tread polygon nodes 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
n = number of nodes of the tread polygon:
 [n][1] – coordinate x of node measured from stair origin
 [n][2] – coordinate y of node measured from stair origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), additional data of the tread polygon edges (starting from nodes), in accordance with STAIR_TREAD_GEOMETRY
n = number of nodes of the tread polygon:
 [n][1] – flag of the nth edge of the polygon
flags:
0:
lead edge of tread polygon
1:
trail edge of tread polygon
2:
left edge of tread polygon
3:
right edge of tread polygon
1:
closing node of tread polygon
TREAD_LOWER_RISER_THICKNESS 
thickness of the riser below the current tread (measured between grid and structure) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
height of the riser below the current tread (measured between the bottom plane of the current tread and the upper plane of the previous tread)
TREAD_LOWER_RISER_SLANT_ANGLE 
slant angle of the riser below the current tread in degrees (is Slanting = 0, the value is 90 degrees) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_UPPER_RISER_THICKNESS 
thickness of the riser above the current tread (measured between grid and structure) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
height of the riser above the current tread (measured between the top plane of the current tread and the bottom plane of the following tread)
TREAD_UPPER_RISER_SLANT_ANGLE 
slant angle of the riser above the current tread in degrees (is Slanting = 0, the value is 90 degrees) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
TREAD_NOSING_METHOD 
information about the nosing method of the current tread, as set on the Stair Settings dialog 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
1:
nosing by value length
2:
nosing by slanting length
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
contains tread nosing depth value of the selected tread (horizontal offset, as set on the Stair Settings dialog), in case TREAD_NOSING_METHOD = 1 (nosing by value length)
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
contains tread nosing length value (vertical offset to control riser intersection point, as set on the Stair Settings dialog), in case TREAD_NOSING_METHOD = 2 (nosing by slanting length)
Stair structure variables
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
array with two dimensions ([n][14]), where n is the number of structure polygons points of the current flight/landing.
 [n][1] – coordinate x of structure polygon node n, measured from stair origin
 [n][2] – coordinate y of structure polygon node n, measured from stair origin
 [n][3] – coordinate z of structure polygon node n, measured from stair origin
 [n][4] – central angle in degrees of the edge starting from node n (0 – straight edge, < 0 – arc, counterclockwise, > 0 – arc, clockwise)
 [n][5] – riser slant angle of the edge starting from node n. In case of leading edge, the angle belongs to the riser below the polygon. In case of trailing edge, the angle belongs to the riser above the polygon. Contains 0 for all other edge categories.
 [n][6] – height of the riser below the structure polygon (returns 0 in case there is no riser, or if the polygon is a connection polygon)
 [n][7] – height of the riser above the structure polygon (returns 0 in case there is no riser, or if the polygon is a connection polygon)
 [n][8] – thickness of the tread of the structure polygon (returns 0 if the polygon is a connection polygon)
 [n][9] – thickness of the gap below the tread of the structure polygon (returns 0 if the polygon is a connection polygon)
 [n][1014] – Compatibility: introduced in ARCHICAD 22.
 [n][10] – Cantilevered structure height (read from its ac_stairStructureThickness parameter) beneath the tread at this point. Zero in case of connection polygons.
 [n][11] – Tread nosing at the edge starting from this point.
 Zero in case of connection polygons
 Nosing of the tread above leading edges
 Nosing of the next tread above trailing edges
 Zero in case of other edges
 [n][12] – Riser thickness at the edge starting from this point.
 Zero in case of connection polygons
 Thickness of the riser below leading edges
 Thickness of the riser above trailing edges
 Zero in case of other edges
 [n][13] – Riser gap thickness at the edge starting from this point.
 Zero in case of connection polygons
 Gap thickness of the riser below leading edges
 Gap thickness of the riser above trailing edges
 Zero in case of other edges
 [n][14] – Cantilevered structure horizontal thickness (read from its ac_stairStructureHorizThick parameter) at the edge starting from this point.
 Zero in case of connection polygons
 Horizontal thickness of the cantilevered structure below leading edges
 Horizontal thickness of the cantilevered structure above trailing edges
 Zero in case of other edges
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of structure polygons points of the current flight/landing.
 [n][1] – polygon type of node n in the structure polygon: core or connection polygon
 [n][2] – indicates which side node n belongs to: left or right structure polygon where the divide is the centerline of the stair: 0 – left, 1 – right
 [n][3] – type of edge starting from node n. Possible values: 0 – leading edge, 1 – trailing edge, 2 – left edge, 3 – right edge, 4 – centerline edge, 1 – end edge.
values:
1:
No Connection (Whole Tread) Polygon: in case of landing, all points are in this category. No such value in case of flight polygons.
0:
No Connection (Core) Polygon: in case of landing, startend connections may affect the geometry. In case of flight, the polygon is always complete.
1:
Start Connection Polygon: indicates the leftover polygon, or the enclosed polygon between core and connection polygons. Nodes necessary to define beampath: startpoint or endpoint with boundary polygon points.
2:
Start Connection Position Polygon: indicates the position of the connection. This polygon is always a generic unit polygon, not part of beampath, and only necessary for the cutting plane and end plate position.
3:
Start Connection Break Polygon: indicates the polygon containing the breakpoints in case of a vertical or horizontal connection. Points necessary for beampath: startpoint or endpoint completed with boundary polygon points.
4:
Start Connection Direction Polygon: indicates the polygon needed to do the bisector cut in case of a bisector connection. This polygon is always a generic unit polygon, not part of beampath, and only necessary to get the cutting plane position.
5:
Start Connection Extension Polygon: indicates points of beam extension to support cuttings. Points necessary for beampath: startpoint or endpoint completed with boundary polygon points
6:
Start Connection Structure Border Polygon: indicates the beamboundary points at start. This polygon is always a generic unit polygon. Points necessary for beampath: startpoint or endpoint.
101:
End Connection Polygon: indicates the leftover polygon, or the enclosed polygon between core and connection polygons. Nodes necessary to define beampath: startpoint or endpoint with boundary polygon points.
102:
End Connection Position Polygon: indicates the position of the connection. This polygon is always a generic unit polygon, not part of beampath, and only necessary for the cutting plane and end plate position.
103:
End Connection Break Polygon: indicates the polygon containing the breakpoints in case of a vertical or horizontal connection. Points necessary for beampath: startpoint or endpoint completed with boundary polygon points.
104:
End Connection Direction Polygon: indicates the polygon needed to do the bisector cut in case of a bisector connection. This polygon is always a generic unit polygon, not part of beampath, and only necessary to get the cutting plane position.
105:
End Connection Extension Polygon: indicates points of beam extension to support cuttings. Points necessary for beampath: startpoint or endpoint completed with boundary polygon points.
106:
End Connection Structure Border Polygon: indicates the beamboundary points at end. This polygon is always a generic unit polygon. Points necessary for beampath: startpoint or endpoint.
STAIR_STRUCTURE_CONN_OFFSETS 
array with two dimensions ([2][6]). Contains data of connection offset points. 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
 [1][1] – Start connection horizontal offset (dx)
 [1][2] – Start connection vertical offset (dy)
 [1][3] – Start connection horizontal offset 2 (dx1)
 [1][4] – Start connection vertical offset 2 (dy1)
 [1][5] – Start connection horizontal offset (cx)
 [1][6] – Start connection vertical offset (cy)
 [2][1] – End connection horizontal offset (dx)
 [2][2] – End connection vertical offset (dy)
 [2][3] – End connection horizontal offset 2 (dx1)
 [2][4] – End connection vertical offset 2 (dy1)
 [2][5] – End connection horizontal offset (cx)
 [2][6] – End connection vertical offset (cy)
STAIR_STRUCTURE_CONN_FLAGS 
array with two dimensions ([2][3]). Contains additional data of the structure connection. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
 [1][1] – Start connection type: 0 – vertical cut, 1 – Horizontal cut, 2 – cutout, 3 – vertical and horizontal cut, 4 – horizontal connection, 5 – horizontal connection and cutout, 6 – vertical connection, 7 – bisector, 8 – automatic.
 [1][2] – Start connection role: 0 – run and start, 1 – run and landing, 2 – landing and run, 3 – run and run, 4 – run and end, 5 – landing and landing.
 [1][3] – Tread or riser by start: 0 – riser by start, 1 – tread by start.
 [2][1] – End connection type: 0 – vertical cut, 1 – Horizontal cut, 2 – cutout, 3 – vertical and horizontal cut, 4 – horizontal connection, 5 – horizontal connection and cutout, 6 – vertical connection, 7 – bisector, 8 – automatic.
 [2][2] – End connection role: 0 – run and start, 1 – run and landing, 2 – landing and run, 3 – run and run, 4 – run and end, 5 – landing and landing.
 [2][3] – Tread or riser by end: 0 – riser by end, 1 – tread by end.
STAIR_STRINGER_PATH_OFFSET 
contains the value set in “Height above Treads” in Stair Settings dialog. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Railing component parameters
General railing variables – available for listing and labels
Compatibility: introduced in ARCHICAD 21.
RAILING_HEIGHT 
height of the railing segment (as set in Railing Settings Dialog / Segment Settings) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_3DLENGTH 
full 3D length of the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_HORIZONTAL_LENGTH 
full projected 2D length of the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_VOLUME 
volume of the railing (including all subelements) 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_NR_OF_SEGMENTS 
number of segments in the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_NR_OF_POSTS 
number of posts in the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_NR_OF_BALUSTERS 
number of balusters in the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_NR_OF_PANELS 
number of panels in the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
RAILING_NR_OF_RAILS 
number of rails in the railing 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
Railing 3D variables
Compatibility: introduced in ARCHICAD 21.
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with one dimension ([2]), horizontal offsets of rail element from railing reference line.
 [1] – offset of segment reference line from the railing reference line
 [2] – offset of panel element from the segment reference line (always 0 in case of inner post, post or toprail)
RAIL_CONNECTING_POSTS_NUM 
number of posts and inner posts intersecting the rail. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
array with two dimensions ([n][2]), where n is the number of posts or inner posts along the rail. Contains position data of these intersecting elements.
 [n][1] – position of posts and inner posts along the rail. Position values are calculated proportionally regarding the rail length (values are between 01)
 [n][2] – skew value of post or inner post (similar as in the case of panel). Corner element values may differ from inbetween elements’.
RAIL_TYPE 
contains the subelement type the current library part is selected for. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
 1 – toprail (or toprail end)
 2 – handrail (or handrail end)
 3 – rail (or rail end)
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][5]), where n is the number of railing nodes (n > 2). Contains geometric data of the current railing, all segments.
 [n][1] – coordinate x of railing node
 [n][2] – coordinate y of railing node
 [n][3] – coordinate z of railing node
 [n][4] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
 [n][5] – rotation of the crosssection for TUBE command. The rotation of automatically extended twisted railing connections may differ from slant value.
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with one dimension ([n]), here n is the number of railing nodes (n > 2). Contains geometric data of the current railing, all segments.
Identifies the segment the node belongs to by index, in acordance with RAIL_POLYLINE_GEOMETRY. Nodes in the same segment belong together.
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([2][4]), defines the orientation of the end surfaces of the rail
The returned coordinates can be used in TUBE command for first and last path coordinates as is. Items of [1][n] belong to the starting vertex, while [2][n] sets coordintes of the ending vertex.
 [1][1] – coordinate x
 [1][2] – coordinate y
 [1][3] – coordinate z
 [1][4] – boolean, cutting method: 0 – continuous edges, 1 – mittered cut
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([2][4]), defines the orientation of the end surfaces in case of disconnected connection.
The returned coordinates can be used in TUBE command for first and last path coordinates as is. Items of [1][n] belong to the end vertex of the first segment, while [2][n] sets coordintes at the starting vertex of the second segment.
 [1][1] – coordinate x
 [1][2] – coordinate y
 [1][3] – coordinate z
 [1][4] – 0 (reserved for future development)
Compatibility: introduced in ARCHICAD 22.
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with one dimension ([3]), contains additional information about the rail.
Boolean type to indicate the need/presence of fixings, caps.
 [1] – presence of fixings needed (none for connections or extensions)
 [2] – presence of opening caps needed (start of rail, or connceted to another)
 [3] – presence of closing caps needed (end of rail, or connceted to another)
RAIL_SLANT_ANGLE 
rail slant angle in degrees relative to vertical direction, perpendicular to walking direction. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
positive:
slanting to the left relative to walking direction
negative:
slanting to the right relative to walking direction
Curved sections: the angle is measured on a vertical, radial plane.
RAILINGPANEL_TYPE 
generic geometry type of the panel. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
 1 – planar
 2 – cylindrical (curved – vertical or curved – skewed)
 3 – conic (curved – horizontal – slanted)
 4 – twisted (curved – inclined – slanted or curved – slanted – skewed)
RAILINGPANEL_UNCUT_GEOMETRY 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][4]), where n is the number of panel nodes (n > 3). Contains geometric data of the current railing panel, complete raw geometry (without cuts).
 [n][1] – coordinate x of railing panel node
 [n][2] – coordinate y of railing panel node
 [n][3] – coordinate z of railing panel node
 [n][4] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
 [n][5] – in case of a cut edge, contains the cutting plane angle (0 – perpendicular to panel). In case of a curved panel, the reference plane is tangential.
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][5]), where n is the number of panel nodes (n > 3). Contains geometric data of the current railing panel, cutting planes applied.
 [n][1] – coordinate x of railing panel node
 [n][2] – coordinate y of railing panel node
 [n][3] – coordinate z of railing panel node
 [n][4] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
 [n][5] – in case of a cut edge, contains the cutting plane angle (0 – perpendicular to panel). In case of a curved panel, the reference plane is tangential.
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of panel nodes (n > 3) in accordance with RAILINGPANEL_GEOMETRY. Contains geometric data of the current railing panel edges, cutting planes applied.
 [n][1] – segment number of edge starting from node in the uncut panel
 [n][2] – position of the edge starting from node in the cut panel (indexing according to RAILINGPANEL_SIDE_OFFSETS)
 [n][3] – status bit of edge
mask:
[n][3] possible values
j_{1}:
edge starting from node connected to another panel
j_{2}:
edge starting from node is cut
RAILINGPANEL_SIDE_OFFSETS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of panel nodes (n > 3) in accordance with RAILINGPANEL_GEOMETRY. Contains geometric data of the current railing panel edges, cutting planes applied
 [1] – bottom offset
 [2] – end vertex side offset
 [3] – top offset
 [4] – starting vertex side offset
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
slant angle in degrees, perpendicular to walking direction. Vertical is 0 degrees, positive values mean left side, negative values mean right side of walking direction (angle < 90). Curved segments: measured on plane perpendicular to the start tangential plane of the segment (before skewing).
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
skew angle in degrees, parallel to walking direction. Vertical is 0 degrees, positive values mean backward, negative values mean forward skewing according to walking direction (angle < 90). Curved segments: measured on the start tangential plane of the segment (before slanting).
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
skew angle in degrees, parallel to walking direction. Vertical is 0 degrees, positive values mean backward, negative values mean forward skewing according to walking direction (angle < 90). Curved segments: measured on the start tangential plane of the segment (before slanting).
RAILINGPOST_TYPE 
contains the subelement type the current library part is selected for. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
 1 – post
 2 – inner post
 3 – baluster
RAILINGPOST_TOP_COORD 
array with one dimension ([3]), coordinates of the top of the current post 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0, 0, 0] 
 [1] – coordinate x
 [2] – coordinate y
 [3] – coordinate z
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([2][3]), defines the orientation of the end surfaces of the post
The returned coordinates can be used in TUBE command for first and last path coordinates as is. Items of [1][n] belong to the base vertex, while [2][n] sets coordintes of the top vertex.
 [1][1] – coordinate x
 [1][2] – coordinate y
 [1][3] – coordinate z
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([2][4]), contains the vector parameters of two planes used to cut inner posts and balusters at the boundary of the segment, when the railing is slanted
The normal of the plane is vector (A; B; C), and D is its distance from the origin, measured in the direction of the normal. The model should be cut in the direction of the normal.
In case of all 0 return values for any of the 2 planes, the plane does not exist (no cut).
 [1][1] – A
 [1][2] – B
 [1][3] – C
 [1][4] – D
RAILINGEND_DIRECTION_AND_ANGLE 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
RailingGlobalsGeneral_section
array with two dimensions ([n][5]), vector data pointing away from the connecting rail in a tangential direction. For two ends of a straight rail, these vectors are opponent in direction.
 [n][1] – coordinate x of vector
 [n][2] – coordinate y of vector
 [n][3] – coordinate z of vector
 [n][4] – rotation of the connecting rail around the vector’s axis, withRailingGlobalsGeneral_section the effect of slanting. The railend should model the same rotation to connect seamlessly.
Railing 2D variables
Compatibility: introduced in ARCHICAD 21.
Railing component parameters
RAIL2D_FULL_POLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end axis polyline. Contains geometric data of the railing panel.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_FULL_POLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end axis polyline. Contains visibility data of edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end symbol polygon. Contains geometric data of the railing panel.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_FULL_POLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end symbol polygon. Contains visibility data of edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
RAIL2D_FULL_VISIBILITY 
type of the active attribute set of the current railing drawing. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
1:
‘Visible’ attribute set is in effect
0:
‘Hidden’ attribute set is in effect
RAIL2D_CUSTOMDISPLAY 
contains information about the model view settings of the railing. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
0:
railing is displayed according to Model View Option settings
1:
railing is displayed with custom settings
The following globals are used to define the parts of the railing represented below the first breakmark.
RAIL2D_LOWER_POLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end axis polyline below the first breakmark. Contains geometric data of the railing panel polyline.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_LOWER_POLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end axis polyline below the first breakmark. Contains visibility data of edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
RAIL2D_LOWER_POLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end symbol polygon below the first breakmark. Contains geometric data of the railing panel polygon.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_LOWER_POLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end symbol polygon below the first breakmark. Contains visibility data of polygon edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
RAIL2D_LOWER_VISIBILITY 
type of the active attribute set of the current railing drawing below the first breakmark. 
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
values:
1:
‘Visible’ attribute set is in effect
0:
‘Hidden’ attribute set is in effect
The following globals are used to define the parts of the railing represented between two breakmarks.
RAIL2D_MIDDLE_POLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end axis polyline between breakmarks. Contains geometric data of the railing panel polyline.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_MIDDLE_POLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end axis polyline between breakmarks. Contains visibility data of edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
RAIL2D_MIDDLE_POLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end symbol polygon between breakmarks. Contains geometric data of the railing panel polygon.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_MIDDLE_POLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end symbol polygon between breakmarks. Contains visibility data of polygon edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
type of the active attribute set of the current railing drawing between breakmarks.
values:
1:
‘Visible’ attribute set is in effect
0:
‘Hidden’ attribute set is in effect
The following globals are used to define the parts of the railing represented above the last breakmark.
RAIL2D_UPPER_POLYLINE_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end axis polyline above the last breakmark. Contains geometric data of the railing panel polyline.
 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_UPPER_POLYLINE_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end axis polyline above the last breakmark. Contains visibility data of edges.


 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
RAIL2D_UPPER_POLYGON_GEOM 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][3]), where n is the number of points in the panel/rail/rail end symbol polygon above the last breakmark. Contains geometric data of the railing panel polygon.


 [n][1] – coordinate x of node measured from railing origin
 [n][2] – coordinate y of node measured from railing origin
 [n][3] – central angle of edge starting from the node (0 – straight, > 0 – curved counterclockwise, < 0 – curved clockwise)
RAIL2D_UPPER_POLYGON_FLAGS 
2D 

3D 

UI 

Parameter 

Property 

Default 
[0] 
array with two dimensions ([n][1]), where n is the number of points in the panel/rail/rail end symbol polygon above the last breakmark. Contains visibility data of polygon edges.
 [n][1] – visibility flag of edge starting at node n (0 – not visible, 1 – visible)
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
type of the active attribute set of the current railing drawing above the last breakmark.
values:
1:
‘Visible’ attribute set is in effect
0:
‘Hidden’ attribute set is in effect
The following global belongs to the 2D representation of railing posts.
2D 

3D 

UI 

Parameter 

Property 

Default 
0 
type of the active attribute set of the current post drawing.
values:
1:
‘Visible’ attribute set is in effect
0:
‘Hidden’ attribute set is in effect