rs3.properties.pile.Pile module#

class rs3.properties.pile.Pile.PileBase(client: Client, id: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getApplyStageFactors() → bool#
setApplyStageFactors(value: bool)#
getProperties()#

Retrieve properties as a dictionary.

setProperties(ApplyStageFactors: bool = None)#

Set properties using keyword arguments.

class rs3.properties.pile.Pile.PileProperty(client: Client, pileID: str)#

Bases: PileBase

Define pile properties.

Variables:

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

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

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

Examples

See Pile Script Examples.

getPileName() → str#
setPileName(name)#
setPileColor(*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

getPileColor() → 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]

getSkinResistance() → PileSkinResistanceType#
setSkinResistance(skinResistanceType: PileSkinResistanceType)#
getConnectionType() → ConnectionType#
setConnectionType(connectionType: ConnectionType)#
getLiningConnectionType() → LiningConnectionType#
setLiningConnectionType(liningConnectionType: LiningConnectionType)#
getBeamMaterial() → str#
setBeamMaterial(value: str)#