rs3.properties.beam.Beam module#

class rs3.properties.beam.Beam.BeamBase(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.beam.Beam.BeamProperty(client: Client, beamID: str)#

Bases: BeamBase

Define beam properties.

Variables:

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

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

Examples

See Beam Script Examples.

setBeamName(name: str)#
getBeamName() → str#
setBeamType(beamType: BeamType)#
getBeamType() → BeamType#
setBeamColor(*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

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