Previous topic

factory

Next topic

helpers

This Page

groups

class pyogp.lib.base.groups.ChatterBoxSessionEventReply_Message(message_data)
class pyogp.lib.base.groups.Group(AcceptNotices=None, GroupPowers=None, GroupID=None, GroupName=None, ListInProfile=None, Contribution=None, GroupInsigniaID=None, agent=None)

representation of a group

activate_group()
set this group as active
chat(Message=None)

sends an instant message to another avatar

wraps send_ImprovedInstantMessage with some handy defaults

handle_inbound_chat(message)
request_join_group_chat()
sends an ImprovedInstantMessage packet with the atributes necessary to join a group chat
update_properties(properties)
takes a dictionary of attribute:value and makes it so
class pyogp.lib.base.groups.ChatterBoxSessionAgentListUpdates_Message(message_data)
incomplete implementation
class pyogp.lib.base.groups.MockChatInterface(agent, chat_handler)

a super simple chat interface for testing

data_watcher()
get_and_send_input()
start()
class pyogp.lib.base.groups.ChatterBoxSessionStartReply_Message(message_data)
incomplete implementation
class pyogp.lib.base.groups.GroupManager(agent, settings=None)

a storage bin for groups

also, a functional area for group creation operations

initialize the group manager

activate_group(group_id)
set a particular group as active
create_group(AgentID=None, SessionID=None, Name=None, Charter='', ShowInList=True, InsigniaID=00000000-0000-0000-0000-000000000000, MembershipFee=0, OpenEnrollment=False, AllowPublish=False, MaturePublish=False)

sends a message to the agent’s current region requesting to create a group

enables a callback (which should be unsubscribed from once we get a response)

get_group(GroupID=None)
searches the store and returns group if stored, None otherwise
handle_group_chat(message)
process a ChatterBoxInvitation_Message instance
join_group(group_id)
sends a JoinGroupRequest packet for the specified uuid
onAgentGroupDataUpdate(packet)
deal with the data that comes in over the event queue
onChatterBoxInvitation_Message(message)
handle a group chat message from the event queue
onChatterBoxSessionAgentListUpdates(message)
parse teh response to a request to join a group chat and propagate data out
onChatterBoxSessionEventReply(message)
handle a response from the simulator re: a message we sent to a group chat
onChatterBoxSessionStartReply(message)
onCreateGroupReply(packet)
when we get a CreateGroupReply packet, log Success, and if True, request the group details. remove the callback in any case
onJoinGroupReply(packet)
the simulator tells us if joining a group was a success.
store_group(_group)
append to or replace a group in self.group_store
update_group(group_data)
accepts a dictionary of group data and creates/updates a group
update_group_by_name(group_data, name)
accepts a dictionary of group data and creates/updates a group
update_group_by_session_id(group_data)
accepts a dictionary of group data and creates/updates a group
class pyogp.lib.base.groups.ChatterBoxInvitation_Message(session_name=None, from_name=None, session_id=None, _type=None, region_id=None, offline=None, timestamp=None, ttl=None, to_id=None, source=None, from_group=None, position=None, parent_estate_id=None, message=None, binary_bucket=None, _id=None, god_level=None, limited_to_estate=None, check_estate=None, agent_id=None, from_id=None, ChatterBoxInvitation_Data=None)
a group chat message sent over the event queue