pywargame 0.3.1__py3-none-any.whl

pywargame/vassal/globalkey.py

@@ -0,0 +1,127 @@
+## BEGIN_IMPORT
+from . base import *
+from . element import ToolbarElement
+## END_IMPORT
+
+# --------------------------------------------------------------------
+class GlobalKey(ToolbarElement):
+    ## Fast filters
+    ##
+    ## Format:
+    ##
+    ##   GKCTYPE|LOCATION|<location>|PROPERTY|<property>
+    ##
+    ## where
+    ##
+    ##    GKCTYPE: MAP    (from Global),
+    ##             MODULE (from GameGlobal)
+    ##             DECK
+    ##             COUNTER (from CounterGlobal)
+    ##
+    ##    LOCATION: true - filter on location
+    ##              false - do not filter on location
+    ##
+    ##    PROPERTY: true - filter on property
+    ##              false - do not filter on property
+    ##
+    ##    <location> is
+    ##
+    ##       TARGETTYPE|TARGETMAP|TARGETBOARD|TARGETZONE|TARGETLOCATION|TARGETX|TARGETY|TARGETDECK
+    ##
+    ##    <property> is
+    ##
+    ##       PROPERTYNAME|PROPERTYVALUE|COMPARE
+    ##
+    ##    TARGETTYPE: CURSTACK current stack or deck
+    ##                CURMAP   current map
+    ##                CURZONE  current zone
+    ##                CURLOC   current location 
+    ##                MAP      specified map      (TARGETMAP)
+    ##                ZONE     specified zone     (TARGETZONE)
+    ##                LOCATION specified location (TARGETLOCATION)
+    ##                XY       specified X,Y      (TARGETBOARD,TARGETX,TARGETY)
+    ##                DECK     specified deck     (TARGETDECK)
+    ##                CURMAT   current mat
+    ##                
+    ##    PROPERTYNAME
+    ##
+    ##    PROPERTYVALUE: A constant
+    ##    
+    ##    COMPARE: EQUALS:         ==
+    ##             NOT_EQUALS:     !=
+    ##             GREATER:        >
+    ##             GREATER_EQUALS: >=
+    ##             LESS:           <
+    ##             LESS_EQUALS:    <=
+    ##             MATCH:          =~
+    ##             NOT_MATCH       !~
+    ##
+    ## 
+    SELECTED = 'MAP|false|MAP|||||0|0||true|Selected|true|EQUALS'
+    UNIQUE = ['name']
+    def __init__(self,
+                 parent,
+                 tag,
+                 node                 = None,
+                 name                 = '',                
+                 icon                 = '',
+                 tooltip              = '',
+                 buttonHotkey         = '',
+                 buttonText           = '',
+                 canDisable           = False,
+                 propertyGate         = '',
+                 disabledIcon         = '',
+                 # Local
+                 hotkey               = '',
+                 deckCount            = '-1',
+                 filter               = '',
+                 reportFormat         = '',
+                 reportSingle         = False,
+                 singleMap            = True,
+                 target               = SELECTED):
+        '''
+        Parameters
+        ----------
+        - tag          The XML tag to use
+        - parent       Parent node
+        - node         Optionally existing node
+        - name         Name of key
+        - buttonHotkey Key in "global" scope
+        - hotkey       Key to send to targeted pieces
+        - buttonText   Text on button
+        - canDisable   If true, disabled when propertyGate is true
+        - deckCount    Number of decks (-1 is all)
+        - filter       Which units to target
+        - propertyGate When true, disable
+        - reportFormat Chat message
+        - reportSingle Also show single piece reports
+        - singleMap    Only originating map if True
+        - target       Preselection filter (default selected pieces)
+        - tooltip      Hover-over message
+        - icon         Image to use as icon
+
+        Default targets are selected units
+        '''
+        
+        super(GlobalKey,self).\
+            __init__(parent,
+                     tag,
+                     node                 = node,
+                     name                 = name,
+                     icon                 = icon,
+                     tooltip              = tooltip,
+                     buttonHotkey         = buttonHotkey, # This hot key
+                     buttonText           = buttonText,
+                     canDisable           = canDisable,
+                     propertyGate         = propertyGate,
+                     disabledIcon         = disabledIcon,
+                     hotkey               = hotkey,       # Target hot key
+                     deckCount            = deckCount,
+                     filter               = filter,
+                     reportFormat         = reportFormat,
+                     reportSingle         = reportSingle,
+                     singleMap            = singleMap,
+                     target               = target)
+#
+# EOF
+# 

