Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[3.x] Expose visual script custom node type hints #50705

Merged
merged 1 commit into from
Jul 22, 2021
Merged

[3.x] Expose visual script custom node type hints #50705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions modules/visual_script/doc_classes/VisualScriptCustomNode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,24 @@
Return the count of input value ports.
</description>
</method>
<method name="_get_input_value_port_hint" qualifiers="virtual">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints.
</description>
</method>
<method name="_get_input_value_port_hint_string" qualifiers="virtual">
<return type="String">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified input port's hint string.
</description>
</method>
<method name="_get_input_value_port_name" qualifiers="virtual">
<return type="String">
</return>
Expand Down Expand Up @@ -71,13 +89,31 @@
Return the amount of output value ports.
</description>
</method>
<method name="_get_output_value_port_hint" qualifiers="virtual">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints.
</description>
</method>
<method name="_get_output_value_port_hint_string" qualifiers="virtual">
<return type="String">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified output port's hint string.
</description>
</method>
<method name="_get_output_value_port_name" qualifiers="virtual">
<return type="String">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified output's name.
Return the specified output port's name.
</description>
</method>
<method name="_get_output_value_port_type" qualifiers="virtual">
Expand All @@ -86,7 +122,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified output's type. See the [enum Variant.Type] values.
Return the specified output port's type. See the [enum Variant.Type] values.
</description>
</method>
<method name="_get_text" qualifiers="virtual">
Expand Down
32 changes: 32 additions & 0 deletions modules/visual_script/visual_script_nodes.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2736,6 +2736,12 @@ PropertyInfo VisualScriptCustomNode::get_input_value_port_info(int p_idx) const
if (get_script_instance() && get_script_instance()->has_method("_get_input_value_port_name")) {
info.name = get_script_instance()->call("_get_input_value_port_name", p_idx);
}
if (get_script_instance() && get_script_instance()->has_method("_get_input_value_port_hint")) {
info.hint = PropertyHint(int(get_script_instance()->call("_get_input_value_port_hint", p_idx)));
}
if (get_script_instance() && get_script_instance()->has_method("_get_input_value_port_hint_string")) {
info.hint_string = get_script_instance()->call("_get_input_value_port_hint_string", p_idx);
}
return info;
}

Expand All @@ -2747,9 +2753,31 @@ PropertyInfo VisualScriptCustomNode::get_output_value_port_info(int p_idx) const
if (get_script_instance() && get_script_instance()->has_method("_get_output_value_port_name")) {
info.name = get_script_instance()->call("_get_output_value_port_name", p_idx);
}
if (get_script_instance() && get_script_instance()->has_method("_get_output_value_port_hint")) {
info.hint = PropertyHint(int(get_script_instance()->call("_get_output_value_port_hint", p_idx)));
}
if (get_script_instance() && get_script_instance()->has_method("_get_output_value_port_hint_string")) {
info.hint_string = get_script_instance()->call("_get_output_value_port_hint_string", p_idx);
}
return info;
}

VisualScriptCustomNode::TypeGuess VisualScriptCustomNode::guess_output_type(TypeGuess *p_inputs, int p_output) const {
TypeGuess tg;
PropertyInfo pi = VisualScriptCustomNode::get_output_value_port_info(p_output);
tg.type = pi.type;
if (pi.type == Variant::OBJECT) {
if (pi.hint == PROPERTY_HINT_RESOURCE_TYPE) {
if (pi.hint_string.is_resource_file()) {
tg.script = ResourceLoader::load(pi.hint_string);
} else if (ClassDB::class_exists(pi.hint_string)) {
tg.gdclass = pi.hint_string;
}
}
}
return tg;
}

String VisualScriptCustomNode::get_caption() const {
if (get_script_instance() && get_script_instance()->has_method("_get_caption")) {
return get_script_instance()->call("_get_caption");
Expand Down Expand Up @@ -2871,9 +2899,13 @@ void VisualScriptCustomNode::_bind_methods() {

BIND_VMETHOD(MethodInfo(Variant::INT, "_get_input_value_port_type", PropertyInfo(Variant::INT, "idx")));
BIND_VMETHOD(MethodInfo(Variant::STRING, "_get_input_value_port_name", PropertyInfo(Variant::INT, "idx")));
BIND_VMETHOD(MethodInfo(Variant::INT, "_get_input_value_port_hint", PropertyInfo(Variant::INT, "idx")));
BIND_VMETHOD(MethodInfo(Variant::STRING, "_get_input_value_port_hint_string", PropertyInfo(Variant::INT, "idx")));

BIND_VMETHOD(MethodInfo(Variant::INT, "_get_output_value_port_type", PropertyInfo(Variant::INT, "idx")));
BIND_VMETHOD(MethodInfo(Variant::STRING, "_get_output_value_port_name", PropertyInfo(Variant::INT, "idx")));
BIND_VMETHOD(MethodInfo(Variant::INT, "_get_output_value_port_hint", PropertyInfo(Variant::INT, "idx")));
BIND_VMETHOD(MethodInfo(Variant::STRING, "_get_output_value_port_hint_string", PropertyInfo(Variant::INT, "idx")));

BIND_VMETHOD(MethodInfo(Variant::STRING, "_get_caption"));
BIND_VMETHOD(MethodInfo(Variant::STRING, "_get_text"));
Expand Down
2 changes: 2 additions & 0 deletions modules/visual_script/visual_script_nodes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,8 @@ class VisualScriptCustomNode : public VisualScriptNode {

virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);

virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;

void _script_changed();

VisualScriptCustomNode();
Expand Down