comet.CCometGroup¶

class comet.CCometGroup¶

Methods¶

CCometGroup.getDocument()¶

Get the document of this group.

Returns: The document this group belongs to
Return type: CDocument
Available

CCometGroup.getID()¶

Get the ID of this group.

Returns: The ID of this group
Return type: int
Available

CCometGroup.getMembers()¶

Get all members of this group.

Returns: The members of this group
Return type: list[CFrame]
Raises: TypeError – When parameter types are invalid
Available
CScript: itemlist::get_cometgroup_members

CCometGroup.addMembers(members)¶

Add new members to this group.

Parameters: members (list[CFrame]) – New members to add
Raises: TypeError – When parameter types are invalid
Available
CScript: itemlist::add_to_cometgroup

CCometGroup.removeMembers(members)¶

Remove members from this group.

Parameters: members (list[CFrame]) – Members to remove
Raises: TypeError – When parameter types are invalid
Available
CScript: itemlist::remove_from_cometgroup

CCometGroup.remove()¶

Remove this comet group from it’s document by removing all members.

All subsequent calls to this object will fail.

Available
CScript: itemlist::resolve_cometgroup