Skip to content

TriggerManagerDE

Classes

TriggerManagerDE

Bases: TriggerManager

Manager of all DE trigger related features

Source code in AoE2ScenarioParser/objects/managers/de/trigger_manager_de.py 
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
class TriggerManagerDE(TriggerManager):
    """Manager of all DE trigger related features"""
    _link_list = [
        RetrieverObjectLinkGroup("Triggers", group=[
            RetrieverObjectLink("triggers", link="trigger_data", process_as_object=Trigger),
            RetrieverObjectLink("trigger_display_order", link="trigger_display_order_array"),
            RetrieverObjectLink("variables", link="variable_data", process_as_object=Variable),
        ])
    ]

    def __init__(self, triggers: List[Trigger], trigger_display_order: List[int], variables: List[Variable], **kwargs):
        super().__init__(triggers, trigger_display_order, **kwargs)

        self.variables: List[Variable] = variables

    @property
    def variables(self) -> List[Variable]:
        """All currently renamed variables"""
        return self._variables

    @variables.setter
    def variables(self, value: List[Variable]):
        self._variables = UuidList(self._uuid, value)

    def add_variable(self, name: str, variable_id: int = -1) -> Variable:
        """
        Adds a variable.

        Args:
            name: The name for the variable
            variable_id: The ID of the variable. If left empty lowest available value will be used

        Returns:
            The newly renamed Variable
        """
        list_of_var_ids = [var.variable_id for var in self.variables]
        if variable_id == -1:
            for i in range(256):
                if i not in list_of_var_ids:
                    variable_id = i
                    break
            if variable_id == -1:
                raise IndexError(f"No variable ID available. All in use? In use: ({list_of_var_ids}/256)")
        if not (0 <= variable_id <= 255):
            raise ValueError("Variable ID has to fall between 0 and 255 (incl).")
        if variable_id in list_of_var_ids:
            raise ValueError("Variable ID already in use.")

        new_variable = Variable(variable_id=variable_id, name=name, uuid=self._uuid)
        self.variables.append(new_variable)
        return new_variable

    def get_variable(self, variable_id: int = None, variable_name: str = None) -> Optional[Variable]:
        """
        Get a specific variable

        Args:
            variable_id: The ID of the variable you want
            variable_name: The name of the variable you want

        Returns:
            The `Variable` object or None if it couldn't be found
        """
        if not mutually_exclusive(variable_id is not None, variable_name is not None):
            raise ValueError("Select a variable using either the variable_id or variable_name parameters.")
        for variable in self.variables:
            if variable.variable_id == variable_id or variable.name == variable_name:
                return variable
        return None

    def get_summary_as_string(self) -> str:
        """
        Create a human-readable string showcasing a summary of the content of the manager.
        This includes all triggers and the amount of conditions and effects they hold and also all renamed variables.

        Returns:
            The created string
        """
        return_string = super().get_summary_as_string()

        return_string += "\nVariables Summary:\n"
        if len(self.variables) == 0:
            return_string += "\t<< No Variables >>"

        longest_variable_name = -1
        for variable in self.variables:
            longest_variable_name = max(longest_variable_name, len(variable.name))

        longest_variable_name += 3
        for index, variable in enumerate(self.variables):
            var_name = variable.name
            name_buffer = " " * (longest_variable_name - len(var_name))
            return_string += f"\t{var_name}{name_buffer}[Index: {variable.variable_id}]\n"

        return return_string

    def get_content_as_string(self) -> str:
        """
        Create a human-readable string showcasing all content of the manager.
        This includes all triggers and their conditions and effects and also all renamed variables.

        This is also the function that is called when doing: `print(trigger_manager)`

        Returns:
            The created string
        """
        return_string = super().get_content_as_string()

        return_string += "Variables:\n"

        if len(self.variables) == 0:
            return_string += "\t<<No Variables>>\n"

        for variable in self.variables:
            return_string += f"\t'{variable.name}' [Index: {variable.variable_id}] ({variable._uuid})\n"

        return return_string

Attributes

variables: List[Variable] property writable
Type: List[Variable]

All currently renamed variables

Functions

def __init__(...)

Parameters:

Name Type Description Default
triggers List[Trigger] - required
trigger_display_order List[int] - required
variables List[Variable] - required
kwargs ? - {}
Source code in AoE2ScenarioParser/objects/managers/de/trigger_manager_de.py 
22
23
24
25
def __init__(self, triggers: List[Trigger], trigger_display_order: List[int], variables: List[Variable], **kwargs):
    super().__init__(triggers, trigger_display_order, **kwargs)

    self.variables: List[Variable] = variables
