Appendix A - Fix named optional parameters

1. Parameters set by ArchiCAD

The new method of ArchiCAD for providing information is the method of optional parameters. If a given library part has a parameter with a name and type matching any optional parameter, ArchiCAD® sets its value according to its function.

1.1. Parameters for D/W attributes (available for Door, Window, Label, Listing)

Floor plan display

ac_hole_cut_linetype - linetype

pen of cut lines [floor plan and section]

ac_hole_overhead_pen - pen

pen of the above view edges (overhead) [floor plan only]

ac_hole_overhead_linetype - linetype

line type of the above view edges (overhead) [floor plan only]

ac_hole_uncut_pen - pen

pen of the below view edges (uncut) [floor plan only]

ac_hole_uncut_linetype - linetype

line type of the below view edges (uncut) [floor plan only]

ac_hole_display_option - integer

floor plan display option: 1 - Projected, 2 - Projected with Overhead, 3 - Symbolic, 5 - Overhead All

Direction

ac_hole_direction_type - integer

vertical anchor of D/W: 1 - Associated to Wall, 2 - Vertical

ac_wido_rotation - angle

door/window rotation angle relative to the horizontal cut plane

Polygonal wall data

ac_walltype - integer

tells whether the window is in a polygonal wall or not. 1 - non polygonal, 2 - polygonal.

ac_wallContourPolygon[][3] - length

The polygon of the wall in 2D points plus an extra angle value for arc sections. [set only if ac_walltype equals 2]

ac_windowInWallContour[4] - integer

Indices of the four vertices of the ac_wallContourPolygon polygon being in the wall contour polygon as window corner points. [set only if ac_walltype equals 2]

Hole position

ac_hole_position_angle - angle

In case of curved walls it gives the angle between the axis of the opening and the normal vector at the wall's starting point.

1.2. Parameters for WALL attributes (available for Door, Window, Label, Listing)

Floor plan display

ac_wall_overhead_pen - pen

pen of the above view edges of the wall (overhead) [floor plan only]

ac_wall_overhead_linetype - linetype

line type of the above view edges of the wall (overhead) [floor plan only]

ac_wall_uncut_linetype - linetype

line type of the below view edges of the wall (uncut) [floor plan only]

ac_wall_display_option - integer

floor plan display option of the wall: 1 - Projected, 2 - Projected with Overhead, 3 - Symbolic, 4 - OutLines Only, 5 - Overhead All

ac_wall_show_projection_to - integer

vertical view depth limitation of the wall: 1 - To Floor Plan Range, 2 - To Absolute Display Limit, 3 - Entire Element

Geometric data

ac_wall_elevation - length

elevation of the wall bottom, relative to home story of the wall

ac_wall_crosssection_type - integer

wall cross section type: 1 - Simple, 2 - Complex, 3 - Slanted, 4 - Trapezoid

ac_wall_profile_name - string

profile name if the wall is complex with profile attribute, "Custom_Profile_i" if complex with custom profile (i being the id of the placed wall) or "n/a" if the wall is simple, slanted or trapezoid

ac_wall_slant_angle1 - angle

first slant angle of the wall relative to the horizontal (90 degrees if the wall is vertical)

ac_wall_slant_angle2 - angle

second slant angle of the wall relative to the horizontal (90 degrees if the wall is vertical)

ac_wall_direction_type - integer

wall direction type; the construction method of the wall actually, which means the adjustment of the wall body and the reference line: 0 - Right, 1 - Left, 2 - Center (Right), 3 - Center (Left). Center values mean that the wall is set to 'Center' in the user interface, but the side notation shows how the wall acts internally.

1.3. Parameters for COLUMN attributes (available for Label, Listing)

Floor plan display

ac_colu_overhead_pen - pen

pen of the above view edges of the column (overhead) [floor plan only]

ac_colu_overhead_linetype - linetype

line type of the above view edges of the column (overhead) [floor plan only]

ac_colu_uncut_linetype - linetype

line type of the below view edges of the column (uncut) [floor plan only]

ac_colu_display_option - integer

floor plan display option of the column: 1 - Projected, 2 - Projected with Overhead, 3 - Symbolic, 4 - OutLines Only, 5 - Overhead All

ac_colu_show_projection_to - integer

vertical view depth limitation of the column: 1 - To Floor Plan Range, 2 - To Absolute Display Limit, 3 - Entire Element

Geometric data

ac_colu_crosssection_type - integer

column cross section type: 1 - Rectangular, 2 - Round, 3 - Complex

ac_colu_profile_name - string

profile name if the column is complex with profile attribute, "Custom_Profile_i" if complex with custom profile (i being the id of the placed column) or "n/a" if the column is rectangular or round

ac_colu_inclination - angle

inclination angle of the column relative to the horizontal line

ac_colu_twist_angle - angle

twist angle of the cross section

1.4. Parameters for BEAM attributes (available for Label, Listing)

Floor plan display

ac_beam_overhead_pen - pen

pen of the above view edges of the beam(overhead) [floor plan only]

ac_beam_overhead_linetype - linetype

