view orpg/dieroller/HOWTO.txt @ 146:6cc9dd8ebcd4 beta

Traipse Beta 'OpenRPG' {091123-03} 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 (Beta) Added Bookmarks Fix to Remote Admin Commands Minor fix to text based Server Fix to Pretty Print, from Core Fix to Splitter Nodes not being created Fix to massive amounts of images loading, from Core Added 'boot' command to remote admin Added confirmation window for sent nodes Minor changes to allow for portability to an OpenSUSE linux OS Miniatures Layer pop up box allows users to turn off Mini labels, from FlexiRPG Zoom Mouse plugin added Images added to Plugin UI Switching to Element Tree Map efficiency, from FlexiRPG Added Status Bar to Update Manager default_manifest.xml renamed to default_upmana.xml Cleaner clode for saved repositories New TrueDebug Class in orpg_log (See documentation for usage) Mercurial's hgweb folder is ported to upmana Pretty important update that can help remove thousands of dead children from your gametree. Children, <forms />, <group_atts />, <horizontal />, <cols />, <rows />, <height />, etc... are all tags now. Check your gametree and look for dead children!! New Gametree Recursion method, mapping, and context sensitivity. !Infinite Loops return error instead of freezing the software! New Syntax added for custom PC sheets Tip of the Day added, from Core and community Fixed Whiteboard ID to prevent random line or text deleting. Modified ID's to prevent non updated clients from ruining the fix.
author sirebral
date Mon, 23 Nov 2009 20:02:35 -0600
parents 4385a7d0efd1
children bf799efe7a8a
line wrap: on
line source

HOW TO CREATE A NEW DIE ROLLER

So you want a make a new roller or add a new option? here's a short guide.


Step 1:  Create a new die roller sub class.

You need to derive a new die roller class from an existing die roller class.  
Most likely, this will be the std die roller class. 

The basics would look like this:

class new_roller(std):
    def __init__(self,source=[]):
        std.__init__(self,source)
        .....

    ....

Step 2: Implement new methods and/or override existing ones.

Now, you just need to implement any new die options and override any 
existing ones that you want to act differently.  The most common options 
to override are the sum and __str__ functions.  Sum is used to determine 
the result of the rolls and __str__ is used to display the results in 
a user friendly string.

For example:

class new_roller(std):
    def __init__(self,source=[]):
        std.__init__(self,source)
        .....

    def myoption(self,param):
        ....

    def sum(self):
        ....

    def __str__(self):
        ....

REMEMBER!
Always return an instance of your die roller for each option expect str and sum.


Step 3:

Modify Utils.py

You need to make some minor modifications to utils.py to facilitate 
your new roller.  You need to a) add an import call for your roller, 
and b) add your roller to the list of available rollers. 

For example:

from die import *
# add addtional rollers here
from myroller import *
....

rollers = ['std','wod','d20','myroller']

Step 4:  You're done! 

Test it and make sure it works.  When you think its done, send it to 
the openrpg developers and they might include it in future releases.

-Chris Davis