
""" example.txt  *THIS WILL NOT BE LOADED BY THE BOT

	"""
	
class exposed():
	def __init__(self, parent):
		''' Occurs when the plugin is loaded '''
		
	def __attr__(self):
		''' Plugin attributes, the ones here are ABSOLUTELY necessary. 
			* name - Name of plugin
			* author - Person(s) who wrote the code
			* version - Tuple with the version number
			* description - Info about the plugin
			* notes - Programmer's notes
			* help - Helpful things to know
			* chatexplicit - Will only recieve chat events, not raw data
		    Optional:
			* onlymain - Only loads on the main bot in a family
		'''
		return {
			'name' : 'Example',
			'author' : "vi[r]us",
			'version' : (1, 0),
			'description' : 'Example plugin for aspiring scripters.',
			'notes' : 'Will not be loaded by the bot.',
			'help' : '',
			'chatexplicit' : False
			}
			
	def __invoke__(self, ID, Length, Data, p):
		''' Called when you recieve raw packets. You will need to use the buffer to
			decode the data. '''
		if (ID == 0x100):
			## Socket Startup
			pass
		else:
			## I don't know what to do
			pass
		
	def __cevent__(self, ID, Data, p):
		''' Called when the bot recieves a chat event. The data is already parsed for you.
			THE ID IS NOT 0X0F. IT IS THE ID OF THE EVENT FROM BATTLE.NET.
			Generally, it is setup like this:
			* username - Name of source
			* flags - Flags of user, channel or event
			* ping - Ping of the user, if it is not a player-related event, this may contain numerical information
				* See the event documentation for more info
			* data - Statstrings, messages, etc
			'''
		pass