view orpg/pluginhandler.py @ 195:b633f4c64aae alpha

Traipse Alpha 'OpenRPG' {100219-00} 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 (Patch-2) New Features: New Namespace method with two new syntaxes Fixes: Fix to Server GUI startup errors Fix to Server GUI Rooms tab updating Fix to Chat and Settings if non existant die roller is picked Fix to Dieroller and .open() used with .vs(). Successes are correctly calculated Fix to Alias Lib's Export to Tree, Open, Save features Fix to alias node, now works properly Fix to Splitter node, minor GUI cleanup
author sirebral
date Sat, 24 Apr 2010 08:37:20 -0500
parents c54768cffbd4
children 4dc11df853bf
line wrap: on
line source

from orpg.orpg_wx import *
from orpg.orpgCore import component

class PluginHandler:
    # Initialization subroutine.
    #
    # !self : instance of self
    # !chat : instance of the chat window to write to
    def __init__(self, plugindb, parent):
        self.session = component.get("session")
        self.chat = component.get("chat")
        self.settings = component.get("settings")
        self.gametree = component.get("tree")
        self.startplugs = component.get("startplugs")
        self.xml = component.get("xml")
        self.validate = component.get("validate")
        self.topframe = component.get("frame")
        self.plugindb = plugindb
        self.parent = parent
        self.shortcmdlist = self.chat.chat_cmds.shortcmdlist
        self.cmdlist = self.chat.chat_cmds.cmdlist

    def plugin_enabled(self):
        pass

    def plugin_disabled(self):
        pass

    def menu_start(self):
        rootMenu = component.get("pluginmenu")
        try:
            self.plugin_menu()
            rootMenu.AppendMenu(wx.ID_ANY, self.name, self.menu)
        except:
            self.menu = wx.Menu()
            empty = wx.MenuItem(self.menu, wx.ID_ANY, 'Empty')
            self.menu.AppendItem(empty)
            rootMenu.AppendMenu(wx.ID_ANY, self.name, self.menu)

    def menu_cleanup(self):
        self.settings.save()
        rootMenu = component.get("pluginmenu")
        menus = rootMenu.MenuItems
        for mi in menus:
            if mi.GetText() == self.name:
                rootMenu.RemoveItem(mi)
		del self.menu

    def plugin_addcommand(self, cmd, function, helptext, show_msg=True):
        self.chat.chat_cmds.addcommand(cmd, function, helptext)
        if(show_msg):
            msg = '<br /><b>New Command added</b><br />'
            msg += '<b><font color="#000000">%s</font></b>  %s' % (cmd, helptext)
            self.chat.InfoPost(msg)

    def plugin_commandalias(self, shortcmd, longcmd, show_msg=True):
        self.chat.chat_cmds.addshortcmd(shortcmd, longcmd)
        if(show_msg):
            msg = '<br /><b>New Command Alias added:</b><br />'
            msg += '<b><font color="#0000CC">%s</font></b> is short for <font color="#000000">%s</font>' % (shortcmd, longcmd)
            self.chat.InfoPost(msg)

    def plugin_removecmd(self, cmd):
        self.chat.chat_cmds.removecmd(cmd)
        msg = '<br /><b>Command Removed:</b> %s' % (cmd)
        self.chat.InfoPost(msg)

    def plugin_add_nodehandler(self, nodehandler, nodeclass):
        self.gametree.add_nodehandler(nodehandler, nodeclass)

    def plugin_remove_nodehandler(self, nodehandler):
        self.gametree.remove_nodehandler(nodehandler)

    def plugin_add_msg_handler(self, tag, function):
        self.session.add_msg_handler(tag, function)

    def plugin_delete_msg_handler(self, tag):
        self.session.remove_msg_handler(tag)

    def plugin_add_setting(self, setting, value, options, help):
        self.settings.add_tab('Plugins', self.name, 'grid')
        self.settings.add_setting(self.name, setting, value, options, help)

    def plugin_send_msg(self, to, plugin_msg):
        xml_dom = self.xml.parseXml(plugin_msg)
        xml_dom = xml_dom._get_documentElement()
        xml_dom.setAttribute('from', str(self.session.id))
        xml_dom.setAttribute('to', str(to))
        xml_dom.setAttribute('group_id', str(self.session.group_id))
        tag_name = xml_dom._get_tagName()
        if not tag_name in self.session.core_msg_handlers:
            xml_msg = '<plugin to="' + str(to)
            xml_msg += '" from="' + str(self.session.id)
            xml_msg += '" group_id="' + str(self.session.group_id)
            xml_msg += '" />' + xml_dom.toxml()
            self.session.outbox.put(xml_msg)
        else:
            #Spoofing attempt
            pass
        xml_dom.unlink()

    def message(self, text):
        return text

    def pre_parse(self, text):
        return text

    def send_msg(self, text, send):
        return text, send

    def plugin_incoming_msg(self, text, type, name, player):
        return text, type, name

    def post_msg(self, text, myself):
        return text

    def refresh_counter(self):
        pass

    def close_module(self):
        #This is called when OpenRPG shuts down
        pass