pywargame 0.3.1__py3-none-any.whl → 0.4.2__py3-none-any.whl

pywargame/vassal/extension.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . game import Game

pywargame/vassal/folder.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 ## END_IMPORT

pywargame/vassal/game.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . documentation import Documentation

pywargame/vassal/gameelements.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . withtraits import *
@@ -1059,17 +1059,34 @@ class MultiActionButton(GameElement):
                  disabledIcon = '',    # image when disabled
                  menuItems    = []):   # Button texts
         '''
-        <VASSAL.build.module.MultiActionButton
-          canDisable="false"
-          description="Menu"
-          disabledIcon="" hideWhenDisabled="false"
-          hotkey="67,130"
-          icon="C.png"
-          menuItems="Attacked,Defended" 
-          propertyGate=""
-          text=""
-          tooltip="Clear combat status flags."
-        />
+        A button that executes other buttons (by `buttonText` name)
+
+        Parameters
+        ----------
+        game : pywargame.vassal.Game
+            The game parent
+        node : xml.dom.minidom.Node
+            Possible node
+        description : str
+            Description (comment)
+        text : str
+            Text on button
+        tooltip : str
+            Button tool-tip
+        icon : str
+            Icon on button
+        hotkey : str
+            Hotkey or named command to execute button
+        canDisable : bool
+            If this can be disabled
+        propertyGate : str
+            When property (not expression) is `true`, then disable
+            this button
+        disabledIcon : str
+            Icon to use when disabled
+        menuItems : list of str
+            `buttonText` of other buttons to execute
+            (note, not named commands or hotkeys). 
         '''
         super().__init__(game,
                          self.TAG,

pywargame/vassal/globalproperty.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 ## END_IMPORT

pywargame/vassal/grid.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 ## END_IMPORT

pywargame/vassal/map.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . mapelements import *

pywargame/vassal/mapelements.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . withtraits import *

pywargame/vassal/merge.py

@@ -1,12 +1,11 @@
 #!/usr/bin/env python
 ## BEGIN_IMPORTS
-from vassal import Merger
-from common import Verbose
+from pywargame.vassal import Merger
+from pywargame.common import Verbose
 ## END_IMPORTS
 
-        
 # ====================================================================        
-if __name__ == '__main__':
+def mergeMain():
     from argparse import ArgumentParser, FileType
 
     ap = ArgumentParser(description='Merge two modules or extensions')
@@ -49,7 +48,11 @@ if __name__ == '__main__':
         op.unlink(missing_ok=True)
         
         raise
-
+    
+        
+# ====================================================================        
+if __name__ == '__main__':
+    mergeMain()
     
 
 #

pywargame/vassal/merger.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . extension import *

pywargame/vassal/moduledata.py

@@ -1,7 +1,8 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
+from . xmlns import xmlns
 ## END_IMPORT
 
 # --------------------------------------------------------------------

pywargame/vassal/patch.py

@@ -2,8 +2,8 @@
 #
 # Patch a module
 ## BEGIN_IMPORTS
-from vassal.vmod import VMod
-from common import Verbose
+from pywargame.vassal import VMod
+from pywargame.common import Verbose
 ## END_IMPORT
 
 # ====================================================================
@@ -18,7 +18,7 @@ def patchIt(args):
     VMod.patch(vmodname, patchname, args.verbose)
 
 # ====================================================================
-if __name__ == '__main__':
+def patchMain():
     from argparse import ArgumentParser, FileType
 
     ap = ArgumentParser(description='Patch a module with a Python script')
@@ -35,10 +35,13 @@ if __name__ == '__main__':
                     action='store_true')
 
     args = ap.parse_args()
-
     
     patchIt(args)
-
+    
+# ====================================================================
+if __name__ == '__main__':
+    patchMain()
+    
 #
 # EOF
 #

pywargame/vassal/player.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . gameelements import GameElement

pywargame/vassal/trait.py

