mirror of
https://github.com/tiennm99/godot.git
synced 2026-08-06 04:23:34 +00:00
Improve editor template workflow
Co-Authored-By: jmb462 <jmb462@gmail.com>
This commit is contained in:
fabriceci
committed by
jmb462
jmb462
co-authored by
jmb462
jmb462
parent
28174d531b
commit
9d5b807059
@@ -21,3 +21,5 @@ if env["tools"]:
|
||||
if env["tests"]:
|
||||
env_gdscript.Append(CPPDEFINES=["TESTS_ENABLED"])
|
||||
env_gdscript.add_source_files(env.modules_sources, "./tests/*.cpp")
|
||||
|
||||
SConscript("editor_templates/SCsub")
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# meta-description: Classic movement for gravity games (platformer, ...)
|
||||
|
||||
extends _BASE_
|
||||
|
||||
const SPEED: float = 300.0
|
||||
const JUMP_FORCE: float = -400.0
|
||||
|
||||
# Get the gravity from the project settings to be synced with RigidDynamicBody nodes.
|
||||
var gravity: int = ProjectSettings.get_setting("physics/2d/default_gravity")
|
||||
|
||||
|
||||
func _physics_process(delta: float) -> void:
|
||||
# Add the gravity.
|
||||
if not is_on_floor():
|
||||
motion_velocity.y += gravity * delta
|
||||
|
||||
# Handle Jump.
|
||||
if Input.is_action_just_pressed("ui_accept") and is_on_floor():
|
||||
motion_velocity.y = JUMP_FORCE
|
||||
|
||||
# Get the input direction and handle the movement/deceleration.
|
||||
# As good practice, you should replace UI actions with custom gameplay actions.
|
||||
var direction := Input.get_axis("ui_left", "ui_right")
|
||||
if direction:
|
||||
motion_velocity.x = direction * SPEED
|
||||
else:
|
||||
motion_velocity.x = move_toward(motion_velocity.x, 0, SPEED)
|
||||
|
||||
move_and_slide()
|
||||
@@ -0,0 +1,32 @@
|
||||
# meta-description: Classic movement for gravity games (FPS, TPS, ...)
|
||||
|
||||
extends _BASE_
|
||||
|
||||
const SPEED: float = 5.0
|
||||
const JUMP_FORCE: float = 4.5
|
||||
|
||||
# Get the gravity from the project settings to be synced with RigidDynamicBody nodes.
|
||||
var gravity: float = ProjectSettings.get_setting("physics/3d/default_gravity")
|
||||
|
||||
|
||||
func _physics_process(delta: float) -> void:
|
||||
# Add the gravity.
|
||||
if not is_on_floor():
|
||||
motion_velocity.y -= gravity * delta
|
||||
|
||||
# Handle Jump.
|
||||
if Input.is_action_just_pressed("ui_accept") and is_on_floor():
|
||||
motion_velocity.y = JUMP_FORCE
|
||||
|
||||
# Get the input direction and handle the movement/deceleration.
|
||||
# As good practice, you should replace UI actions with custom gameplay actions.
|
||||
var input_dir := Input.get_vector("ui_left", "ui_right", "ui_up", "ui_down")
|
||||
var direction := (transform.basis * Vector3(input_dir.x, 0, input_dir.y)).normalized()
|
||||
if direction:
|
||||
motion_velocity.x = direction.x * SPEED
|
||||
motion_velocity.z = direction.z * SPEED
|
||||
else:
|
||||
motion_velocity.x = move_toward(motion_velocity.x, 0, SPEED)
|
||||
motion_velocity.z = move_toward(motion_velocity.z, 0, SPEED)
|
||||
|
||||
move_and_slide()
|
||||
@@ -0,0 +1,11 @@
|
||||
# meta-description: Basic plugin template
|
||||
@tool
|
||||
extends EditorPlugin
|
||||
|
||||
func _enter_tree() -> void:
|
||||
# Initialization of the plugin goes here.
|
||||
pass
|
||||
|
||||
func _exit_tree() -> void:
|
||||
# Clean-up of the plugin goes here.
|
||||
pass
|
||||
@@ -0,0 +1,7 @@
|
||||
# meta-description: Basic editor script template
|
||||
@tool
|
||||
extends EditorScript
|
||||
|
||||
func _run() -> void:
|
||||
# Called when the script is executed (using File -> Run in Script Editor).
|
||||
pass
|
||||
@@ -0,0 +1,11 @@
|
||||
# meta-description: Base template for Node with default Godot cycle methods
|
||||
|
||||
extends _BASE_
|
||||
|
||||
# Called when the node enters the scene tree for the first time.
|
||||
func _ready() -> void:
|
||||
pass # Replace with function body.
|
||||
|
||||
# Called every frame. 'delta' is the elapsed time since the previous frame.
|
||||
func _process(delta: float) -> void:
|
||||
pass
|
||||
@@ -0,0 +1,3 @@
|
||||
# meta-description: Empty template suitable for all Objects
|
||||
|
||||
extends _BASE_
|
||||
@@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
Import("env")
|
||||
|
||||
import editor.template_builders as build_template_gd
|
||||
|
||||
env["BUILDERS"]["MakeGDTemplateBuilder"] = Builder(
|
||||
action=env.Run(build_template_gd.make_templates, "Generating GDScript templates header."),
|
||||
suffix=".h",
|
||||
src_suffix=".gd",
|
||||
)
|
||||
|
||||
# Template files
|
||||
templates_sources = Glob("*/*.gd")
|
||||
|
||||
env.Alias("editor_template_gd", [env.MakeGDTemplateBuilder("templates.gen.h", templates_sources)])
|
||||
@@ -49,6 +49,10 @@
|
||||
#include "tests/gdscript_test_runner.h"
|
||||
#endif
|
||||
|
||||
#ifdef TOOLS_ENABLED
|
||||
#include "editor/editor_settings.h"
|
||||
#endif
|
||||
|
||||
///////////////////////////
|
||||
|
||||
GDScriptNativeClass::GDScriptNativeClass(const StringName &p_name) {
|
||||
@@ -817,10 +821,16 @@ Error GDScript::reload(bool p_keep_state) {
|
||||
basedir = basedir.get_base_dir();
|
||||
}
|
||||
|
||||
if (source.find("%BASE%") != -1) {
|
||||
//loading a template, don't parse
|
||||
// Loading a template, don't parse.
|
||||
#ifdef TOOLS_ENABLED
|
||||
if (basedir.begins_with(EditorSettings::get_singleton()->get_project_script_templates_dir())) {
|
||||
return OK;
|
||||
}
|
||||
#else
|
||||
if (source.find("_BASE_") != -1) {
|
||||
return OK;
|
||||
}
|
||||
#endif
|
||||
|
||||
{
|
||||
String source_path = path;
|
||||
|
||||
+50
-51
@@ -396,7 +396,7 @@ public:
|
||||
_debug_call_stack_pos--;
|
||||
}
|
||||
|
||||
virtual Vector<StackInfo> debug_get_current_stack_info() {
|
||||
virtual Vector<StackInfo> debug_get_current_stack_info() override {
|
||||
if (Thread::get_main_id() != Thread::get_caller_id()) {
|
||||
return Vector<StackInfo>();
|
||||
}
|
||||
@@ -430,77 +430,76 @@ public:
|
||||
|
||||
_FORCE_INLINE_ static GDScriptLanguage *get_singleton() { return singleton; }
|
||||
|
||||
virtual String get_name() const;
|
||||
virtual String get_name() const override;
|
||||
|
||||
/* LANGUAGE FUNCTIONS */
|
||||
virtual void init();
|
||||
virtual String get_type() const;
|
||||
virtual String get_extension() const;
|
||||
virtual Error execute_file(const String &p_path);
|
||||
virtual void finish();
|
||||
virtual void init() override;
|
||||
virtual String get_type() const override;
|
||||
virtual String get_extension() const override;
|
||||
virtual Error execute_file(const String &p_path) override;
|
||||
virtual void finish() override;
|
||||
|
||||
/* EDITOR FUNCTIONS */
|
||||
virtual void get_reserved_words(List<String> *p_words) const;
|
||||
virtual bool is_control_flow_keyword(String p_keywords) const;
|
||||
virtual void get_comment_delimiters(List<String> *p_delimiters) const;
|
||||
virtual void get_string_delimiters(List<String> *p_delimiters) const;
|
||||
virtual String _get_processed_template(const String &p_template, const String &p_base_class_name) const;
|
||||
virtual Ref<Script> get_template(const String &p_class_name, const String &p_base_class_name) const;
|
||||
virtual bool is_using_templates();
|
||||
virtual void make_template(const String &p_class_name, const String &p_base_class_name, Ref<Script> &p_script);
|
||||
virtual bool validate(const String &p_script, const String &p_path = "", List<String> *r_functions = nullptr, List<ScriptLanguage::ScriptError> *r_errors = nullptr, List<ScriptLanguage::Warning> *r_warnings = nullptr, Set<int> *r_safe_lines = nullptr) const;
|
||||
virtual Script *create_script() const;
|
||||
virtual bool has_named_classes() const;
|
||||
virtual bool supports_builtin_mode() const;
|
||||
virtual bool supports_documentation() const;
|
||||
virtual bool can_inherit_from_file() const { return true; }
|
||||
virtual int find_function(const String &p_function, const String &p_code) const;
|
||||
virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const;
|
||||
virtual Error complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptCodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint);
|
||||
virtual void get_reserved_words(List<String> *p_words) const override;
|
||||
virtual bool is_control_flow_keyword(String p_keywords) const override;
|
||||
virtual void get_comment_delimiters(List<String> *p_delimiters) const override;
|
||||
virtual void get_string_delimiters(List<String> *p_delimiters) const override;
|
||||
virtual bool is_using_templates() override;
|
||||
virtual Ref<Script> make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const override;
|
||||
virtual Vector<ScriptTemplate> get_built_in_templates(StringName p_object) override;
|
||||
virtual bool validate(const String &p_script, const String &p_path = "", List<String> *r_functions = nullptr, List<ScriptLanguage::ScriptError> *r_errors = nullptr, List<ScriptLanguage::Warning> *r_warnings = nullptr, Set<int> *r_safe_lines = nullptr) const override;
|
||||
virtual Script *create_script() const override;
|
||||
virtual bool has_named_classes() const override;
|
||||
virtual bool supports_builtin_mode() const override;
|
||||
virtual bool supports_documentation() const override;
|
||||
virtual bool can_inherit_from_file() const override { return true; }
|
||||
virtual int find_function(const String &p_function, const String &p_code) const override;
|
||||
virtual String make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const override;
|
||||
virtual Error complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptCodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) override;
|
||||
#ifdef TOOLS_ENABLED
|
||||
virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result);
|
||||
virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) override;
|
||||
#endif
|
||||
virtual String _get_indentation() const;
|
||||
virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const;
|
||||
virtual void add_global_constant(const StringName &p_variable, const Variant &p_value);
|
||||
virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value);
|
||||
virtual void remove_named_global_constant(const StringName &p_name);
|
||||
virtual void auto_indent_code(String &p_code, int p_from_line, int p_to_line) const override;
|
||||
virtual void add_global_constant(const StringName &p_variable, const Variant &p_value) override;
|
||||
virtual void add_named_global_constant(const StringName &p_name, const Variant &p_value) override;
|
||||
virtual void remove_named_global_constant(const StringName &p_name) override;
|
||||
|
||||
/* DEBUGGER FUNCTIONS */
|
||||
|
||||
virtual String debug_get_error() const;
|
||||
virtual int debug_get_stack_level_count() const;
|
||||
virtual int debug_get_stack_level_line(int p_level) const;
|
||||
virtual String debug_get_stack_level_function(int p_level) const;
|
||||
virtual String debug_get_stack_level_source(int p_level) const;
|
||||
virtual void debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1);
|
||||
virtual void debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1);
|
||||
virtual ScriptInstance *debug_get_stack_level_instance(int p_level);
|
||||
virtual void debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1);
|
||||
virtual String debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems = -1, int p_max_depth = -1);
|
||||
virtual String debug_get_error() const override;
|
||||
virtual int debug_get_stack_level_count() const override;
|
||||
virtual int debug_get_stack_level_line(int p_level) const override;
|
||||
virtual String debug_get_stack_level_function(int p_level) const override;
|
||||
virtual String debug_get_stack_level_source(int p_level) const override;
|
||||
virtual void debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
|
||||
virtual void debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
|
||||
virtual ScriptInstance *debug_get_stack_level_instance(int p_level) override;
|
||||
virtual void debug_get_globals(List<String> *p_globals, List<Variant> *p_values, int p_max_subitems = -1, int p_max_depth = -1) override;
|
||||
virtual String debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems = -1, int p_max_depth = -1) override;
|
||||
|
||||
virtual void reload_all_scripts();
|
||||
virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload);
|
||||
virtual void reload_all_scripts() override;
|
||||
virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) override;
|
||||
|
||||
virtual void frame();
|
||||
virtual void frame() override;
|
||||
|
||||
virtual void get_public_functions(List<MethodInfo> *p_functions) const;
|
||||
virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const;
|
||||
virtual void get_public_functions(List<MethodInfo> *p_functions) const override;
|
||||
virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const override;
|
||||
|
||||
virtual void profiling_start();
|
||||
virtual void profiling_stop();
|
||||
virtual void profiling_start() override;
|
||||
virtual void profiling_stop() override;
|
||||
|
||||
virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max);
|
||||
virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max);
|
||||
virtual int profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) override;
|
||||
virtual int profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) override;
|
||||
|
||||
/* LOADER FUNCTIONS */
|
||||
|
||||
virtual void get_recognized_extensions(List<String> *p_extensions) const;
|
||||
virtual void get_recognized_extensions(List<String> *p_extensions) const override;
|
||||
|
||||
/* GLOBAL CLASSES */
|
||||
|
||||
virtual bool handles_global_class_type(const String &p_type) const;
|
||||
virtual String get_global_class_name(const String &p_path, String *r_base_type = nullptr, String *r_icon_path = nullptr) const;
|
||||
virtual bool handles_global_class_type(const String &p_type) const override;
|
||||
virtual String get_global_class_name(const String &p_path, String *r_base_type = nullptr, String *r_icon_path = nullptr) const override;
|
||||
|
||||
void add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass);
|
||||
Ref<GDScript> get_orphan_subclass(const String &p_qualified_name);
|
||||
|
||||
@@ -33,6 +33,7 @@
|
||||
#include "core/config/engine.h"
|
||||
#include "core/core_constants.h"
|
||||
#include "core/io/file_access.h"
|
||||
#include "editor_templates/templates.gen.h"
|
||||
#include "gdscript_analyzer.h"
|
||||
#include "gdscript_compiler.h"
|
||||
#include "gdscript_parser.h"
|
||||
@@ -55,68 +56,44 @@ void GDScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const {
|
||||
p_delimiters->push_back("\"\"\" \"\"\"");
|
||||
}
|
||||
|
||||
String GDScriptLanguage::_get_processed_template(const String &p_template, const String &p_base_class_name) const {
|
||||
String processed_template = p_template;
|
||||
|
||||
#ifdef TOOLS_ENABLED
|
||||
if (EDITOR_DEF("text_editor/completion/add_type_hints", false)) {
|
||||
processed_template = processed_template.replace("%INT_TYPE%", ": int");
|
||||
processed_template = processed_template.replace("%STRING_TYPE%", ": String");
|
||||
processed_template = processed_template.replace("%FLOAT_TYPE%", ": float");
|
||||
processed_template = processed_template.replace("%VOID_RETURN%", " -> void");
|
||||
} else {
|
||||
processed_template = processed_template.replace("%INT_TYPE%", "");
|
||||
processed_template = processed_template.replace("%STRING_TYPE%", "");
|
||||
processed_template = processed_template.replace("%FLOAT_TYPE%", "");
|
||||
processed_template = processed_template.replace("%VOID_RETURN%", "");
|
||||
}
|
||||
#else
|
||||
processed_template = processed_template.replace("%INT_TYPE%", "");
|
||||
processed_template = processed_template.replace("%STRING_TYPE%", "");
|
||||
processed_template = processed_template.replace("%FLOAT_TYPE%", "");
|
||||
processed_template = processed_template.replace("%VOID_RETURN%", "");
|
||||
#endif
|
||||
|
||||
processed_template = processed_template.replace("%BASE%", p_base_class_name);
|
||||
processed_template = processed_template.replace("%TS%", _get_indentation());
|
||||
|
||||
return processed_template;
|
||||
}
|
||||
|
||||
Ref<Script> GDScriptLanguage::get_template(const String &p_class_name, const String &p_base_class_name) const {
|
||||
String _template = "extends %BASE%\n"
|
||||
"\n"
|
||||
"\n"
|
||||
"# Declare member variables here. Examples:\n"
|
||||
"# var a%INT_TYPE% = 2\n"
|
||||
"# var b%STRING_TYPE% = \"text\"\n"
|
||||
"\n"
|
||||
"\n"
|
||||
"# Called when the node enters the scene tree for the first time.\n"
|
||||
"func _ready()%VOID_RETURN%:\n"
|
||||
"%TS%pass # Replace with function body.\n"
|
||||
"\n"
|
||||
"\n"
|
||||
"# Called every frame. 'delta' is the elapsed time since the previous frame.\n"
|
||||
"#func _process(delta%FLOAT_TYPE%)%VOID_RETURN%:\n"
|
||||
"#%TS%pass\n";
|
||||
|
||||
_template = _get_processed_template(_template, p_base_class_name);
|
||||
|
||||
Ref<GDScript> script;
|
||||
script.instantiate();
|
||||
script->set_source_code(_template);
|
||||
|
||||
return script;
|
||||
}
|
||||
|
||||
bool GDScriptLanguage::is_using_templates() {
|
||||
return true;
|
||||
}
|
||||
|
||||
void GDScriptLanguage::make_template(const String &p_class_name, const String &p_base_class_name, Ref<Script> &p_script) {
|
||||
String _template = _get_processed_template(p_script->get_source_code(), p_base_class_name);
|
||||
p_script->set_source_code(_template);
|
||||
Ref<Script> GDScriptLanguage::make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const {
|
||||
Ref<GDScript> script;
|
||||
script.instantiate();
|
||||
String processed_template = p_template;
|
||||
#ifdef TOOLS_ENABLED
|
||||
if (!EDITOR_DEF("text_editor/completion/add_type_hints", false)) {
|
||||
processed_template = processed_template.replace(": int", "")
|
||||
.replace(": String", "")
|
||||
.replace(": float", "")
|
||||
.replace(":=", "=")
|
||||
.replace(" -> void", "");
|
||||
}
|
||||
#else
|
||||
processed_template = processed_template.replace(": int", "")
|
||||
.replace(": String", "")
|
||||
.replace(": float", "")
|
||||
.replace(" -> void", "");
|
||||
#endif
|
||||
|
||||
processed_template = processed_template.replace("_BASE_", p_base_class_name)
|
||||
.replace("_CLASS_", p_class_name)
|
||||
.replace("_TS_", _get_indentation());
|
||||
script->set_source_code(processed_template);
|
||||
return script;
|
||||
}
|
||||
|
||||
Vector<ScriptLanguage::ScriptTemplate> GDScriptLanguage::get_built_in_templates(StringName p_object) {
|
||||
Vector<ScriptLanguage::ScriptTemplate> templates;
|
||||
for (int i = 0; i < TEMPLATES_ARRAY_SIZE; i++) {
|
||||
if (TEMPLATES[i].inherit == p_object) {
|
||||
templates.append(TEMPLATES[i]);
|
||||
}
|
||||
}
|
||||
return templates;
|
||||
}
|
||||
|
||||
static void get_function_names_recursively(const GDScriptParser::ClassNode *p_class, const String &p_prefix, Map<int, String> &r_funcs) {
|
||||
@@ -236,7 +213,7 @@ Script *GDScriptLanguage::create_script() const {
|
||||
/* DEBUGGER FUNCTIONS */
|
||||
|
||||
bool GDScriptLanguage::debug_break_parse(const String &p_file, int p_line, const String &p_error) {
|
||||
//break because of parse error
|
||||
// break because of parse error
|
||||
|
||||
if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
|
||||
_debug_parse_err_line = p_line;
|
||||
@@ -1383,8 +1360,8 @@ static bool _guess_expression_type(GDScriptParser::CompletionContext &p_context,
|
||||
}
|
||||
|
||||
if (!script.ends_with(".gd")) {
|
||||
//not a script, try find the script anyway,
|
||||
//may have some success
|
||||
// not a script, try find the script anyway,
|
||||
// may have some success
|
||||
script = script.get_basename() + ".gd";
|
||||
}
|
||||
|
||||
@@ -2770,7 +2747,7 @@ void GDScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_t
|
||||
}
|
||||
|
||||
if (indent_stack.size() && indent_stack.back()->get() != tc) {
|
||||
indent_stack.push_back(tc); //this is not right but gets the job done
|
||||
indent_stack.push_back(tc); // this is not right but gets the job done
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user