rs3.ExternalVolume module#

class rs3.ExternalVolume.ExternalVolume(client: Client, projectID: str)#

Bases: _ProxyObject

Examples: See External Volume and Selection Script Examples.

setName(name: str)#
getName() str#
setRole(role: ExternalVolumeRoles)#
getRole() ExternalVolumeRoles#
setAppliedMaterialProperty(stageNum: int, materialName: str)#

Assign material to the given stage by material name. If the external volume is excavated, “No Material” should be used as the materialName.

getAppliedMaterialProperty(stageNum: int)#
getVolume() str#
getTotalSurfaceArea() str#