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

Hérite de : Container < Control < CanvasItem < Node < Object

Un conteneur utilisé pour afficher le contenu d'un SubViewport.

Description

Un conteneur qui affiche le contenu des nœuds enfants SubViewport sous-jacents. Il utilise la taille combinée des SubViewport comme taille minimale, à moins que stretch ne soit activé.

Note : Modifier l'échelle Control.scale d'un SubViewportContainer fera apparaître son contenu comme déformé. Pour changer sa taille visuelle sans causer de déformation, ajustez les marges du nœud à la place (s'il n'est pas déjà dans un conteneur).

Note : Le SubViewportContainer transmet les notifications d'entrée et de sortie de la souris à ses sub-viewports.

Propriétés

FocusMode

focus_mode

1 (overrides Control)

bool

mouse_target

false

bool

stretch

false

int

stretch_shrink

1

Méthodes

bool

_propagate_input_event(event: InputEvent) virtual const

Descriptions des propriétés

bool mouse_target = false 🔗

  • void set_mouse_target(value: bool)

  • bool is_mouse_target_enabled()

Configure, si soit le SubViewportContainer ou soit les nœuds Control de ses enfants SubViewport devraient être disponibles comme cibles de fonctionnalités liées à la souris, comme l'identification de la cible du dépôt dans les opérations de glisser-déposer ou la forme de curseur du nœud Control survolé.

Si false, les nœuds Control à l'intérieur de ses enfants SubViewport sont considérés comme des cibles.

Si true, le SubViewportContainer lui-même sera considéré comme une cible.

bool stretch = false 🔗

  • void set_stretch(value: bool)

  • bool is_stretch_enabled()

Si true, le sub-viewport sera automatiquement redimensionné à la taille du contrôle.

Note : Si true, cela interdira de changer le SubViewport.size de ses enfants manuellement.

int stretch_shrink = 1 🔗

  • void set_stretch_shrink(value: int)

  • int get_stretch_shrink()

Divise la résolution effective du sub-viewport par cette valeur tout en préservant son échelle. Cela peut être utilisé pour accélérer le rendu.

Par exemple, un sub-viewport de 1280×720 avec stretch_shrink défini à 2 sera rendu à 640×360 tout en occupant la même taille dans le conteneur.

Note : stretch doit valoir true pour que cette propriété fonctionne.

Descriptions des méthodes

bool _propagate_input_event(event: InputEvent) virtual const 🔗

Expérimental : Cette méthode peut être changée ou retirée dans de futures versions.

Méthode virtuelle à implémenter par l'utilisateur. Si elle renvoie true, l'événement event est propagé aux enfants SubViewport. La propagation n'arrive pas si elle renvoie false. Si la fonction n'est pas implémentée, tous les événements sont propagés aux SubViewports.