rs3.projectSettings.Units module#

class rs3.projectSettings.Units.Units(client: Client, projectId: str)#

Bases: _ProxyObject

Modify the units of a model.

Examples

See Project Settings Script Examples.

setUnitSystem(value: UnitSystemType, resetProperties: bool = True)#

Sets the unit system for the current project.

By default, if the unit is changed, script will reset all unit-dependent property values in the project to their default values. This will reset the Field Stress settings, and ALL properties for Material, Bolts, Liners, and Joints. To preserve existing values when changing the unit, set resetProperties to False.

It is recommended to set the desired unit at the beginning of the script or project to avoid unintended resets.

Parameters:

  • value (UnitSystemType) – The unit system to apply.

  • resetProperties (bool, optional) – Whether to reset unit-dependent property values to their defaults. Defaults to True.

getUnitSystem() → UnitSystemType#
setTimeUnits(value: TimeUnitsType, resetProperties: bool = True)#

Sets the time unit for the current project.

By default, if the unit is changed, script will reset all unit-dependent property values in the project to their default values. This will reset the Field Stress settings, and ALL properties for Material, Bolts, Liners, and Joints. To preserve existing values when changing the unit, set resetProperties to False.

It is recommended to set the desired unit at the beginning of the script or project to avoid unintended resets.

Parameters:

  • value (TimeUnitsType) – The unit system to apply.

  • resetProperties (bool, optional) – Whether to reset unit-dependent property values to their defaults. Defaults to True.

getTimeUnits() → TimeUnitsType#
setPermeabilityUnits(value: PermeabilityUnitsType, resetProperties: bool = True)#

Sets the permeability unit for the current project.

By default, if the unit is changed, script will reset all unit-dependent property values in the project to their default values. This will reset the Field Stress settings, and ALL properties for Material, Bolts, Liners, and Joints. To preserve existing values when changing the unit, set resetProperties to False.

It is recommended to set the desired unit at the beginning of the script or project to avoid unintended resets.

Parameters:

  • value (PermeabilityUnitsType) – The unit system to apply.

  • resetProperties (bool, optional) – Whether to reset unit-dependent property values to their defaults. Defaults to True.

getPermeabilityUnits() → PermeabilityUnitsType#