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.

Objects on Floor Plan

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

ac_special_2d_symbol boolean
This parameter enables a 2D cutting mechanism in floor plan. If the parameter is set to 1, 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 with the same settings.
Naturally, this method gives correct output for plane-like elements 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. In case of Skylight and Roof Accessory elements – if ac_special_2d_symbol is 1 -, the above parameters are set by the add-on automatically. In case of other elements, they should be filled in by the library developer.
ac_plane_definition 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
ac_bottomlevel length
This parameter indicates the lowest point of the object. When Show on Stories is set to All Relevant Stories, if this lowest point (calculated from the object’s home story settings) is contained in a story’s vertical extension, the object is displayed on the story. Top level has to be above the bottom level.
ac_bottomlevel measured from the object origin of the object.
ac_toplevel length
When Show on Stories is set to All Relevant Stories this parameter tells the top of the object. The object will be visible on a story if the story’s height is between the bottomlevel and the toplevel. Top level has to be above the bottom level.
ac_toplevel measured from the object origin of the object.

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 settings dialog is hidden.
If j2 is set, the reveal settings in the settings dialog are disabled.
ac_wido_flip_once boolean
Flips the window or door once after the execution of the migration script if the parameter is present and its value is
true.
ac_wido_flip_disable integer
This parameter can disable the “Flip” button on the user interface. The default value affects only the placing of the object.
-1: Flip is enabled.
0: Flip is disabled. The default is not flipped.
1: Flip is disabled. The default is flipped.
ac_wido_mirror_once boolean
Mirrors the window or door once after the execution of the migration script if the parameter is present and its value is true.
ac_hole_hotspot_control integer
Controls whether openings have automatic hotspots.
0 – No automatic hotspots, 1 – Only in 2D, 2 – Only in 3D, 3 – Everywhere

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,
sets the A size as the distance between the frames plus the clamps’ size.
Otherwise, the A size is measured between the frames.

Custom Component Template

ac_custom_component_type_name string
This parameter contains the name of the Custom Component Template which is displayed on the “Save Component As…” menu.
It can differ from the object name.

Zone Stamp parameters

ac_disable_controls integer
This parameter controls the visibility of the Font Size input area of the Zone Stamp settings dialog: 0 or the object doesn’t have the parameter – show Font Size, 1 – hide Font Size (therefore allowing extra space for the parameter list)

Label parameters

ac_bDisableLabelFrameDisplay boolean
Compatibility: Introduced in ARCHICAD 20
Hides the built-in rectangular frame drawing around the Label Symbol in case of the built-in Pointer and Frame is set, enabling the user to script custom shaped frame.
ac_bCustomPointerConnection boolean
Compatibility: Introduced in ARCHICAD 20
Controls the automatic Pointer Connections of the Label Symbol in case of the built-in Pointer is set. If this parameter is set to ON, 6 hotspots can be defined in the 2D script for the custom pointer connection in accordance with the built-in types.
These hotspots should have fix ID-s from 1 to 6. The ID’s indicate the following connection positions:
if the Pointer is on the left side of the Label Symbol:

  • 1: left top connection
  • 3: left middle connection
  • 5: left bottom connection
  • 6: right bottom connection

if the Pointer is on the right side of the Label Symbol:

  • 2: right top connection
  • 4: right middle connection
  • 6: right bottom connection
  • 5: left bottom connection

FOP_LabelPointerPos
FOP_LabelHotspots

The hostpot positions must be symmetrical to the vertical axis of the label symbol to support auto position snap (left-right direction).

Stair related parameters

ac_RiserPosition integer
This parameter reflects the current settings of riser and tread connections:

  • 0 – Riser on Tread OFF
  • 1 – Riser on Tread ON
ac_stairStructureWidth length
Width of the structure stringer, as set in the Stair Settings. Value is 0 for beam structure type.
ac_stairStructureThickness length
Thickness/height of the structure beam, as set in the Stair Settings.
ac_beamProfileID integer
Index of the selected profile used for the structure beam. ARCHICAD provides the boundingbox size of the profile by the means of request options.

