rs3.properties.liner.Liner module#

class rs3.properties.liner.Liner.LinerProperty(client: Client, linerID: str)#

Bases: _ProxyObject

Define liner properties.

Variables:

  • Standard (Standard) – Reference object for modifying property.

  • Geosynthetic (Geosynthetic) – Reference object for modifying property.

  • ReinforcedConcrete (ReinforcedConcrete) – Reference object for modifying property.

Examples

See Liner Script Examples.

getLinerName() → str#
setLinerName(name)#
getLinerType() → LinerTypes#
setLinerType(linerType: LinerTypes)#
setLinerColor(*args)#

Sets the RGBA color for the object.

Raises:

ValueError – If inputs are invalid or out of range.

Notes

Accepted formats:

  • setColor(red, green, blue)

  • setColor(red, green, blue, alpha)

  • setColor(“#RRGGBB”)

  • setColor(“#RRGGBBAA”)

  • setColor(ColorType.Rose)

  • setColor(0xE1E4FF) # Integer COLORREF

getLinerColor() → tuple[int, int, int, int]#

Retrieves the RGBA color of the object.

Returns:

A tuple of four integers representing the red, green, blue, and alpha components of the object’s color, each in the range [0, 255].

Return type:

tuple[int, int, int, int]

getApplyStageFactors() → bool#
UI Label:

Stage Liner Properties

setApplyStageFactors(value: bool)#
UI Label:

Stage Liner Properties