line type of the above view edges of the beam (overhead) [floor plan only]

ac_beam_uncut_pen - pen

pen of the below view edges of the beam (uncut) [floor plan only]

ac_beam_uncut_linetype - linetype

line type of the below view edges of the beam (uncut) [floor plan only]

ac_beam_display_option - integer

floor plan display option of the beam: 1 - Projected, 2 - Projected with Overhead, 3 - Symbolic, 4 - OutLines Only, 5 - Overhead All

ac_beam_show_projection_to - integer

vertical view depth limitation of the beam: 1 - To Floor Plan Range, 2 - To Absolute Display Limit, 3 - Entire Element

Geometric data

ac_beam_crosssection_type - integer

beam cross section type: 1 - Rectangular, 2 - Complex

ac_beam_profile_name - string

profile name if complex with profile attribute, "Custom_Profile_i" if complex with custom profile (i being the id of the placed beam) or "n/a" if the beam is rectangular

ac_beam_inclination - angle

inclination angle of the beam relative to the horizontal line

ac_beam_twist_angle - angle

twist angle of the cross section (0.0 for non-complex beams)

1.5. Parameters for ROOF attributes (available for Label, Listing)

Floor plan display

ac_roof_overhead_pen - pen

pen of the above view edges of the roof (overhead) [floor plan only]

ac_roof_overhead_linetype - linetype

line type of the above view edges of the roof (overhead) [floor plan only]

ac_roof_display_option - integer

floor plan display option of the roof: 1 - Projected, 2 - Projected with Overhead, 3 - Symbolic, 4 - OutLines Only, 5 - Overhead All

ac_roof_show_projection_to - integer

vertical view depth limitation of the roof: 1 - To Floor Plan Range, 2 - To Absolute Display Limit, 3 - Entire Element

1.6. Door/Window Marker attributes

ac_wido_id - string

ID of the opening

ac_wido_a_size - length

opening width

ac_wido_b_size - length

opening height

ac_wido_z_size - length

opening depth/thickness

ac_glob_elevation - length

elevation of the base line of the opening

ac_wido_subfl_thickness - length

height of the subfloor wall part

ac_wido_reveal_side - boolean

legacy opening reveal side value, use ac_wido_reveal_side_2 instead

ac_wido_reveal_side_2 - boolean

reveal side, the value of the WIDO_REVEAL_SIDE global variable set for the opening

ac_wido_mirrored - boolean

mirrored state of the opening

ac_wall_thickness - length

thickness of the wall at the origin of the opening

ac_wido_oversize_l - length

left opening oversize

ac_wido_oversize_r - length

right opening oversize

ac_wido_oversize_t - length

top opening oversize

ac_wido_oversize_b - length

bottom opening oversize

ac_wido_orientation - string

marker position: "L" - Left, "R" - right, or any custom value set in the Details window of the library part editor according to the current mirrored state

ac_wido_type - integer

1 - Door, 2 - Window

ac_symb_rotangle - angle

opening rotation in the wall

ac_sill_to_curr_story - length

sill height of the opening measured from the start of the current storey; the current storey is the storey, in which the sill actually is

ac_sill_to_anchor_level - length

sill height of the opening measured from the level of the anchor point; the anchor point may be the bottom of the wall or the selected storey, accordingly

1.7. Detail/Worksheet Marker attributes

ac_showboundary - boolean

Marker boundary polygon state. 0 - boundary off, 1 - boundary on.

1.8. Curtain wall accessory attributes

ac_frameWidthLeft - length

Reference frame contour width 1 (usually a/2)

ac_frameWidthRight - length

Reference frame contour width 2 (usually a/2)

ac_frameWidthFront - length

Reference frame contour length 1 (usually b/2)

ac_frameWidthBack - length

Reference frame contour length 2 (usually b/2)

ac_accessoryFlipped - boolean

Accessory flipped state. 0 - not flipped, 1 - flipped

ac_globalZDir - length, array

Vector of local z direction in the global coordinate system

ac_validCellAngle1 - boolean

Defines if there is cell 1 or not

ac_validCellAngle2 - boolean

Defines if there is cell 2 or not

ac_cellAngle1 - angle

The accesory's frame can be connected to maximum 2 cells. These cell are cell1 and cell2. Cell1 is the cell with the smaller angle from local Y direction, considering the positive direction of local X. Parameter ac_cellAngle1 is the angle between cell1 and local Y direction.

ac_cellAngle2 - angle

The accesory's frame can be connected to maximum 2 cells. These cell are cell1 and cell2. Cell2 is the cell with the greater angle from local Y direction, considering the positive direction of local X. Parameter ac_cellAngle2 is the angle between cell2 and local Y direction.

1.9 Drawing Title attributes

ac_drawingName - string

Name of the drawing.

ac_drawingNumber - string

ID of the drawing.

ac_sourceFileName - string

Name of the drawing source file (if the drawing comes from an external file).

ac_sourceFilePath - string

Path of the drawing source file (if the drawing comes from an external file).

ac_drawingScale - string

Drawing scale set for the drawing.

ac_magnification - real number

Magnification percentage set for the drawing.

