2017-03-05 14:47:28 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* visual_script_flow_control.h */
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* This file is part of: */
|
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 12:16:55 +00:00
|
|
|
/* https://godotengine.org */
|
2017-03-05 14:47:28 +00:00
|
|
|
/*************************************************************************/
|
2021-01-01 19:13:46 +00:00
|
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
|
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
2017-03-05 14:47:28 +00:00
|
|
|
/* */
|
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
|
/* the following conditions: */
|
|
|
|
|
/* */
|
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
|
/* */
|
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
|
/*************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2016-08-02 22:11:05 +00:00
|
|
|
#ifndef VISUAL_SCRIPT_FLOW_CONTROL_H
|
|
|
|
|
#define VISUAL_SCRIPT_FLOW_CONTROL_H
|
|
|
|
|
|
|
|
|
|
#include "visual_script.h"
|
|
|
|
|
|
|
|
|
|
class VisualScriptReturn : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptReturn, VisualScriptNode);
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
Variant::Type type;
|
|
|
|
|
bool with_value;
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
protected:
|
2016-08-02 22:11:05 +00:00
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
void set_return_type(Variant::Type);
|
|
|
|
|
Variant::Type get_return_type() const;
|
|
|
|
|
|
|
|
|
|
void set_enable_return_value(bool p_enable);
|
|
|
|
|
bool is_return_value_enabled() const;
|
|
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
VisualScriptReturn();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class VisualScriptCondition : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptCondition, VisualScriptNode);
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
VisualScriptCondition();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class VisualScriptWhile : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptWhile, VisualScriptNode);
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
VisualScriptWhile();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class VisualScriptIterator : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptIterator, VisualScriptNode);
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
VisualScriptIterator();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class VisualScriptSequence : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptSequence, VisualScriptNode);
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
int steps;
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
void set_steps(int p_steps);
|
|
|
|
|
int get_steps() const;
|
|
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-02 22:11:05 +00:00
|
|
|
|
|
|
|
|
VisualScriptSequence();
|
|
|
|
|
};
|
|
|
|
|
|
2016-08-31 15:49:45 +00:00
|
|
|
class VisualScriptSwitch : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptSwitch, VisualScriptNode);
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2016-08-31 15:49:45 +00:00
|
|
|
struct Case {
|
|
|
|
|
Variant::Type type;
|
2017-03-05 15:44:50 +00:00
|
|
|
Case() { type = Variant::NIL; }
|
2016-08-31 15:49:45 +00:00
|
|
|
};
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2016-08-31 15:49:45 +00:00
|
|
|
Vector<Case> case_values;
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
friend class VisualScriptNodeInstanceSwitch;
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
protected:
|
|
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
|
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
|
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
2016-08-31 15:49:45 +00:00
|
|
|
|
2016-08-07 22:22:33 +00:00
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2021-02-11 17:18:45 +00:00
|
|
|
virtual void reset_state() override;
|
|
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
|
|
|
|
virtual bool has_mixed_input_and_sequence_ports() const override { return true; }
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-07 22:22:33 +00:00
|
|
|
|
2016-08-31 15:49:45 +00:00
|
|
|
VisualScriptSwitch();
|
2016-08-07 22:22:33 +00:00
|
|
|
};
|
|
|
|
|
|
2016-08-25 20:45:20 +00:00
|
|
|
class VisualScriptTypeCast : public VisualScriptNode {
|
2019-03-19 18:35:57 +00:00
|
|
|
GDCLASS(VisualScriptTypeCast, VisualScriptNode);
|
2016-08-25 20:45:20 +00:00
|
|
|
|
|
|
|
|
StringName base_type;
|
|
|
|
|
String script;
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_output_sequence_port_count() const override;
|
|
|
|
|
virtual bool has_input_sequence_port() const override;
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_output_sequence_port_text(int p_port) const override;
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual int get_input_value_port_count() const override;
|
|
|
|
|
virtual int get_output_value_port_count() const override;
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual PropertyInfo get_input_value_port_info(int p_idx) const override;
|
|
|
|
|
virtual PropertyInfo get_output_value_port_info(int p_idx) const override;
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual String get_caption() const override;
|
|
|
|
|
virtual String get_text() const override;
|
|
|
|
|
virtual String get_category() const override { return "flow_control"; }
|
2016-08-25 20:45:20 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
void set_base_type(const StringName &p_type);
|
2016-08-25 20:45:20 +00:00
|
|
|
StringName get_base_type() const;
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
void set_base_script(const String &p_path);
|
2016-08-25 20:45:20 +00:00
|
|
|
String get_base_script() const;
|
|
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const override;
|
2017-07-01 00:30:17 +00:00
|
|
|
|
2020-07-10 10:34:39 +00:00
|
|
|
virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance) override;
|
2016-08-25 20:45:20 +00:00
|
|
|
|
|
|
|
|
VisualScriptTypeCast();
|
|
|
|
|
};
|
|
|
|
|
|
2016-08-02 22:11:05 +00:00
|
|
|
void register_visual_script_flow_control_nodes();
|
|
|
|
|
|
|
|
|
|
#endif // VISUAL_SCRIPT_FLOW_CONTROL_H
|
