GodotProjects/Sprout/addons/dialogic/Events/Signal/event_signal.gd
2023-01-03 16:54:53 -07:00

54 lines
1.6 KiB
GDScript

@tool
class_name DialogicSignalEvent
extends DialogicEvent
## Event that emits the Dialogic.signal_event signal with an argument.
## You can connect to this signal like this: `Dialogic.signal_event.connect(myfunc)`
### Settings
## The argument that will be provided with the signal.
var argument: String = ""
################################################################################
## EXECUTE
################################################################################
func _execute() -> void:
dialogic.emit_signal('signal_event', argument)
finish()
################################################################################
## INITIALIZE
################################################################################
func _init() -> void:
event_name = "Signal"
set_default_color('Color1')
event_category = Category.Godot
event_sorting_index = 0
################################################################################
## SAVING/LOADING
################################################################################
func get_shortcode() -> String:
return "signal"
func get_shortcode_parameters() -> Dictionary:
return {
#param_name : property_info
"arg" : {"property": "argument", "default": ""},
}
################################################################################
## EDITOR REPRESENTATION
################################################################################
func build_event_editor():
add_header_edit('argument', ValueType.SinglelineText, 'Emit "signal_event" signal with argument')