Skip to content

custom_menu

ActionModel

Bases: BaseSettingsModel

Action Definition

Source code in server/settings/custom_menu.py
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
class ActionModel(BaseSettingsModel):
    """Action Definition"""
    title: str = SettingsField("", title="Title")
    flame_context: str = SettingsField(
        "FlameMenuUniversal",
        title="Flame Context",
        enum_resolver=lambda: [
            "ALL",
            "FlameMenuUniversal",
            "FlameMenuTimeline",
            "FlameMenuBatch",
        ]
    )
    source_type: str = SettingsField(
        "file",
        title="Source Type",
        enum_resolver=source_type_enum_resolver,
        conditional_enum=True,
    )
    python: str = SettingsField(
        "",
        title="Python",
        widget="textarea",
        syntax="python",
    )
    file: str = SettingsField("", title="Filepath")

CustomMenuItemDefinition

Bases: BaseSettingsModel

Custom item Definition

Source code in server/settings/custom_menu.py
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class CustomMenuItemDefinition(BaseSettingsModel):
    """Custom item Definition"""
    _layout = "expanded"

    item_type: str = SettingsField(
        "action",
        title="Type",
        enum_resolver=item_type_enum_resolver,
        conditional_enum=True,
    )
    action: ActionModel = ActionModel(
        default_factory=ActionModel,
    )
    menu: MenuItemModel = SettingsField(
        default_factory=MenuItemModel,
    )

CustomMenuSettings

Bases: BaseSettingsModel

Flame script menu project settings.

Source code in server/settings/custom_menu.py
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class CustomMenuSettings(BaseSettingsModel):
    """Flame script menu project settings."""
    _isGroup = True

    name: str = SettingsField(title="Menu name")
    enabled: bool = SettingsField(title="enabled", default=False)
    definition: list[CustomMenuItemDefinition] = SettingsField(
        default_factory=list,
        title="Definition",
        description="Custom Menu Items Definition"
    )

MenuItemDefinition

Bases: BaseSettingsModel

Item Definition

Source code in server/settings/custom_menu.py
52
53
54
55
56
57
58
59
60
61
62
63
64
class MenuItemDefinition(BaseSettingsModel):
    """Item Definition"""
    _layout = "expanded"

    item_type: str = SettingsField(
        "action",
        title="Type",
        enum_resolver=menu_item_type_enum_resolver,
        conditional_enum=True,
    )
    action: ActionModel = ActionModel(
        default_factory=ActionModel,
    )