×
Menu
Index

Methods Defined Here

 
assign_rooms_to_group (group handle, scheme handle, [room IDs])
Assigns the rooms specified by room IDs list to the specified group.  The room IDs list can be either a list of strings or a list of VEBody objects.
 
create_grouping_scheme (name) -> int
Creates a room grouping scheme with the given name.  Returns the handle of the new grouping scheme
 
create_room_group (scheme_handle, group_name, colour = (0, 0, 0) ) ->
Creates a room group with the given name and colour in the provided grouping scheme. Colour is expressed as a tuple of (R,G,B) and is optional, defaulting to black.  Returns the handle of the new room group
 
get_grouping_schemes ( ) -> List of dictionaries
Get a list of room grouping schemes stored as dictionaries.  Dictionary entries are:
    handle, name
 
get_room_groups (grouping scheme handle) -> List of dictionaries
Get a list of room groups (stored as dictionaries) for a grouping scheme.   Dictionary entries are:
 
colour
(tuple of R,G,B ints)  each colour entry in range 0-255
handle
(int)
name
(string)
rooms
(list of strings) list of room IDs assigned to group