InterDVDMenu

Inherits: Resource < RefCounted < Object

Still or motion DVD menu with up to 36 buttons.

Description

Used when authoring VMG/VTSM menus. Playback happens on a burnt disc, not in the editor. Set Resource.resource_name so button destination dropdowns can label this menu.

Properties

int	button_group_mask	4096
Array[InterDVDButton]	buttons	[]
InterDVDCell	cell
PackedColorArray	clut	PackedColorArray()
int	default_button	1
int	forced_activated_button	0
int	forced_selected_button	0
MenuType	menu_type	2
bool	motion	false
int	next_pgc	1
int	prev_pgc	1
int	parental_id	0
int	uops	0
int	goup_pgc	0
int	title_set_nr	0
int	still_time	0

---

Enumerations

enum MenuType: 🔗

MenuType MENU_TITLE = 2

Title menu.

MenuType MENU_ROOT = 3

Root menu.

MenuType MENU_SUBPICTURE = 4

Subpicture menu.

MenuType MENU_AUDIO = 5

Audio menu.

MenuType MENU_ANGLE = 6

Angle menu.

MenuType MENU_CHAPTER = 7

Chapter menu.

---

Property Descriptions

int button_group_mask = 4096 🔗

• void set_button_group_mask(value: int)

• int get_button_group_mask()

HLI BTN_MD word. Default 0x1000 is one 4:3 group (libdvdread: reserved zero1=0, btngr_ns=1). Do not use 0x4000; that sets zero1 and leaves btngr_ns=0.

---

Array[InterDVDButton] buttons = [] 🔗

• void set_buttons(value: Array[InterDVDButton])

• Array[InterDVDButton] get_buttons()

Menu buttons (capped at 36).

---

InterDVDCell cell 🔗

• void set_cell(value: InterDVDCell)

• InterDVDCell get_cell()

Still or motion background cell. Uses the same mux path as a title video cell.

---

PackedColorArray clut = PackedColorArray() 🔗

• void set_clut(value: PackedColorArray)

• PackedColorArray get_clut()

Optional 16-entry PGC palette. Empty keeps the default gold highlight colors.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedColorArray for more details.

---

int default_button = 1 🔗

• void set_default_button(value: int)

• int get_default_button()

Forced-selected button on the first NAV pack (1-36).

---

int forced_activated_button = 0 🔗

• void set_forced_activated_button(value: int)

• int get_forced_activated_button()

HLI forced-activated button, or 0 for none.

---

int forced_selected_button = 0 🔗

• void set_forced_selected_button(value: int)

• int get_forced_selected_button()

HLI forced-selected button override, or 0 to use default_button.

---

MenuType menu_type = 2 🔗

• void set_menu_type(value: MenuType)

• MenuType get_menu_type()

PGCI_UT menu id: Title 2, Root 3, Subpicture 4, Audio 5, Angle 6, Chapter 7.

---

bool motion = false 🔗

• void set_motion(value: bool)

• bool is_motion()

If true, the menu uses a motion video cell.

---

int next_pgc = 1 🔗

• void set_next_pgc(value: int)

• int get_next_pgc()

Next PGC number (default loops this menu).

---

int prev_pgc = 1 🔗

• void set_prev_pgc(value: int)

• int get_prev_pgc()

Previous PGC number.

---

int parental_id = 0 🔗

• void set_parental_id(value: int)

• int get_parental_id()

Parental id written on the menu PGCI search pointer.

---

int uops = 0 🔗

• void set_uops(value: int)

• int get_uops()

Prohibited user operations for this menu PGC.

---

int goup_pgc = 0 🔗

• void set_goup_pgc(value: int)

• int get_goup_pgc()

Go-Up PGC number.

---

int title_set_nr = 0 🔗

• void set_title_set_nr(value: int)

• int get_title_set_nr()

VTS number for VTSM menus. Title menus stay in VMGM (0).

---

int still_time = 0 🔗

• void set_still_time(value: int)

• int get_still_time()

PGC still time in seconds (255 = infinite).