guidance_panel.gd

Go to the documentation of this file.

extends RefCounted
 
 
 
 
 
func create(parent:Control, options:Dictionary = {}) -> PanelContainer:
    var panel = PanelContainer.new()
    panel.name = str(options.get("name", "GuidancePanel"))
    panel.size_flags_horizontal = Control.SIZE_EXPAND_FILL
    panel.add_theme_stylebox_override("panel", _style(options))
    var body = VBoxContainer.new()
    body.name = "Body"
    body.add_theme_constant_override("separation", int(options.get("separation", 4)))
    panel.add_child(body)
    var title_parent:Control = body
    if bool(options.get("closeable", false)):
        var title_row = HBoxContainer.new()
        title_row.name = "TitleRow"
        title_row.size_flags_horizontal = Control.SIZE_EXPAND_FILL
        body.add_child(title_row)
        title_parent = title_row
    var title = Label.new()
    title.name = "Title"
    title.text = str(options.get("title", "Guide"))
    title.add_theme_font_size_override("font_size", int(options.get("title_size", 16)))
    title.add_theme_color_override("font_color", Color(str(options.get("title_color", "#f4d06f"))))
    title.size_flags_horizontal = Control.SIZE_EXPAND_FILL
    title_parent.add_child(title)
    if bool(options.get("closeable", false)):
        var close = Button.new()
        close.name = "Close"
        close.text = str(options.get("close_label", "Hide"))
        close.custom_minimum_size = Vector2(62, 32)
        var callback = options.get("close_callback", Callable())
        close.pressed.connect(func():
            panel.visible = false
            if callback.is_valid():
                callback.call()
        )
        title_parent.add_child(close)
    var text = Label.new()
    text.name = "Text"
    text.text = str(options.get("text", ""))
    text.autowrap_mode = TextServer.AUTOWRAP_WORD_SMART
    text.add_theme_font_size_override("font_size", int(options.get("text_size", 14)))
    text.add_theme_color_override("font_color", Color(str(options.get("text_color", "#dce7f2"))))
    body.add_child(text)
    parent.add_child(panel)
    return panel
 
 
 
func render(panel:PanelContainer, title_text:String, body_text:String, options:Dictionary = {}) -> void:
    if panel == null:
        return
    panel.visible = body_text.strip_edges() != ""
    if options.has("background") or options.has("border"):
        panel.add_theme_stylebox_override("panel", _style(options))
    var title = panel.get_node_or_null("Body/Title")
    if title == null:
        title = panel.get_node_or_null("Body/TitleRow/Title")
    if title != null:
        title.text = title_text
        if options.has("title_size"):
            title.add_theme_font_size_override("font_size", int(options.get("title_size", 16)))
    var text = panel.get_node_or_null("Body/Text")
    if text != null:
        text.text = body_text
        if options.has("text_size"):
            text.add_theme_font_size_override("font_size", int(options.get("text_size", 14)))
 
 
func _style(options:Dictionary) -> StyleBoxFlat:
    var style = StyleBoxFlat.new()
    style.bg_color = Color(str(options.get("background", "#15212b")))
    style.border_color = Color(str(options.get("border", "#3c5062")))
    style.set_border_width_all(int(options.get("border_width", 1)))
    style.set_corner_radius_all(int(options.get("radius", 6)))
    style.content_margin_left = int(options.get("margin_left", 10))
    style.content_margin_right = int(options.get("margin_right", 10))
    style.content_margin_top = int(options.get("margin_top", 8))
    style.content_margin_bottom = int(options.get("margin_bottom", 8))
    return style