comet.element

The element module provides factory functions for creating CElement objects.

Methods

comet.element.create(recordID=None, templateID=0, formatString='')

Create a new CElement object which is used in determining which elements to build for repeating element placeholders.

The element can be immediately initialized.

Parameters
  • recordID (None | CIDType | tuple[int, int, int, str]) –

    The record ID to immediately initialize the element with.

    The parameter type can be:

  • templateID (int) – The template ID to build the element with

  • formatString (str) – The addional build information format string

Returns

The newly created element

Return type

CElement

Raises
Available

CScript

element::alloc