Skip to content

OcclusionMode

Bases: _DataSetIntFlags

This enum class provides the integer values for the different occlusion mode flags that can be used in the 'Modify Attribute' effect with the 'OcclusionMode' attribute. This is a combinable bit field.

Examples

Source code in AoE2ScenarioParser/datasets/trigger_lists/occlusion_mode.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class OcclusionMode(_DataSetIntFlags):
    """
    This enum class provides the integer values for the different occlusion mode flags that can be used in the 'Modify
    Attribute' effect with the 'OcclusionMode' attribute. This is a combinable bit field.

    **Examples**



    """
    NO_OCCLUSION = 0
    """
    No outline
    """
    DISPLAY_OUTLINE = 1
    """
    Display outline when behind other units that have flag 2
    """
    OCCLUDES_OTHERS = 2
    """
    Other units' outlines are rendered when they are behind this unit
    """
    DISPLAY_OUTLINE_FOR_FOUNDATION = 4
    """
    Display outline on this unit's foundation when behind other units that have flag 
    """

Attributes

NO_OCCLUSION = 0 class-attribute instance-attribute

Value: 0

No outline

DISPLAY_OUTLINE = 1 class-attribute instance-attribute

Value: 1

Display outline when behind other units that have flag 2

OCCLUDES_OTHERS = 2 class-attribute instance-attribute

Value: 2

Other units' outlines are rendered when they are behind this unit

DISPLAY_OUTLINE_FOR_FOUNDATION = 4 class-attribute instance-attribute

Value: 4

Display outline on this unit's foundation when behind other units that have flag