rs3.properties.Group module#

class rs3.properties.Group.Group(client: Client, objectId: str, projectId: str)#

Bases: _ProxyObject, IPropertyGroupAccessors

getGroupName() → str#
setGroupName(value: str)#
setColor(*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

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

getGroupSetsTransparency() → bool#
setGroupSetsTransparency(value: bool)#
getGroupTransparency() → float#
setGroupTransparency(value: float)#

Set group transparency.

Parameters:

value (float) – Transparency percentage in the range [0, 1].

getProperties()#

Retrieve properties as a dictionary.

setProperties(GroupName: str = None, GroupSetsTransparency: bool = None, GroupTransparency: float = None)#

Set properties using keyword arguments.