Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

SubViewportContainer

继承： Container < Control < CanvasItem < Node < Object

用于显示 SubViewport 内容的容器。

描述

显示其 SubViewport 子节点内容的容器。除非启用 stretch，否则会使用 SubViewport 的大小作为最小尺寸。

注意：更改 SubViewportContainer 的 Control.scale，将导致其内容出现扭曲。要更改其视觉大小，并且不造成失真，请改为调整节点的边距（如果还不在容器中）。

注意：该 SubViewportContainer 会将鼠标进入和鼠标退出通知转发到子视口。

属性

FocusMode

focus_mode

1 (overrides Control)

bool

mouse_target

false

bool

stretch

false

int

stretch_shrink

1

方法

bool

_propagate_input_event(event: InputEvent) virtual const

属性说明

bool mouse_target = false 🔗

  • void set_mouse_target(value: bool)

  • bool is_mouse_target_enabled()

配置 SubViewportContainer 或其 SubViewport 子节点中的 Control 节点是否应作为鼠标相关功能的目标，例如在拖放操作中识别放置目标或悬停的 Control 节点的光标形状。

如果为 false，则视其 SubViewport 子节点中的 Control 节点为目标。

如果为 true，则视 SubViewportContainer 本身为目标。

bool stretch = false 🔗

  • void set_stretch(value: bool)

  • bool is_stretch_enabled()

如果为 true，子视口将自动调整为该控件的大小。

注意：如果为 true，则会禁止手动改变其子节点的 SubViewport.size。

int stretch_shrink = 1 🔗

  • void set_stretch_shrink(value: int)

  • int get_stretch_shrink()

将子视口的有效分辨率除以该值，同时保持比例。可以用来加速渲染。

例如子视口的大小为 1280×720，当 stretch_shrink 被设置为 2 时，将以 640×360 渲染，同时在该容器中占据相同大小。

注意：stretch 必须为 true，才能使此属性生效。

方法说明

bool _propagate_input_event(event: InputEvent) virtual const 🔗

实验性： 未来版本中可能会修改或移除该方法。

由用户实现的虚方法。如果它返回 true，则 event 将被传播到 SubViewport 子级。如果返回 false，则传播不会发生。如果未实现该功能，则所有事件都会被传播到子视口。