Function saveStringToEntityDynamicProperties

  • saveStringToEntityDynamicProperties(
        entity: Entity,
        string: string,
        propertyName: string,
        clearOldProperties?: boolean,
        chunkSize?: number | bigint,
    ): void

    Saves a string to an entity's dynamic properties, optionally clearing old properties first.

    Parameters

    • entity: Entity

      The entity to which the string will be saved.

    • string: string

      The string to save to the entity's dynamic properties.

    • propertyName: string

      The base name of the dynamic property where the string will be saved.

    • clearOldProperties: boolean = true

      Whether to clear old properties before saving the new string. Defaults to true.

    • chunkSize: number | bigint = 32760

      The size of each chunk of the string to save. Defaults to 32760.

    Returns void

    Throws

    If propertyName is not a string.

    Throws

    If clearOldProperties is not a boolean.

Settings

Member Visibility