rs3.properties.bolt.Bolt module#

class rs3.properties.bolt.Bolt.BoltProperty(client: Client, boltID: str)#

Bases: _ProxyObject

Define bolt properties.

Variables:

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

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

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

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

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

Examples

See Bolt Script Examples.

getBoltName() → str#
setBoltName(name)#
getBoltType() → BoltTypes#
setBoltType(boltType: BoltTypes)#
setBoltColor(*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

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