Skip to content

OverlayProvider

Inherits: Control

Base class to use when writing a new overlay.

Description

An OverlayProvider is a Control node that is meant to work as an overlay. To write a new overlay, create a new class that extends from this one.

Properties

Type Name Default
String provider_id
Texture2D icon
bool managed true
CustomLogger logger

Property Descriptions

provider_id

String provider_id

Unique identifier for the overlay provider

icon

Texture2D icon

Icon associated with the overlay provider

managed

bool managed = true

Whether or not the overlay's layout should be managed by an OverlayContainer

logger

CustomLogger logger

Note

There is currently no description for this property. Please help us by contributing one!