Project

Profile

Help

How to connect?
Download (2.66 KB) Statistics View on GitHub Reload from mirrored respository
| Branch: | Tag: | Revision:

github / src / scripting / macro.py @ 13e86181

1
# Copyright (c) 2016, LE GOFF Vincent
2
# All rights reserved.
3

    
4
# Redistribution and use in source and binary forms, with or without
5
# modification, are permitted provided that the following conditions are met:
6

    
7
# * Redistributions of source code must retain the above copyright notice, this
8
#   list of conditions and the following disclaimer.
9

    
10
# * Redistributions in binary form must reproduce the above copyright notice,
11
#   this list of conditions and the following disclaimer in the documentation
12
#   and/or other materials provided with the distribution.
13

    
14
# * Neither the name of ytranslate nor the names of its
15
#   contributors may be used to endorse or promote products derived from
16
#   this software without specific prior written permission.
17

    
18
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28

    
29
"""Class containing the Macro class."""
30

    
31
from scripting.key import key_name
32

    
33
class Macro:
34

    
35
    """A macro object.
36

37
    In a MUD client terminology, a macro is a link between a shortcut
38
    key and an action that is sent to the MUD.  For example, the F1
39
    shortcut could send 'north' to the MUD.
40

41
    """
42

    
43
    def __init__(self, key, modifiers, action, sharp):
44
        self.key = key
45
        self.modifiers = modifiers
46
        self.action = action
47
        self.sharp_engine = sharp
48

    
49
        # Set the trigger's level
50
        self.level = sharp.engine.level
51

    
52
    def __repr__(self):
53
        return "<Macro {}: {} (level={})>".format(self.shortcut,
54
                self.action, self.level.name)
55

    
56
    @property
57
    def shortcut(self):
58
        """Return the key name."""
59
        return key_name(self.key, self.modifiers)
60

    
61
    @property
62
    def copied(self):
63
        """Return another object of the Macro class with identical info."""
64
        copy = Macro(self.key, self.modifiers, self.action,
65
                self.sharp_engine)
66
        copy.level = self.level
67
        return copy
68

    
69
    def execute(self, engine, client):
70
        """Execute the macro."""
71
        client.write(self.action + "\r\n")
(4-4/5)