def add_variable(...)

Adds a variable.

Parameters:

Name Type Description Default
name str

The name for the variable

 required
variable_id int

The ID of the variable. If left empty lowest available value will be used

 -1

Returns:

Type Description
Variable

The newly renamed Variable
Source code in AoE2ScenarioParser/objects/managers/de/trigger_manager_de.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def add_variable(self, name: str, variable_id: int = -1) -> Variable:
    """
    Adds a variable.

    Args:
        name: The name for the variable
        variable_id: The ID of the variable. If left empty lowest available value will be used

    Returns:
        The newly renamed Variable
    """
    list_of_var_ids = [var.variable_id for var in self.variables]
    if variable_id == -1:
        for i in range(256):
            if i not in list_of_var_ids:
                variable_id = i
                break
        if variable_id == -1:
            raise IndexError(f"No variable ID available. All in use? In use: ({list_of_var_ids}/256)")
    if not (0 <= variable_id <= 255):
        raise ValueError("Variable ID has to fall between 0 and 255 (incl).")
    if variable_id in list_of_var_ids:
        raise ValueError("Variable ID already in use.")

    new_variable = Variable(variable_id=variable_id, name=name, uuid=self._uuid)
    self.variables.append(new_variable)
    return new_variable
def get_content_as_string(...)

Create a human-readable string showcasing all content of the manager. This includes all triggers and their conditions and effects and also all renamed variables.

This is also the function that is called when doing: print(trigger_manager)

Returns:

Type Description
str

The created string
Source code in AoE2ScenarioParser/objects/managers/de/trigger_manager_de.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def get_content_as_string(self) -> str:
    """
    Create a human-readable string showcasing all content of the manager.
    This includes all triggers and their conditions and effects and also all renamed variables.

    This is also the function that is called when doing: `print(trigger_manager)`

    Returns:
        The created string
    """
    return_string = super().get_content_as_string()

    return_string += "Variables:\n"

    if len(self.variables) == 0:
        return_string += "\t<<No Variables>>\n"

    for variable in self.variables:
        return_string += f"\t'{variable.name}' [Index: {variable.variable_id}] ({variable._uuid})\n"

    return return_string
def get_summary_as_string(...)

Create a human-readable string showcasing a summary of the content of the manager. This includes all triggers and the amount of conditions and effects they hold and also all renamed variables.

Returns:

Type Description
str

The created string
Source code in AoE2ScenarioParser/objects/managers/de/trigger_manager_de.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def get_summary_as_string(self) -> str:
    """
    Create a human-readable string showcasing a summary of the content of the manager.
    This includes all triggers and the amount of conditions and effects they hold and also all renamed variables.

    Returns:
        The created string
    """
    return_string = super().get_summary_as_string()

    return_string += "\nVariables Summary:\n"
    if len(self.variables) == 0:
        return_string += "\t<< No Variables >>"

    longest_variable_name = -1
    for variable in self.variables:
        longest_variable_name = max(longest_variable_name, len(variable.name))

    longest_variable_name += 3
    for index, variable in enumerate(self.variables):
        var_name = variable.name
        name_buffer = " " * (longest_variable_name - len(var_name))
        return_string += f"\t{var_name}{name_buffer}[Index: {variable.variable_id}]\n"

    return return_string
def get_variable(...)

Get a specific variable

Parameters:

Name Type Description Default
variable_id int

The ID of the variable you want

 None
variable_name str

The name of the variable you want

 None

Returns:

Type Description
Optional[Variable]

The Variable object or None if it couldn't be found
Source code in AoE2ScenarioParser/objects/managers/de/trigger_manager_de.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def get_variable(self, variable_id: int = None, variable_name: str = None) -> Optional[Variable]:
    """
    Get a specific variable

    Args:
        variable_id: The ID of the variable you want
        variable_name: The name of the variable you want

    Returns:
        The `Variable` object or None if it couldn't be found
    """
    if not mutually_exclusive(variable_id is not None, variable_name is not None):
        raise ValueError("Select a variable using either the variable_id or variable_name parameters.")
    for variable in self.variables:
        if variable.variable_id == variable_id or variable.name == variable_name:
            return variable
    return None

Functions