ac_originalDrawingScale - string

Drawing scale of the originating view.

ac_enableBackReference - boolean

Back referencing is enabled for the drawing.

ac_backReferenceGUIDList - string array

List of referred layout GUIDs. They can be used in autotext text outputs.

ac_showDrawingReferences - bool

Show back references.

1.10 General running context

ac_programVersion - integer

This parameter contains the version of ArchiCAD executing the library part's scripts.

2. Parameters read by ArchiCAD

ArchiCAD can get values from library parts through parameters with predefined name and function. The list of such parameters follows below.

2.1. Objects on Floor Plan

Floor plan cutting of planar elements (i.e. skylight object, roof accesory objects)

ac_special_2d_symbol - boolean

This parameter enables a 2D cutting mechanism in ArchiCAD floor plan. If the parameter is set to 1, ArchiCAD cuts the 2D model (generated by the 2D script of the libpart) according to the parameter values in: ac_symb_display_option, ac_symb_show_projection_to and ac_plane_definition. This 2D-based cut works like the display of simple roofs under the same settings. Naturally, this method gives correct output for plane-like element only - like skylights and roof accessories. The plane of the flat object - and the plane of the cut - is defined by the parameter ac_plane_definition. For Skylight and Roof Accessory elements - if ac_special_2d_symbol is 1 -, the above parameters are set by the add-on automatically. For other elements the library developer should fill in the parameters.

ac_plane_definition[6] - length

Plane definition: ([1],[2],[3]): a point on the plane, ([4],[5],[6]): normal vector of the plane.

ac_symb_display_option - integer

1 - Projected, 2 - Projected with Overhead, 3 - Symbolic, 4 - OutLines Only, 5 - Overhead All

ac_symb_show_projection_to - integer

1 - To Floor Plan Range, 2 - To Absolute Display Limit, 3 - Entire Element

2.2. Door/Window objects

ac_wido_sill - length

This parameter provides full access to the sill depth of the opening object. The parameter can get a value list, it can be locked and hidden and its value can be set via the parameter script. Its current value will be assigned to the WIDO_SILL global variable for compatibility with older scripts.

ac_wido_hide_options - integer

Via this bitfield parameter you can disable options from the window/door settings dialog. ac_wido_hide_options = j1 + 2*j2. If j1 is set, the sill depth inputs on the default ArchiCAD settings dialog is hidden. If j2 is set, the reveal settings in the settings dialog are disabled.

2.3. Curtain wall panel attributes

ac_originIsFrameCenter - boolean

If the parameter is present and its value is true, the panel origin is in the center point of the starting (left) frame. Otherwise, the origin is in the starting point of the left clamp.

ac_aSizeIsWithClamp - boolean

If the parameter is present and its value is true, ArchiCAD sets the A size as the distance between the frames plus the clamps' size. Otherwise, the A size is measured between the frames.

3. Parameters for add-ons

Add-ons can get values from library parts through parameters with predefined name and function. The list of such parameters in connection of the AC-package add-ons follow below.

3.1. Parameters of Skylight add-on

Hole edge cut manipulation

ac_edge_lower_type - integer

Cut type of the lower edge: 0 - Vertical, 1 - Perpendicular, 2 - Horizontal, 3 - Custom

ac_edge_lower_angle - angle

Angle of the cut of the lower edge, if ac_edge_lower_type is 3. The value range is [1-179] degrees, 90 is the perpendicular case.

ac_edge_upper_type - integer

Cut type of the upper edge: 0 - Vertical, 1 - Perpendicular, 2 - Horizontal, 3 - Custom

ac_edge_upper_angle - angle

Angle of the cut of the upper edge, if ac_edge_upper_type is 3. The value range is [1-179] degrees, 90 is the perpendicular case.

3.2. Parameters of Corner Window add-on

Basic parameters of Corner Window objects

ac_cw_function - boolean

Window place mode, controlled by the add-on. 0 - Window, 1 - Corner window

ac_corner_window - boolean

Corner window mode selector, controlled by the object. 0 - Disable corner window mode, 1 - Enable corner window mode

ac_corner_angle - angle

Angle between the connected walls.

ac_diff_con_wall_thk - boolean

Always true (1). It is a historical feature showing whether the connecting wall has a different thickness from the containing wall.

ac_con_wall_thk - length

Thickness of the connected wall.

ac_cw_debug - boolean

For internal usage only. Aspect of GDL programmers have no interest.

Wall skins data parameters of Corner Window objects (available from ArchiCAD 12)

ac_con_wall_skins_number - integer

Nuber of skis in the connected wall. In case of solid walls it is zero.

ac_con_wall_skins_params[][15] - length

Parameters of the connected composite wall skins. Same as the WALL_SKINS_PARAMS GDL global parameter of the owner wall.

ac_con_wall_direction_type - integer

Connected wall direction type; the construction method of the wall actually, which means the adjustment of the wall body and the reference line: 0 - Right, 1 - Left, 2 - Center (Right), 3 - Center (Left). Center values mean that the wall is set to 'Center' in the user interface, but the side notation shows how the wall acts internally.