@@ -6,7 +6,8 @@ class Trait:
         
         Unlike the Element classes, this actually holds state that
         isn't reflected elsewhere in the DOM.  This means that the
-        data here is local to the object.  So when we do
+        data here is local to the object.  So when we do::
+
         
             piece  = foo.getPieceSlots()[0]
             traits = p.getTraits()
@@ -14,23 +15,25 @@ class Trait:
                 if trait.ID == 'piece': 
                     trait["gpid"] = newPid
                     trait["lpid"] = newPid
-        
+                
         we do not actually change anything in the DOM.  To do that, we
-        must add back _all_ the traits as
-        
+        must add back _all_ the traits as::
+
             piece.setTraits(traits)
         
-        We can add traits to a piece, like
-        
+        We can add traits to a piece, like::
+
             piece.addTrait(MarkTrait('Hello','World'))
-        
+                
         But it is not particularly efficient.  Better to do
-        (continuing from above)
-        
+        (continuing from above)::
+
+       
             traits.append(MarkTrait('Hello','World;)
             piece.setTraits(traits)
+       
         
-        .. include:: ../../vassal/traits/README.md
+        .. include:: traits/README.md
            :parser: myst_parser.sphinx_
         
         '''

pywargame/vassal/traits/__init__.py

@@ -33,4 +33,4 @@ from . cargo import CargoTrait
 from . movefixed import MoveFixedTrait
 from . sheet import SheetTrait
 from . hide import HideTrait
-from . return import ReturnTrait
+from . retrn import ReturnTrait

pywargame/vassal/traits/area.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import rgb, key
 ## END_IMPORT
@@ -40,8 +40,10 @@ class AreaTrait(Trait):
                  onKey             = onKey,
                  offMenuText       = offMenuText,
                  offKey            = offKey,
-                 globallyVisible   = globallyVisible
-        )
+                 globallyVisible   = globallyVisible)
+        '''Create an area effect trait
+
+        '''
         self.setState(active = alwaysActive or not globallyVisible)
 
 Trait.known_traits.append(AreaTrait)

pywargame/vassal/traits/basic.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/calculatedproperty.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/cargo.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 
@@ -14,6 +14,9 @@ class CargoTrait(Trait):
                  detectionDistanceY     = 0,
                  attachKey              = '',
                  detachKey              = ''):
+        '''Create cargo trait
+
+        '''
         self.setType(description            = description,
                      maintainRelativeFacing = maintainRelativeFacing,
                      detectionDistanceX     = detectionDistanceX,

pywargame/vassal/traits/click.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/clone.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/delete.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/deselect.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/dynamicproperty.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/globalcommand.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/globalhotkey.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/globalproperty.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from . dynamicproperty import ChangePropertyTrait
 ## END_IMPORT

pywargame/vassal/traits/hide.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/label.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/layer.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/mark.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/mask.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/mat.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 
@@ -10,6 +10,9 @@ class MatTrait(Trait):
     def __init__(self,
                  name = 'Mat',
                  description = ''):
+        '''Create mat trait
+
+        '''
         self.setType(name        = name,
                      description = description)
         self.setState(content='0')

pywargame/vassal/traits/moved.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/movefixed.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/nonrect.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/nostack.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/place.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 # from .. widget import *

pywargame/vassal/traits/prototype.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/report.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/restrictaccess.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/restrictcommand.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/{return.py → retrn.py}

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/rotate.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/sendto.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/sheet.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/skel.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/stack.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/submenu.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 ## END_IMPORT
 

pywargame/vassal/traits/trail.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/traits/trigger.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from ... common import VerboseGuard
 from .. trait import Trait
 from .. base import *
 ## END_IMPORT

pywargame/vassal/turn.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 ## END_IMPORT

pywargame/vassal/upgrade.py

@@ -1,5 +1,5 @@
 ## BEGIN_IMPORT
-from common import VerboseGuard
+from .. common import VerboseGuard
 from . base import *
 from . element import Element
 from . command import *