OverlayContainer
Inherits: Container
Manages the layout for multiple OverlayProvider nodes.
Description
The OverlayContainer is meant to be added to the main UI scene to provide a place to add an arbitrary number of OverlayProvider nodes and manage their layout and ordering.
Properties
| Type | Name | Default |
|---|---|---|
| Dictionary | overlays | {} |
| CustomLogger | logger |
Methods
| Returns | Signature |
|---|---|
| void | add_overlay(overlay: OverlayProvider) |
| void | remove_overlay(overlay: OverlayProvider) |
Property Descriptions
overlays
Dictionary overlays = {}
Dictionary of {provider_id: <OverlayProvider>}.
logger
CustomLogger logger
Note
There is currently no description for this property. Please help us by contributing one!
Method Descriptions
add_overlay()
void add_overlay(overlay: OverlayProvider)
Add the given overlay to the overlay container
remove_overlay()
void remove_overlay(overlay: OverlayProvider)
Remove the given overlay from the overlay container.