Railing related parameters

ac_panelThickness length
Thickness of panel section in the railing. Parameter value should be kept consistent with the model size via Parameter script.
ac_railWidth length
Absolute width of the rail section mesured on a plane perpendicular to rail axis. Parameter value should be kept consistent with the model size via Parameter script.
ac_railHeight length
Absolute height of the rail section mesured on a plane perpendicular to rail axis. Parameter value should be kept consistent with the model size via Parameter script.
ac_rail_boundingbox_left length
Relative distance of the rail section bounding box left side measured from the rail section axis (RAIL_POLYLINE_GEOMETRY), on a plane perpendicular to rail axis, looking in the direction of the rail. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_rail_boundingbox_right length
Relative distance of the rail section bounding box right side measured from the rail section axis (RAIL_POLYLINE_GEOMETRY), on a plane perpendicular to rail axis, looking in the direction of the rail. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_rail_boundingbox_top length
Relative distance of the rail section bounding box top measured from the rail section axis (RAIL_POLYLINE_GEOMETRY), on a plane perpendicular to rail axis, looking in the direction of the rail. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_rail_boundingbox_bottom length
Relative distance of the rail section bounding box bottom measured from the rail section axis (RAIL_POLYLINE_GEOMETRY), on a plane perpendicular to rail axis, looking in the direction of the rail. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_railProfileID integer
Index of the selected profile used for the rail. ARCHICAD provides the boundingbox size of the profile by the means of request options.
ac_postWidth length
Absolute width of the post section mesured on a plane perpendicular to post axis. Parameter value should be kept consistent with the model size via Parameter script.
ac_postHeight length
Absolute height of the post section mesured on a plane perpendicular to post axis. Parameter value should be kept consistent with the model size via Parameter script.
ac_post_boundingbox_left length
Relative distance of the post section bounding box left side measured from the post section axis, on a plane perpendicular to post axis, left means the direction of the beginning of the reference line, looking from the inside. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_post_boundingbox_right length
Relative distance of the post section bounding box right side measured from the post section axis, on a plane perpendicular to post axis, right means the direction of the end of the reference line, looking from the inside. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_post_boundingbox_inside length
Relative distance of the post section bounding box measured horizontally from the post section axis, on a plane perpendicular to post axis, inside meaning the side a right-side handrail is placed on. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_post_boundingbox_outside length
Relative distance of the post section bounding box measured horizontally from the post section axis, on a plane perpendicular to post axis, outside meaning the opposite side a right-side handrail is placed on. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_postProfileID integer
Index of the selected profile used for the post. ARCHICAD provides the boundingbox size of the profile by the means of request options.
ac_railendWidth length
Absolute width of the railend section mesured on a plane perpendicular to railend axis. Parameter value should be kept consistent with the model size via Parameter script.
ac_railendHeight length
Absolute height of the railend section mesured on a plane perpendicular to railend axis. Parameter value should be kept consistent with the model size via Parameter script.
ac_railend_boundingbox_left length
Relative distance of the rail section bounding box left side measured from the railend section axis, on a plane perpendicular to railend axis, looking in the direction of the railend. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_railend_boundingbox_right length
Relative distance of the railend section bounding box right side measured from the railend section axis, on a plane perpendicular to railend axis, looking in the direction of the railend. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_railend_boundingbox_top length
Relative distance of the railend section bounding box top measured from the railend section axis, on a plane perpendicular to railend axis, looking in the direction of the railend. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_railend_boundingbox_bottom length
Relative distance of the railend section bounding box bottom measured from the railend section axis, on a plane perpendicular to railend axis, looking in the direction of the railend. Parameter value should be kept consistent with the model size via Parameter script. Used for section bounding box offset of the component axis.
ac_railendProfileID integer
Index of the selected profile used for the railend. ARCHICAD provides the boundingbox size of the profile by the means of request options.