General Libpart Parameters

General element parameters

GLOB_LAYER layer of the element
name of the layer the element is assigned to
GLOB_ID user ID of the element
ID as set in the settings dialog box
GLOB_INTGUID internal GUID of the element
the internal GUID generated by the program (cannot be controlled by the user)
GLOB_ELEVATION base elevation of the element
  • door/window objects: sill height, according to current settings
  • slab: the elevation of the chosen reference plane of the slab, according to settings
  • wall/wall end: the elevation of the bottom of the wall (a profiled wall’s reference line elevation can be different, depending on the profile origin)
  • other elements/objects: the base elevation, according to settings
GLOB_ELEM_TYPE element type, for labels and property objects contains the type of the parent element
  • 0 – none (individual label)
  • 1 – object
  • 2 – lamp
  • 3 – window
  • 4 – door
  • 5 – wall
  • 6 – column
  • 7 – slab
  • 8 – roof
  • 9 – fill
  • 10 – mesh
  • 11 – zone
  • 12 – beam
  • 13 – curtain wall
  • 14 – curtain wall frame
  • 15 – curtain wall panel
  • 16 – curtain wall junction
  • 17 – curtain wall accessory
  • 18 – shell
  • 19 – skylight
  • 20 – morph
  • 21 – stair
  • 22 – stair tread
  • 23 – stair riser
  • 24 – stair structure
  • 25 – railing
  • 26 – opening
  • 27 – column segment
  • 28 – beam segment

Object, Lamp, Door, Window, Wall End, Skylight parameters

SYMB_LINETYPE line type of the library part
applied as the default line type of the 2D symbol
SYMB_FILL fill type of the library part
applied on cut surfaces of library parts in section/elevation windows
SYMB_FILL_PEN pen of the fill of the library part
applied on cut surfaces of library parts in section/elevation windows
SYMB_FBGD_PEN pen of the background of the fill of the library part
applied on cut surfaces of library parts in section/elevation windows
SYMB_SECT_PEN pen of the library part in section
applied on contours of cut surfaces of library parts in section/elevation windows
SYMB_VIEW_PEN default pen of the library part
applied on all edges in 3D window and on edges on view in section/elevation windows
SYMB_MAT default surface attribute index of the library part
SYMB_POS_X position of the library part (x)
relative to the project origin (excluding door, window and wall end: relative to the startpoint of the including wall)
SYMB_POS_Y position of the library part (y)
relative to the project origin (excluding door, window and wall end: relative to the startpoint of the including wall)
Note: see the section called “Doors and Windows” for orientation of Y and Z axes
SYMB_POS_Z position of the library part (z)
relative to the project origin (excluding door, window and wall end: relative to the startpoint of the including wall)
Note: see the section called “Doors and Windows” for orientation of Y and Z axes
SYMB_ROTANGLE rotation angle of the library part
numeric rotation from within the settings dialog is performed around the current anchor point
SYMB_MIRRORED library part mirrored
0-no, 1-yes (mirroring is performed around the current anchor point.)
Always 0 for wall ends, except when the origin of the local coordinate system is in a non-rectangular vertex of a trapezoidal wall’s polygon.
The mirrored state of a hotlink is not included, library parts in a module receive their mirrored state relative to the module (as in the original plan the module was saved from).

Object, Lamp, Door, Window, Wall End, Skylight, Curtain Wall Accessory parameters – available for listing and labels only

SYMB_A_SIZE nominal length/width of library part
length of object/lamp, width of window/door (fixed parameter), width of accessory
SYMB_B_SIZE nominal width/height of library parts
width of object/lamp, height of window/door (fixed parameter), height of accessory
SYMB_Z_SIZE nominal height/length of the library part
length of accessory or if a user parameter is named in zzyzx format then it will be used for nominal height, otherwise 0

Object parameters

SYMB_POS_FROM_SURVEY_POINT dictionary, position of the library part transformed into the Survey Point’s coordinate system
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default {0, 0, 0}

Calculated coordinates of the object’s position relative to the Survey Point of the project. Applied for objects placed on the floor plan or 3D model window, otherwise it is initialized to zero vector.
Compatibility: introduced in ARCHICAD 25.
{
“x”: 0.0,
“y”: 0.0,
“z”: 0.0
}

General environment information

GLOB_SCRIPT_TYPE type of current script
  • 1 – properties script
  • 2 – 2D script
  • 3 – 3D script
  • 4 – user interface script
  • 5 – parameter script
  • 6 – master script
  • 7 – forward migration script
  • 8 – backward migration script
GLOB_VIEW_TYPE type of current view (view dependent, do not use in parameter/property scripts).
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_WarningIcon Parameter GDL_WarningIcon Property GDL_ErrorIcon Default –
  • 2 – 2D (Floor Plan)
  • 3 – 3D
  • 4 – Section
  • 5 – Elevation
  • 6 – 3D Document
  • 7 – Detail
  • 8 – Layout
  • 9 – Calculation
Use the exact needed values. Using ranges are not recommended due to possible future value extensions.
GLOB_PREVIEW_MODE type of current preview (view dependent, do not use in parameter/property scripts)
  • 0 – None
  • 1 – Dialog
  • 2 – Listing
  • 3 – Favorite saving