pywargame/vassal/globalproperty.py

@@ -0,0 +1,433 @@
+## BEGIN_IMPORT
+from common import VerboseGuard
+from . base import *
+from . element import Element
+## END_IMPORT
+
+# --------------------------------------------------------------------
+class GlobalProperties(Element):
+    TAG = Element.MODULE+'properties.GlobalProperties'
+    def __init__(self,elem,node=None,**named):
+        super(GlobalProperties,self).__init__(elem,self.TAG,node=node)
+        
+        for n, p in named:
+            self.addProperty(n, **p)
+
+    def getGame(self):
+        return self.getParent(Game)
+    def addProperty(self,**kwargs):
+        '''Add a `Property` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : Property
+            The added element
+        '''
+        return GlobalProperty(self,node=None,**kwargs)
+    def addFolder(self,**kwargs):
+        '''Add a `ModuleFolder` element to this
+
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        
+        Returns
+        -------
+        element : ModuleFolder
+            The added element
+        '''
+        return self.add(GlobalPropertyFolder,**kwargs)
+    
+    def getProperties(self):
+        return getElementsByKey(GlobalProperty,'name')
+
+    def addScenarioTab(self,**kwargs):
+        '''Add a scenario property tab
+
+        Parameters
+        -----------
+        kwargs : dict
+            Key-value pairs to send to ScenarioOptionsTab
+
+        Returns
+        -------
+        element : ScenarioOptionsTab
+            Added element
+        '''
+        return ScenarioOptionsTab(self,node=None,**kwargs)
+
+    def getScenarioTabs(self):
+        return getElementsByKey(ScenarioOptionsTab,'name')
+    def getFolders(self,asdict=True):
+        '''Get all Menu element(s) from this
+
+        Parameters
+        ----------
+        asdict : bool
+            If `True`, return a dictonary that maps key to `Folder`
+            elements.  If `False`, return a list of all `Folder`
+            children.
+
+        Returns
+        -------
+        children : dict or list
+            Dictionary or list of `Folder` children
+
+        '''
+        return self.getElementsByKey(GlobalPropertyFolder,'name',asdict)
+    
+registerElement(GlobalProperties)
+
+# --------------------------------------------------------------------
+class GlobalProperty(Element):
+    TAG = Element.MODULE+'properties.GlobalProperty'
+    UNIQUE = ['name']
+    def __init__(self,
+                 elem,
+                 node         = None,
+                 name         = '',
+                 initialValue = '',
+                 isNumeric    = False,
+                 min          = "null",
+                 max          = "null",
+                 wrap         = False,
+                 description  = ""):
+        super(GlobalProperty,self).__init__(elem,self.TAG,
+                                            node         = node,
+                                            name         = name,
+                                            initialValue = initialValue,
+                                            isNumeric    = isNumeric,
+                                            min          = min,
+                                            max          = max,
+                                            wrap         = wrap,
+                                            description  = description)
+
+    def getGlobalProperties(self):
+        return self.getParent(GlobalProperties)
+
+registerElement(GlobalProperty)
+
+# ====================================================================
+class ScenarioOptionsTab(Element):
+    TAG = Element.MODULE+'properties.ScenarioPropertiesOptionTab'
+    LEFT = 'left'
+    RIGHT = 'right'
+    UNIQUE = ['name']
+    
+    def __init__(self,elem,node=None,
+                 name         = 'Options',
+                 description  = 'Scenario options',
+                 heading      = '',
+                 leftAlign    = 'left',
+                 reportFormat = ('!$PlayerId$ changed Scenario Option '
+                                 '[$tabName$] $propertyPrompt$ from '
+                                '$oldValue$ to $newValue$')):
+        super(ScenarioOptionsTab,self).__init__(elem,
+                                                self.TAG,
+                                                node         = node,
+                                                name         = name,
+                                                description  = description,
+                                                heading      = heading,
+                                                leftAlign    = leftAlign,
+                                                reportFormat = reportFormat)
+
+    def addList(self,**kwargs):
+        '''Add a list property option
+
+        Parameters
+        ----------
+        kwargs : dict
+            Key, value pairs to initalise ScenarioOptionList
+
+        Returns
+        -------
+        element : ScenarioOption
+            The added element
+        '''
+        return ScenarioOptionList(self,node=None,**kwargs)
+
+    def addBoolean(self,**kwargs):
+        '''Add a list property option
+
+        Parameters
+        ----------
+        kwargs : dict
+            Key, value pairs to initalise ScenarioOptionBool
+
+        Returns
+        -------
+        element : ScenarioOption
+            The added element
+        '''
+        return ScenarioOptionBool(self,node=None,**kwargs)
+
+    def addString(self,**kwargs):
+        '''Add a list property option
+
+        Parameters
+        ----------
+        kwargs : dict
+            Key, value pairs to initalise ScenarioOptionString
+
+        Returns
+        -------
+        element : ScenarioOption
+            The added element
+        '''
+        return ScenarioOptionString(self,node=None,**kwargs)
+
+    def addNumber(self,**kwargs):
+        '''Add a list property option
+
+        Parameters
+        ----------
+        kwargs : dict
+            Key, value pairs to initalise ScenarioOptionNumber
+
+        Returns
+        -------
+        element : ScenarioOption
+            The added element
+        '''
+        return ScenarioOptionString(self,node=None,**kwargs)
+
+    def getOptions(self):
+        return self.getElementsByKey(ScenarioOption,'name')
+
+    def getListOptions(self):
+        return self.getElementsByKey(ScenarioOptionList,'name')
+
+    def getBoolOptions(self):
+        return self.getElementsByKey(ScenarioOptionBool,'name')
+
+    def getStringOptions(self):
+        return self.getElementsByKey(ScenarioOptionString,'name')
+    
+    def getNumberOptions(self):
+        return self.getElementsByKey(ScenarioOptionNumber,'name')
+    
+    def getGlobalProperties(self):
+        return self.getParent(GlobalProperties)
+
+registerElement(ScenarioOptionsTab)
+    
+# --------------------------------------------------------------------
+class ScenarioOption(Element):
+    UNIQUE = ['name']
+
+    def __init__(self,
+                 tab, 
+                 tag,
+                 node         = None,
+                 name         = '',
+                 hotkey       = '',
+                 description  = 'Set option value',
+                 switch       = False,
+                 initialValue = '',
+                 **kwargs):
+        '''
+        Parameters
+        ----------
+        tab : ScenarioOptionsTab
+            Tab to add to 
+        tag : str
+            Tag value (full)
+        name : str
+            Name of global property 
+        hotkey : named-key
+            Key stroke to send (global key)
+        description : str
+            Text to show user
+        switch : bool
+            If true, then prompt is put to the right
+        initialValue : str
+            Initial value
+        kwargs : dict
+            Other arguments
+        '''
+        super(ScenarioOption,self).__init__(tab,
+                                            tag,
+                                            node         = node,
+                                            name         = name,
+                                            hotkey       = hotkey,
+                                            description  = description,
+                                            switch       = switch,
+                                            initialValue = initialValue,
+                                            **kwargs)
+
+    def getTab(self):
+        return self.getParent(ScenarioOptionsTab)
+
+# --------------------------------------------------------------------
+class ScenarioOptionList(ScenarioOption):
+    TAG = Element.MODULE+'properties.ListScenarioProperty'
+
+    def __init__(self,
+                 tab,
+                 node         = None,
+                 name         = '',
+                 hotkey       = '',
+                 description  = 'Set option value',
+                 switch       = False,
+                 initialValue = None,
+                 options      = []):
+        '''
+        Parameters
+        ----------
+        tag : str
+            Tag value (full)
+        name : str
+            Name of global property 
+        hotkey : named-key
+            Key stroke to send (global key)
+        description : str
+            Text to show user
+        switch : bool
+            If true, then prompt is put to the right
+        initialValue : str
+            Initial value.  If None, set to first option
+        options : list 
+            Possible values
+        '''
+        opts = ','.join([str(s) for s in options])
+        if initialValue is None:
+            initialValue = opts[0]
+            
+        super(ScenarioOptionList,self).__init__(tab,
+                                                self.TAG,
+                                                node         = node,
+                                                name         = name,
+                                                hotkey       = hotkey,
+                                                description  = description,
+                                                switch       = switch,
+                                                initialValue = initialValue,
+                                                options      = opts)
+
+registerElement(ScenarioOptionList)
+
+# --------------------------------------------------------------------
+class ScenarioOptionBool(ScenarioOption):
+    TAG = Element.MODULE+'properties.BooleanScenarioProperty'
+
+    def __init__(self,
+                 tab,
+                 node         = None,
+                 name         = '',
+                 hotkey       = '',
+                 description  = 'Set option value',
+                 switch       = False,
+                 initialValue = False):
+        '''
+        Parameters
+        ----------
+        tag : str
+            Tag value (full)
+        name : str
+            Name of global property 
+        hotkey : named-key
+            Key stroke to send (global key)
+        description : str
+            Text to show user
+        switch : bool
+            If true, then prompt is put to the right
+        initialValue : bool
+            Initial value
+        '''
+        super(ScenarioOptionBool,self).__init__(tab,
+                                                self.TAG,
+                                                node         = node,
+                                                name         = name,
+                                                hotkey       = hotkey,
+                                                description  = description,
+                                                switch       = switch,
+                                                initialValue = initialValue)
+        
+registerElement(ScenarioOptionBool)
+
+# --------------------------------------------------------------------
+class ScenarioOptionString(ScenarioOption):
+    TAG = Element.MODULE+'properties.StringScenarioProperty'
+
+    def __init__(self,
+                 tab,
+                 node         = None,
+                 name         = '',
+                 hotkey       = '',
+                 description  = 'Set option value',
+                 switch       = False,
+                 initialValue = False):
+        '''
+        Parameters
+        ----------
+        tag : str
+            Tag value (full)
+        name : str
+            Name of global property 
+        hotkey : named-key
+            Key stroke to send (global key)
+        description : str
+            Text to show user
+        switch : bool
+            If true, then prompt is put to the right
+        initialValue : str
+            Initial value
+        '''
+        super(ScenarioOptionString,self).__init__(tab,
+                                                  self.TAG,
+                                                  node         = node,
+                                                  name         = name,
+                                                  hotkey       = hotkey,
+                                                  description  = description,
+                                                  switch       = switch,
+                                                  initialValue = initialValue)
+        
+registerElement(ScenarioOptionString)
+
+# --------------------------------------------------------------------
+class ScenarioOptionNumber(ScenarioOption):
+    TAG = Element.MODULE+'properties.NumberScenarioProperty'
+
+    def __init__(self,
+                 tab,
+                 node         = None,
+                 name         = '',
+                 hotkey       = '',
+                 description  = 'Set option value',
+                 switch       = False,
+                 initialValue = False):
+        '''
+        Parameters
+        ----------
+        tag : str
+            Tag value (full)
+        name : str
+            Name of global property 
+        hotkey : named-key
+            Key stroke to send (global key)
+        description : str
+            Text to show user
+        switch : bool
+            If true, then prompt is put to the right
+        initialValue : str
+            Initial value
+        '''
+        super(ScenarioOptionNumber,self).__init__(tab,
+                                                  self.TAG,
+                                                  node         = node,
+                                                  name         = name,
+                                                  hotkey       = hotkey,
+                                                  description  = description,
+                                                  switch       = switch,
+                                                  initialValue = initialValue)
+
+registerElement(ScenarioOptionNumber)
+
+#
+# EOF
+#