traipse_dev: plugins/xxblank.py annotate

annotate plugins/xxblank.py @ 68:3ea7a54284bb ornery-dev

Traipse Dev 'OpenRPG' {090818-02} Traipse is a distribution of OpenRPG that is designed to be easy to setup and go. Traipse also makes it easy for developers to work on code without fear of sacrifice. 'Ornery-Orc' continues the trend of 'Grumpy' and adds fixes to the code. 'Ornery-Orc''s main goal is to offer more advanced features and enhance the productivity of the user. Update Summary: *Stable* This is the first wave of Code Refinement updates. Includes new material from Core Beta; new debugger material (partially implemented), beginnings of switch to etree, TerminalWriter, and a little more. open_rpg has been renamed to component; functioning now as component.get(), component.add(), component.delete(). This version has known bugs, specifically with the gametree and nodes. Fixes nodehandlers to bring the dev back to a stable push. Known issue with a nodehandler and it's sub dialogs. Fixed a mis-spelled import. whoops.

author	sirebral
date	Tue, 18 Aug 2009 07:38:58 -0500
parents	4385a7d0efd1
children	15488fe94f52

rev	line source
0 4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	1 import os
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	2 import orpg.pluginhandler
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	3
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	4 class Plugin(orpg.pluginhandler.PluginHandler):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	5 # Initialization subroutine.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	6 #
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	7 # !self : instance of self
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	8 # !openrpg : instance of the the base openrpg control
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	9 def __init__(self, plugindb, parent):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	10 orpg.pluginhandler.PluginHandler.__init__(self, plugindb, parent)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	11
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	12 # The Following code should be edited to contain the proper information
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	13 self.name = 'Example Plugin'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	14 self.author = 'Your Name'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	15 self.help = 'Info About your plugin'
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	16
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	17 #You can set variables below here. Always set them to a blank value in this section. Use plugin_enabled
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	18 #to set their proper values.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	19 self.sample_variable = {}
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	20
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	21
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	22 def plugin_enabled(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	23 #You can add new /commands like
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	24 # self.plugin_addcommand(cmd, function, helptext)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	25 self.plugin_addcommand('/test', self.on_test, '- This is an example plugin command')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	26
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	27 #If you want your plugin to have more then one way to call the same function you can
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	28 #use self.plugin_commandalias(alias name, command name)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	29 #You can also make shortcut commands like the following
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	30 self.plugin_commandalias('/example', '/me is giving you an example')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	31
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	32 #if you want your plugin to use custom messages to comunicate with other people using the same plugin
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	33 #you can add a message handler in a simmilar way to adding a new slash command. The first variable
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	34 #'xxblank' in this case is the tage name for your custom xml message. The second variable is the function
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	35 #you want to handle proccessing your messages when one is recived.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	36 #Be sure to delete your handler in plugin_disabled
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	37 self.plugin_add_msg_handler('xxblank', self.on_xml_recive)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	38
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	39 #if you want your plugin to store some settings in the settings window
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	40 #you can add them here, the system checks to make sure it does not already exist so you dont
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	41 #have to worry about it adding copies every time the plugin loads or it overwriting the users changes to it.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	42 #This should be used for simple short settings that you would like the user to be able to change in the settings window
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	43 #variables:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	44 #setting - The setting name, cannot contain spaces
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	45 #value - The default value
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	46 #options - The type of value that is expected
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	47 #help - a help message to explain what this variable does.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	48 self.plugin_add_setting('Setting', 'Value', 'Options', 'Help message')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	49
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	50 #This is where you set any variables that need to be initalized when your plugin starts
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	51 self.sample_variable = {1:'one', 2:'two'}
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	52
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	53 def plugin_disabled(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	54 #Here you need to remove any commands you added, and anything else you want to happen when you disable the plugin
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	55 #such as closing windows created by the plugin
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	56 self.plugin_removecmd('/test')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	57 self.plugin_removecmd('/example')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	58
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	59 #This is the command to delete a message handler
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	60 self.plugin_delete_msg_handler('xxblank')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	61
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	62 #This is how you should destroy a frame when the plugin is disabled
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	63 #This same method should be used in close_module as well
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	64 try:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	65 self.frame.Destroy()
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	66 except:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	67 pass
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	68
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	69 def on_test(self, cmdargs):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	70 #this is just an example function for a command you create.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	71 # cmdargs contains everything you typed after the command
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	72 # so if you typed /test this is a test, cmdargs = this is a test
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	73 # args are the individual arguments split. For the above example
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	74 # args[0] = this , args[1] = is , args[2] = a , args[3] = test
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	75 self.plugin_send_msg(cmdargs, '<xxblank>' + cmdargs + '</xxblank>')
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	76 args = cmdargs.split(None,-1)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	77 msg = 'cmdargs = %s' % (cmdargs)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	78 self.chat.InfoPost(msg)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	79
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	80 if len(args) == 0:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	81 self.chat.InfoPost("You have no args")
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	82 else:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	83 i = 0
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	84 for n in args:
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	85 msg = 'args[' + str(i) + '] = ' + n
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	86 self.chat.InfoPost(msg)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	87 i += 1
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	88
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	89 def on_xml_recive(self,id, data,xml_dom):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	90 self.chat.InfoPost(self.name + ":: Message recived<br />" + data.replace("<","<").replace(">",">") +'<br />From id:' + str(id))
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	91
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	92 def pre_parse(self, text):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	93 #This is called just before a message is parsed by openrpg
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	94 return text
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	95
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	96 def send_msg(self, text, send):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	97 #This is called when a message is about to be sent out.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	98 #It covers all messages sent by the user, before they have been formatted.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	99 #If send is set to 0, the message will not be sent out to other
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	100 #users, but it will still be posted to the user's chat normally.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	101 #Otherwise, send defaults to 1. (The message is sent as normal)
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	102 return text, send
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	103
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	104 def plugin_incoming_msg(self, text, type, name, player):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	105 #This is called whenever a message from someone else is received, no matter
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	106 #what type of message it is.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	107 #The text variable is the text of the message. If the type is a regular
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	108 #message, it is already formatted. Otherwise, it's not.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	109 #The type variable is an integer which tells you the type: 1=chat, 2=whisper
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	110 #3=emote, 4=info, and 5=system.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	111 #The name variable is the name of the player who sent you the message.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	112 #The player variable contains lots of info about the player sending the
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	113 #message, including name, ID#, and currently-set role.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	114 #Uncomment the following line to see the format for the player variable.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	115 #print player
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	116 return text, type, name
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	117
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	118 def post_msg(self, text, myself):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	119 #This is called whenever a message from anyone is about to be posted
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	120 #to chat; it doesn't affect the copy of the message that gets sent to others
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	121 #Be careful; system and info messages trigger this too.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	122 return text
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	123
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	124 def refresh_counter(self):
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	125 #This is called once per second. That's all you need to know.
4385a7d0efd1 Deleted and repushed it with the 'grumpy-goblin' branch. I forgot a y sirebral parents: diff changeset	126 pass

Mercurial > traipse_dev

annotate plugins/xxblank.py @ 68:3ea7a54284bb ornery-dev