Use the exact needed values. Using ranges are not recommended due to possible future value extensions.
GLOB_FEEDBACK_MODE indicates editing in progress (view dependent, do not use in parameter/property scripts
GLOB_SEO_TOOL_MODE indicates solid element operations in progress (view dependent, do not use in parameter/property scripts)
GLOB_DIAGNOSTICS_MODE Library Developer (59) menu command for GDL diagnostics
Compatibility: introduced in ARCHICAD 23.
  • 0 – off
  • 1 – on
Use in scripts as a conditional statement to visualize debug content of library parts.
GLOB_SCALE drawing scale (view dependent, do not use in parameter/property scripts) according to the current window
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 100
GLOB_DRAWING_BGD_PEN pen of the drawing background color (view dependent, do not use in parameter/property scripts)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 19

the best matching (printable) pen from the current palette to the background color of the current window

GLOB_FILL_INDEX_SOLID index of fill type “Solid” according to the template (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_CheckIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 19

contains the applied index of the fill type “Solid”
Compatibility: introduced in ARCHICAD 22.

GLOB_FILL_INDEX_BACKGROUND index of fill type “Background” according to the template (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_CheckIcon Parameter GDL_ErrorIcon Property GDL_ErrorIcon Default 19

contains the applied index of the fill type “Background”
Compatibility: introduced in ARCHICAD 22.

GLOB_NORTH_DIR project North direction (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 90
relative to the default project coordinate system according to the settings made in the Project Location dialog
GLOB_PROJECT_LONGITUDE project longitude (project dependent, do not use in parameter script)
GLOB_PROJECT_LATITUDE project latitude (project dependent, do not use in parameter script)
GLOB_PROJECT_ALTITUDE project altitude (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 0
the geographical coordinates of the project origin according to the settings specified in the Project Location dialog
GLOB_PROJECT_DATE project date (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default [0, 0, 0, 0, 0, 0]
array of the following six values:
  • 1 – year,
  • 2 – month,
  • 3 – day,
  • 4 – hour,
  • 5 – minute,
  • 6 – second.
This variable contains the project’s current date and is only set in the EcoDesigner STAR add-on (in other cases all values are set to 0). The value of this variable is modified by the add-on when running the solar analysis routines to allow certain GDL objects (for example deciduous trees) to be represented differently at different times of the year.
GLOB_WORLD_ORIGO_OFFSET_X (project dependent, do not use in parameter script)
GLOB_WORLD_ORIGO_OFFSET_Y (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 0
Position of the project origin relative to the world origin.
GLOB_MODPAR_NAME name of the last modified parameter
in the settings dialog or library part editor, including parameters modified through editable hotspots.
GLOB_UI_BUTTON_ID id of the button pushed on the UI page
or 0, if the last action was not the push of a button with id.
GLOB_CUTPLANES_INFO (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default [1.,, 3.0, -0.1, -0.1]
array of 4 length values:
  • 1 – cutplane height,
  • 2 – cutplane top level,
  • 3 – cutplane bottom level,
  • 4 – absolute display limit,in the library part’s local coordinate system.
See details in Set Floor Plan Cutplane dialog.
(project dependent, do not use in parameter script)
GLOB_STRUCTURE_DISPLAY structure display detail (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 0
informs about the partial structure display option settings (integer):
  • 0 – entire structure,
  • 1 – core only,
  • 2 – without finishes

Story information

GLOB_HSTORY_ELEV elevation of the home story (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 0
home story is the one the object is placed on
GLOB_HSTORY_HEIGHT height of the home story (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 3.1
home story is the one the object is placed on
GLOB_CSTORY_ELEV elevation of the current story (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 0.0
current story is the one currently shown in the Floor Plan window
GLOB_CSTORY_HEIGHT height of the current story (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 3.1
current story is the one currently shown in the Floor Plan window
GLOB_CH_STORY_DIST relative position of the current story to the home story (project dependent, do not use in parameter script)
2D GDL_CheckIcon 3D GDL_CheckIcon UI GDL_ErrorIcon Parameter GDL_ErrorIcon Property GDL_CheckIcon Default 0.0
current story is the one currently shown in the Floor Plan window

Fill parameters – available for listing and labels only

Migration parameters – available for migration scripts only
FILL_LINETYPE line type of the fill
FILL_FILL fill type of the fill
FILL_BMAT_NAME building material name of the fill
FILL_BMAT building material index of the fill
Compatibility: introduced in ARCHICAD 21.
FILL_FILL_PEN pen of the fill pattern of the fill
FILL_PEN pen of the fill
FILL_FBGD_PEN pen of the background of the fill
FILL_SURF area of the fill
FILL_PERIMETER perimeter of the fill
FILL_SEGMENT_NR number of segments of the fill
FILL_HOLES_NR number of holes in the fill
FILL_HOLES_PRM perimeter of holes in the fill
FILL_HOLES_AREA area of holes in the fill
FILL_FILL_CATEGORY fill category of the fill
0 – Draft, 1 – Cut, 2 – Cover
FROM_GUID Main GUID of the library part which was placed originally
TO_GUID Main GUID of the library part to which the migration is performed