InterDVDHotspot

Inherits: Control < CanvasItem < Node < Object

A 720×480 highlight button that compiles to InterDVDButton.

Description

Place under InterDVDTitle or InterDVDMenuPage. The Control rect becomes the PCI highlight. destination points at a sibling title, chapter, or menu page; InterDVDDisc.build_project() resolves it to a title number.

Properties

Action

action

0

NodePath

destination

NodePath("")

int

stream

0

bool

subtitle_on

true

int

target

1

bool

auto_action

false

bool

hidden

false

bool

forced_selected

false

bool

forced_activated

false

bool

numeric_select

true

Color

select_color

Color(1, 0.92, 0.2, 1)

Color

action_color

Color(1, 0.35, 0.1, 1)

PackedByteArray

command

PackedByteArray()

Methods

InterDVDButton

compile_button() const

Property Descriptions

Action action = 0 🔗

DVD navigation action written on the compiled button.

NodePath destination = NodePath("") 🔗

Target InterDVDTitle, InterDVDChapter, or InterDVDMenuPage. Empty keeps target.

int stream = 0 🔗

  • void set_stream(value: int)

  • int get_stream()

Stream index for Set Audio / Subtitle / Angle.

bool subtitle_on = true 🔗

  • void set_subtitle_on(value: bool)

  • bool get_subtitle_on()

On/off for Set Subtitle.

int target = 1 🔗

  • void set_target(value: int)

  • int get_target()

Numeric destination when destination is empty (chapter, PGC, or cell). Jump Menu defaults to Title Menu (2).

bool auto_action = false 🔗

  • void set_auto_action(value: bool)

  • bool get_auto_action()

Activate the button when highlighted.

bool hidden = false 🔗

  • void set_hidden(value: bool)

  • bool is_hidden()

Hide the highlight until selected.

bool forced_selected = false 🔗

  • void set_forced_selected(value: bool)

  • bool is_forced_selected()

Force this button as the selected highlight.

bool forced_activated = false 🔗

  • void set_forced_activated(value: bool)

  • bool is_forced_activated()

Force-activate this button.

bool numeric_select = true 🔗

  • void set_numeric_select(value: bool)

  • bool get_numeric_select()

Allow numeric remote selection.

Color select_color = Color(1, 0.92, 0.2, 1) 🔗

  • void set_select_color(value: Color)

  • Color get_select_color()

Highlight color when selected.

Color action_color = Color(1, 0.35, 0.1, 1) 🔗

  • void set_action_color(value: Color)

  • Color get_action_color()

Highlight color when activated.

PackedByteArray command = PackedByteArray() 🔗

Raw 8-byte VM command when action is Custom.

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

Method Descriptions

InterDVDButton compile_button() const 🔗

Builds an InterDVDButton from this Control's rect, action, and stream fields.