godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/gdscript/gdscript.h

533 lines
22 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
/* gdscript.h */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +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. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
#ifndef GDSCRIPT_H
#define GDSCRIPT_H
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
#include "core/debugger/engine_debugger.h"
#include "core/debugger/script_debugger.h"
Refactor DocData into core and editor (DocTools) parts
2020-11-29 03:42:06 +00:00
#include "core/doc_data.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/io/resource_loader.h"
#include "core/io/resource_saver.h"
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 22:33:38 +00:00
#include "core/object/script_language.h"
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
#include "core/templates/rb_set.h"
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
#include "gdscript_function.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
class GDScriptNativeClass : public RefCounted {
GDCLASS(GDScriptNativeClass, RefCounted);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
StringName name;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
protected:
bool _get(const StringName &p_name, Variant &r_ret) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static void _bind_methods();
public:
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
_FORCE_INLINE_ const StringName &get_name() const { return name; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Variant _new();
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
Object *instantiate();
GDScript: Add support for static method calls in native types
2022-04-06 17:14:38 +00:00
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
GDScriptNativeClass(const StringName &p_name);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
class GDScript : public Script {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GDCLASS(GDScript, Script);
Initialize class/struct variables with default values in modules/
2021-02-08 09:57:18 +00:00
bool tool = false;
bool valid = false;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
-Much improvement to baked light baker -Fixed many bugs in stretch mode -Fixes to camera project and unproject as consequence of the above -added setget to script (documented in script doc) -more fixes to collada exporter for blender
2014-10-28 01:54:32 +00:00
struct MemberInfo {
Initialize class/struct variables with default values in modules/
2021-02-08 09:57:18 +00:00
int index = 0;
-Much improvement to baked light baker -Fixed many bugs in stretch mode -Fixes to camera project and unproject as consequence of the above -added setget to script (documented in script doc) -more fixes to collada exporter for blender
2014-10-28 01:54:32 +00:00
StringName setter;
StringName getter;
Add static type checks in the parser - Resolve types for all identifiers. - Error when identifier is not found. - Match return type and error when not returning a value when it should. - Check unreachable code (code after sure return). - Match argument count and types for function calls. - Determine if return type of function call matches the assignment. - Do static type check with match statement when possible. - Use type hints to determine export type. - Check compatibility between type hint and explicit export type.
2018-05-30 02:16:54 +00:00
GDScriptDataType data_type;
-Much improvement to baked light baker -Fixed many bugs in stretch mode -Fixes to camera project and unproject as consequence of the above -added setget to script (documented in script doc) -more fixes to collada exporter for blender
2014-10-28 01:54:32 +00:00
};
More 3D Work -=-=-=-=-=- -ESM Shadow Mapping for softer and less glitchy shadows -HDR Pipeline (convert to Linear on texture import, convert to SRGB at the end) -Fix to xml parse bug
2014-06-16 13:22:26 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
friend class GDScriptInstance;
friend class GDScriptFunction;
GDScript: Properly resolve external inner classes from preload This gets the correct parser and class node when resolving from a full GDScript reference.
2020-08-23 14:21:11 +00:00
friend class GDScriptAnalyzer;
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
friend class GDScriptCompiler;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
friend class GDScriptLanguage;
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
friend struct GDScriptUtilityFunctionsDefinitions;
-Much improvement to baked light baker -Fixed many bugs in stretch mode -Fixes to camera project and unproject as consequence of the above -added setget to script (documented in script doc) -more fixes to collada exporter for blender
2014-10-28 01:54:32 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
Ref<GDScriptNativeClass> native;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<GDScript> base;
Initialize class/struct variables with default values in modules/
2021-02-08 09:57:18 +00:00
GDScript *_base = nullptr; //fast pointer access
GDScript *_owner = nullptr; //for subclasses
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
HashSet<StringName> members; //members are just indices to the instantiated script.
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, Variant> constants;
HashMap<StringName, GDScriptFunction *> member_functions;
HashMap<StringName, MemberInfo> member_indices; //members are just indices to the instantiated script.
HashMap<StringName, Ref<GDScript>> subclasses;
HashMap<StringName, Vector<StringName>> _signals;
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-12 21:12:42 +00:00
Dictionary rpc_config;
Do ctrl-click on any code identifier to go to definiton or help page.
2016-09-12 13:52:29 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
Batch of Bugfixes -=-=-=-=-=-=-=-=- -Fixed Export UV XForm (should work now). #923 -Fixed enforcement of limits in property editor. #919 -Fixed long-standing bug of export editings in script inheritance. #914, #859, #756 -Fixed horrible error reporting in shader language. #912 -Added kinematic collision with plane (please test well). #911 -Fixed double animation track insert when using 2D rigs. #904 -VKey updates offset parameter in sprite edition. #901 -Do not allow anymore a script to preload itself. (does not fix #899, but narrows it down) -Avoid connection editor from overriding selected text. #897 -Fixed timer autostart. #876 -Fixed collision layers in 3D physics. #872 -Improved operators in shader #857 -Fixed ambient lighting bug #834 -Avoid editor from processing gamepad input #813 -Added not keyword #752 Please test!
2014-12-07 05:04:20 +00:00
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, int> member_lines;
HashMap<StringName, Variant> member_default_values;
Batch of Bugfixes -=-=-=-=-=-=-=-=- -Fixed Export UV XForm (should work now). #923 -Fixed enforcement of limits in property editor. #919 -Fixed long-standing bug of export editings in script inheritance. #914, #859, #756 -Fixed horrible error reporting in shader language. #912 -Added kinematic collision with plane (please test well). #911 -Fixed double animation track insert when using 2D rigs. #904 -VKey updates offset parameter in sprite edition. #901 -Do not allow anymore a script to preload itself. (does not fix #899, but narrows it down) -Avoid connection editor from overriding selected text. #897 -Fixed timer autostart. #876 -Fixed collision layers in 3D physics. #872 -Improved operators in shader #857 -Fixed ambient lighting bug #834 -Avoid editor from processing gamepad input #813 -Added not keyword #752 Please test!
2014-12-07 05:04:20 +00:00
List<PropertyInfo> members_cache;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, Variant> member_default_values_cache;
Batch of Bugfixes -=-=-=-=-=-=-=-=- -Fixed Export UV XForm (should work now). #923 -Fixed enforcement of limits in property editor. #919 -Fixed long-standing bug of export editings in script inheritance. #914, #859, #756 -Fixed horrible error reporting in shader language. #912 -Added kinematic collision with plane (please test well). #911 -Fixed double animation track insert when using 2D rigs. #904 -VKey updates offset parameter in sprite edition. #901 -Do not allow anymore a script to preload itself. (does not fix #899, but narrows it down) -Avoid connection editor from overriding selected text. #897 -Fixed timer autostart. #876 -Fixed collision layers in 3D physics. #872 -Improved operators in shader #857 -Fixed ambient lighting bug #834 -Avoid editor from processing gamepad input #813 -Added not keyword #752 Please test!
2014-12-07 05:04:20 +00:00
Ref<GDScript> base_cache;
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
HashSet<ObjectID> inheriters_cache;
Initialize class/struct variables with default values in modules/
2021-02-08 09:57:18 +00:00
bool source_changed_cache = false;
bool placeholder_fallback_enabled = false;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
void _update_exports_values(HashMap<StringName, Variant> &values, List<PropertyInfo> &propnames);
Batch of Bugfixes -=-=-=-=-=-=-=-=- -Fixed Export UV XForm (should work now). #923 -Fixed enforcement of limits in property editor. #919 -Fixed long-standing bug of export editings in script inheritance. #914, #859, #756 -Fixed horrible error reporting in shader language. #912 -Added kinematic collision with plane (please test well). #911 -Fixed double animation track insert when using 2D rigs. #904 -VKey updates offset parameter in sprite edition. #901 -Do not allow anymore a script to preload itself. (does not fix #899, but narrows it down) -Avoid connection editor from overriding selected text. #897 -Fixed timer autostart. #876 -Fixed collision layers in 3D physics. #872 -Improved operators in shader #857 -Fixed ambient lighting bug #834 -Avoid editor from processing gamepad input #813 -Added not keyword #752 Please test!
2014-12-07 05:04:20 +00:00
Documentation generation for GDScript - ClassDoc added to GDScript and property reflection data were extracted from parse tree - GDScript comments are collected from tokenizer for documentation and applied to the ClassDoc by the GDScript compiler - private docs were excluded (name with underscore prefix and doesn't have any doc comments) - default values (of non exported vars), arguments are extraced from the parser - Integrated with GDScript 2.0 and new enums were added. - merge conflicts fixed
2020-11-29 02:37:57 +00:00
DocData::ClassDoc doc;
Vector<DocData::ClassDoc> docs;
String doc_brief_description;
String doc_description;
Vector<DocData::TutorialDoc> doc_tutorials;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<String, String> doc_functions;
HashMap<String, String> doc_variables;
HashMap<String, String> doc_constants;
HashMap<String, String> doc_signals;
HashMap<String, DocData::EnumDoc> doc_enums;
Documentation generation for GDScript - ClassDoc added to GDScript and property reflection data were extracted from parse tree - GDScript comments are collected from tokenizer for documentation and applied to the ClassDoc by the GDScript compiler - private docs were excluded (name with underscore prefix and doesn't have any doc comments) - default values (of non exported vars), arguments are extraced from the parser - Integrated with GDScript 2.0 and new enums were added. - merge conflicts fixed
2020-11-29 02:37:57 +00:00
void _clear_doc();
void _update_doc();
void _add_doc(const DocData::ClassDoc &p_inner_class);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, PropertyInfo> member_info;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
GDScriptFunction *implicit_initializer = nullptr;
GDScriptFunction *initializer = nullptr; //direct pointer to new , faster to locate
GDScript: Use implicit method for @onready variables Initialize them with the implicit method so they're not related to the overriding of the `_ready` method of the script but instead are always set.
2022-06-20 16:05:11 +00:00
GDScriptFunction *implicit_ready = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Initialize class/struct variables with default values in modules/
2021-02-08 09:57:18 +00:00
int subclass_count = 0;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
RBSet<Object *> instances;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
//exported members
String source;
String path;
String name;
Add fully_qualified_name for GDScript class
2020-01-14 15:33:33 +00:00
String fully_qualified_name;
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
SelfList<GDScript> script_list;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fix object leaks caused by unfulfilled yields Now the stack saved in a `GDScriptFunctionState` is cleared as soon as the `yield()` operation is known not to be resumed because either the script, the instance or both are deleted. This clears problems like leaked objects by eliminating cases of circular references between `GDScriptFunctionState`s preventing them and the objects they refer to in their saved stacks from being released. As an example, this makes using `SceneTreeTimer` safer. Furthermore, with this change it's now possible to print early warnings about `yield()`s to released script/instances, as now we know they won't be successfully resumed as the condition for that happens. However, this PR doesn't add such messages, to keep the observed behavior the same for the time being. Also, now a backup of the function name in `GDScriptFunctionState` is used, since the script may not be valid by the time the function name is needed for the resume-after-yield error messages.
2020-05-05 10:53:05 +00:00
SelfList<GDScriptFunctionState>::List pending_func_states;
Automatically call the _init function on base class if one does not exist.
2021-08-10 01:39:42 +00:00
GDScriptFunction *_super_constructor(GDScript *p_script);
New GDScript tokenizer and parser Sometimes to fix something you have to break it first. This get GDScript mostly working with the new tokenizer and parser but a lot of things isn't working yet. It compiles and it's usable, and that should be enough for now. Don't worry: other huge commits will come after this.
2020-05-01 22:14:56 +00:00
void _super_implicit_constructor(GDScript *p_script, GDScriptInstance *p_instance, Callable::CallError &r_error);
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
GDScriptInstance *_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_is_ref_counted, Callable::CallError &r_error);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void _set_subclass_path(Ref<GDScript> &p_sc, const String &p_path);
Show built-in script names in the debugger
2021-11-11 18:50:27 +00:00
String _get_debug_path() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifdef TOOLS_ENABLED
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
HashSet<PlaceHolderScriptInstance *> placeholders;
Batch of Bugfixes -=-=-=-=-=-=-=-=- -Fixed Export UV XForm (should work now). #923 -Fixed enforcement of limits in property editor. #919 -Fixed long-standing bug of export editings in script inheritance. #914, #859, #756 -Fixed horrible error reporting in shader language. #912 -Added kinematic collision with plane (please test well). #911 -Fixed double animation track insert when using 2D rigs. #904 -VKey updates offset parameter in sprite edition. #901 -Do not allow anymore a script to preload itself. (does not fix #899, but narrows it down) -Avoid connection editor from overriding selected text. #897 -Fixed timer autostart. #876 -Fixed collision layers in 3D physics. #872 -Improved operators in shader #857 -Fixed ambient lighting bug #834 -Avoid editor from processing gamepad input #813 -Added not keyword #752 Please test!
2014-12-07 05:04:20 +00:00
//void _update_placeholder(PlaceHolderScriptInstance *p_placeholder);
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual void _placeholder_erased(PlaceHolderScriptInstance *p_placeholder) override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Fixed reloading of tool scripts within editor, they should work much better now, closes #3194
2016-07-21 01:37:48 +00:00
#ifdef DEBUG_ENABLED
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<ObjectID, List<Pair<StringName, Variant>>> pending_reload_state;
-project settings are saved when changed -load() was in the GDScript docs but missing in the scripting-different music for platformer 2D and 3D -fix how documentation is generated, built in doc browser should be always up to date -copypaste, scrolling, etc in builtin doc -built-in scripts get saved now (though debugger may not always work on them) -Theme can be set to controls as a property
2014-02-16 00:16:33 +00:00
Fixed reloading of tool scripts within editor, they should work much better now, closes #3194
2016-07-21 01:37:48 +00:00
#endif
Little Bits -=-=-=-=-=- -fix duplicate function bug when creating script callback in editor -fix bug where hiding lights does not work -fix 2D audio listener bug (romulox_x reported) -fix exported properties with inheritance bug -fix timer autostart (make it not work on editor) -reactivate first camara found if viewport runs out of active camera -option to hide gizmos in viewport -changed skeleton gizmo because it sucks -Make convex shapes using CollisionShape visible (use quickhull class) -fix up menu when editing a mesh, to export collision, navmesh, convex, etc. from it. -make a menu option to show SRGB in 3D editor views by default -make option to edit default light direction in viewport settings -make option to edit default ambient light in viewport settings -make software conversion of linear->RGB if hardware support not found
2014-10-12 05:13:22 +00:00
Fix slow load/save of scenes with many instances of the same script
2021-06-13 11:32:44 +00:00
bool _update_exports(bool *r_err = nullptr, bool p_recursive_call = false, PlaceHolderScriptInstance *p_instance_to_update = nullptr);
Little Bits -=-=-=-=-=- -fix duplicate function bug when creating script callback in editor -fix bug where hiding lights does not work -fix 2D audio listener bug (romulox_x reported) -fix exported properties with inheritance bug -fix timer autostart (make it not work on editor) -reactivate first camara found if viewport runs out of active camera -option to hide gizmos in viewport -changed skeleton gizmo because it sucks -Make convex shapes using CollisionShape visible (use quickhull class) -fix up menu when editing a mesh, to export collision, navmesh, convex, etc. from it. -make a menu option to show SRGB in 3D editor views by default -make option to edit default light direction in viewport settings -make option to edit default ambient light in viewport settings -make software conversion of linear->RGB if hardware support not found
2014-10-12 05:13:22 +00:00
Keep a weak reference to orphan subclasses to reuse on class reload
2020-01-13 23:19:37 +00:00
void _save_orphaned_subclasses();
Generates the rpc and rset info for exported GDScript. Improved the send rpc log message when fail. This work has been kindly sponsored by IMVU.
2020-02-27 15:06:39 +00:00
void _init_rpc_methods_properties();
Keep a weak reference to orphan subclasses to reuse on class reload
2020-01-13 23:19:37 +00:00
Documentation generation for GDScript - ClassDoc added to GDScript and property reflection data were extracted from parse tree - GDScript comments are collected from tokenizer for documentation and applied to the ClassDoc by the GDScript compiler - private docs were excluded (name with underscore prefix and doesn't have any doc comments) - default values (of non exported vars), arguments are extraced from the parser - Integrated with GDScript 2.0 and new enums were added. - merge conflicts fixed
2020-11-29 02:37:57 +00:00
void _get_script_property_list(List<PropertyInfo> *r_list, bool p_include_base) const;
void _get_script_method_list(List<MethodInfo> *r_list, bool p_include_base) const;
void _get_script_signal_list(List<MethodInfo> *r_list, bool p_include_base) const;
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
// This method will map the class name from "RefCounted" to "MyClass.InnerClass".
Documentation generation for GDScript - ClassDoc added to GDScript and property reflection data were extracted from parse tree - GDScript comments are collected from tokenizer for documentation and applied to the ClassDoc by the GDScript compiler - private docs were excluded (name with underscore prefix and doesn't have any doc comments) - default values (of non exported vars), arguments are extraced from the parser - Integrated with GDScript 2.0 and new enums were added. - merge conflicts fixed
2020-11-29 02:37:57 +00:00
static String _get_gdscript_reference_class_name(const GDScript *p_gdscript);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
protected:
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
bool _get(const StringName &p_name, Variant &r_ret) const;
bool _set(const StringName &p_name, const Variant &p_value);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void _get_property_list(List<PropertyInfo> *p_properties) const;
Remove VARIANT_ARG* macros * Very old macros from the time Godot was created. * Limited arguments to 5 (then later changed to 8) in many places. * They were replaced by C++11 Variadic Templates. * Renamed methods that take argument pointers to have a "p" suffix. This was used in some places and not in others, so made it standard. * Also added a dereference check for Variant*. Helped catch a couple of bugs.
2022-03-09 13:58:40 +00:00
Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static void _bind_methods();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
public:
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual bool is_valid() const override { return valid; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
bool inherits_script(const Ref<Script> &p_script) const override;
Add ability to bind typed arrays to script API Note: Only replaced 2 instances to test, Node.get_children and TileMap.get_used_cells Note: Will do a mass replace on later PRs of whathever I can find, but probably need a tool to grep through doc. Warning: Mono will break, needs to be fixed (and so do TypeScript and NativeScript, need to ask respective maintainers)
2020-04-20 22:06:00 +00:00
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
const HashMap<StringName, Ref<GDScript>> &get_subclasses() const { return subclasses; }
const HashMap<StringName, Variant> &get_constants() const { return constants; }
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
const HashSet<StringName> &get_members() const { return members; }
Add static type checks in the parser - Resolve types for all identifiers. - Error when identifier is not found. - Match return type and error when not returning a value when it should. - Check unreachable code (code after sure return). - Match argument count and types for function calls. - Determine if return type of function call matches the assignment. - Do static type check with match statement when possible. - Use type hints to determine export type. - Check compatibility between type hint and explicit export type.
2018-05-30 02:16:54 +00:00
const GDScriptDataType &get_member_type(const StringName &p_member) const {
Fix various warnings: [-Waddress], [-Wpointer-arith], [-Wwrite-strings], [-Wreturn-local-addr] and more Fixes the following GCC 5 warnings: ``` core/os/file_access.cpp:49:19: warning: the address of 'FileAccess::create_func' will always evaluate as 'true' [-Waddress] servers/audio_server.cpp:192:70: warning: comparison with string literal results in unspecified behaviour [-Waddress] drivers/gles2/rasterizer_storage_gles2.cpp:4095:90: warning: NULL used in arithmetic [-Wpointer-arith] modules/gdnative/register_types.cpp:237:3: warning: deprecated conversion from string constant to 'char*' [-Wwrite-strings] platform/android/export/export.cpp:207:1: warning: deprecated conversion from string constant to 'char*' [-Wwrite-strings] modules/gdscript/gdscript.h:150:67: warning: returning reference to temporary [-Wreturn-local-addr] servers/physics_2d/collision_object_2d_sw.h:119:56: warning: returning reference to temporary [-Wreturn-local-addr] servers/physics_2d/collision_object_2d_sw.h:123:56: warning: returning reference to temporary [-Wreturn-local-addr] servers/physics_2d/collision_object_2d_sw.h:127:50: warning: returning reference to temporary [-Wreturn-local-addr] servers/physics_2d/collision_object_2d_sw.h:131:52: warning: returning reference to temporary [-Wreturn-local-addr] editor/plugins/skeleton_editor_plugin.cpp:34:36: warning: extra tokens at end of #include directive modules/bullet/bullet_types_converter.cpp:31:9: warning: #pragma once in main file editor/import/editor_scene_importer_gltf.cpp:1996:51: warning: name lookup of 'i' changed modules/visual_script/visual_script_property_selector.cpp:402:45: warning: name lookup of 'E' changed scene/gui/tree.cpp:1268:25: warning: name lookup of 'i' changed scene/resources/visual_shader.cpp:808:32: warning: name lookup of 'i' changed ```
2018-09-27 11:11:41 +00:00
CRASH_COND(!member_indices.has(p_member));
Add static type checks in the parser - Resolve types for all identifiers. - Error when identifier is not found. - Match return type and error when not returning a value when it should. - Check unreachable code (code after sure return). - Match argument count and types for function calls. - Determine if return type of function call matches the assignment. - Do static type check with match statement when possible. - Use type hints to determine export type. - Check compatibility between type hint and explicit export type.
2018-05-30 02:16:54 +00:00
return member_indices[p_member].data_type;
}
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
const HashMap<StringName, GDScriptFunction *> &get_member_functions() const { return member_functions; }
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
const Ref<GDScriptNativeClass> &get_native() const { return native; }
Use type information to enable GDScript introspection This makes the Script API provide accurate information when requesting property or method info.
2018-05-30 02:16:57 +00:00
const String &get_script_class_name() const { return name; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual bool has_script_signal(const StringName &p_signal) const override;
virtual void get_script_signal_list(List<MethodInfo> *r_signals) const override;
added ability to define signals in script closes #2175
2015-06-24 16:29:23 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
bool is_tool() const override { return tool; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<GDScript> get_base() const;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
const HashMap<StringName, MemberInfo> &debug_get_member_indices() const { return member_indices; }
const HashMap<StringName, GDScriptFunction *> &debug_get_member_functions() const; //this is debug only
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
StringName debug_get_member_by_index(int p_idx) const;
Reworked signal connection system, added support for Callable and Signal objects and made them default.
2020-02-19 19:27:19 +00:00
Variant _new(const Variant **p_args, int p_argcount, Callable::CallError &r_error);
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
virtual bool can_instantiate() const override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Ref<Script> get_base_script() const override;
More visual script work -Block switches to 2d/3d editor if editing visual script -Added cast node in flow control -Added ability to do RPC in visual script -Comment nodes -Fix bug with inverted cable in connecting backwards -Copy and paste nodes, including from different scripts
2016-08-25 20:45:20 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual StringName get_instance_base_type() const override; // this may not work in all scripts, will return empty if so
virtual ScriptInstance *instance_create(Object *p_this) override;
virtual PlaceHolderScriptInstance *placeholder_instance_create(Object *p_this) override;
virtual bool instance_has(const Object *p_this) const override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual bool has_source_code() const override;
virtual String get_source_code() const override;
virtual void set_source_code(const String &p_code) override;
virtual void update_exports() override;
-variables with export in script are now IMMEDIATELY AND ALWAYS visible in properties (#718) -WorldEnvironment cleanup issues fixed (#563) -Text Editor improvement to shift-mouse selection (#648) -(Hopefully) fixed rare (but horrible) indexing bug in GDScript compiler (#652) -Some changes to PhysicsBody API, renamed property "active" to "sleeping", which makes more sense -Added add_collision_exception() API in PhysicsBody (more accessible) -ability to select and copy in the output messages panel
2014-09-22 03:50:48 +00:00
Documentation generation for GDScript - ClassDoc added to GDScript and property reflection data were extracted from parse tree - GDScript comments are collected from tokenizer for documentation and applied to the ClassDoc by the GDScript compiler - private docs were excluded (name with underscore prefix and doesn't have any doc comments) - default values (of non exported vars), arguments are extraced from the parser - Integrated with GDScript 2.0 and new enums were added. - merge conflicts fixed
2020-11-29 02:37:57 +00:00
#ifdef TOOLS_ENABLED
Add GDExtension support to Script * Ability to create script languages from GDExtension * Some additions to gdnative_extension.h to make this happen * Moved the GDExtension binder to core This now allows creating scripting languages from GDExtension, with the same ease as if it was a module. It replaces the old PluginScript from Godot 3.x. Warning: GodotCPP will need to be updated to support this (it may be a bit of work as ScriptInstance needs to be created over there again).
2022-03-26 15:48:43 +00:00
virtual Vector<DocData::ClassDoc> get_documentation() const override {
Documentation generation for GDScript - ClassDoc added to GDScript and property reflection data were extracted from parse tree - GDScript comments are collected from tokenizer for documentation and applied to the ClassDoc by the GDScript compiler - private docs were excluded (name with underscore prefix and doesn't have any doc comments) - default values (of non exported vars), arguments are extraced from the parser - Integrated with GDScript 2.0 and new enums were added. - merge conflicts fixed
2020-11-29 02:37:57 +00:00
return docs;
}
#endif // TOOLS_ENABLED
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Error reload(bool p_keep_state = false) override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_script_path(const String &p_path) { path = p_path; } //because subclasses need a path too...
Error load_source_code(const String &p_path);
Error load_byte_code(const String &p_path);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
-some changes by okam
2015-06-30 14:28:43 +00:00
Vector<uint8_t> get_as_byte_code() const;
Add override keywords.
2020-07-10 10:34:39 +00:00
bool get_property_default_value(const StringName &p_property, Variant &r_value) const override;
-Ability to roll-back script-exported properties to their default value on the script, closes #2128
2016-01-02 23:17:31 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual void get_script_method_list(List<MethodInfo> *p_list) const override;
virtual bool has_method(const StringName &p_method) const override;
virtual MethodInfo get_method_info(const StringName &p_method) const override;
WIP visual scripting, not working yet but you can check out stuff
2016-08-02 22:11:05 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual void get_script_property_list(List<PropertyInfo> *p_list) const override;
Proper function/property selection in visual script editing for property. This one has an ordered list, built-in description, search, etc.
2016-08-23 22:29:07 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual ScriptLanguage *get_language() const override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual int get_member_line(const StringName &p_member) const override {
Do ctrl-click on any code identifier to go to definiton or help page.
2016-09-12 13:52:29 +00:00
#ifdef TOOLS_ENABLED
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (member_lines.has(p_member)) {
Do ctrl-click on any code identifier to go to definiton or help page.
2016-09-12 13:52:29 +00:00
return member_lines[p_member];
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
Do ctrl-click on any code identifier to go to definiton or help page.
2016-09-12 13:52:29 +00:00
#endif
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
return -1;
Do ctrl-click on any code identifier to go to definiton or help page.
2016-09-12 13:52:29 +00:00
}
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
virtual void get_constants(HashMap<StringName, Variant> *p_constants) override;
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
virtual void get_members(HashSet<StringName> *p_members) override;
Abstract some method for script system
2017-10-17 14:35:49 +00:00
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-12 21:12:42 +00:00
virtual const Variant get_rpc_config() const override;
Optmized data sent during RPC and RSet calls. - Now is sent the method ID rather the full function name. - The passed IDs (Node and Method) are compressed so to use less possible space. - The variant (INT and BOOL) is now encoded and compressed so to use much less data. - Optimized RPCMode retrieval for GDScript functions. - Added checksum to assert the methods are the same across peers. This work has been kindly sponsored by IMVU.
2020-02-12 10:51:50 +00:00
Fix properties being lost when reloading placeholder GDScript instance During reloading in `GDScriptLanguage::reload_all_scripts` a placeholder instance that must remain so is replaced with a new placeholder instance. The state is then restored by calling `ScriptInstance::set` for each property. This does not work if the script is missing the properties due to build/parse failing. The fix for such cases is to call `placeholder_set_fallback` instead of `set` on the script instance. I took this chance to move the `build_failed` flag from `PlaceHolderScriptInstance` to `Script`. That improves the code a lot. I also renamed it to `placeholder_fallback_enabled` which is a much better name (`build_failed` could lead to misunderstandings).
2019-01-09 23:26:00 +00:00
#ifdef TOOLS_ENABLED
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual bool is_placeholder_fallback_enabled() const override { return placeholder_fallback_enabled; }
Fix properties being lost when reloading placeholder GDScript instance During reloading in `GDScriptLanguage::reload_all_scripts` a placeholder instance that must remain so is replaced with a new placeholder instance. The state is then restored by calling `ScriptInstance::set` for each property. This does not work if the script is missing the properties due to build/parse failing. The fix for such cases is to call `placeholder_set_fallback` instead of `set` on the script instance. I took this chance to move the `build_failed` flag from `PlaceHolderScriptInstance` to `Script`. That improves the code a lot. I also renamed it to `placeholder_fallback_enabled` which is a much better name (`build_failed` could lead to misunderstandings).
2019-01-09 23:26:00 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
GDScript();
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
~GDScript();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
class GDScriptInstance : public ScriptInstance {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
friend class GDScript;
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
friend class GDScriptFunction;
GDScript: Implement lambdas compilation and runtime
2021-03-28 14:03:13 +00:00
friend class GDScriptLambdaCallable;
GDScript: Allow using self in lambdas
2022-04-20 17:22:22 +00:00
friend class GDScriptLambdaSelfCallable;
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
friend class GDScriptCompiler;
GDScript: Refactor builtin functions They are now called "utility functions" to avoid confusion with methods of builtin types, and be consistent with the naming in Variant. Core utility functions are now available in GDScript. The ones missing in core are added specifically to GDScript as helpers for convenience. Some functions were remove when there are better ways to do, reducing redundancy and cleaning up the global scope.
2020-11-26 14:56:32 +00:00
friend struct GDScriptUtilityFunctionsDefinitions;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Changed logic and optimized ObjectID in ObjectDB and Variant, removed RefPtr.
2020-02-13 19:03:10 +00:00
ObjectID owner_id;
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
Object *owner = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ref<GDScript> script;
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
#ifdef DEBUG_ENABLED
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, int> member_indices_cache; //used only for hot script reloading
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
#endif
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Vector<Variant> members;
Rename Reference to RefCounted
2021-06-04 16:03:15 +00:00
bool base_ref_counted;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Fix object leaks caused by unfulfilled yields Now the stack saved in a `GDScriptFunctionState` is cleared as soon as the `yield()` operation is known not to be resumed because either the script, the instance or both are deleted. This clears problems like leaked objects by eliminating cases of circular references between `GDScriptFunctionState`s preventing them and the objects they refer to in their saved stacks from being released. As an example, this makes using `SceneTreeTimer` safer. Furthermore, with this change it's now possible to print early warnings about `yield()`s to released script/instances, as now we know they won't be successfully resumed as the condition for that happens. However, this PR doesn't add such messages, to keep the observed behavior the same for the time being. Also, now a backup of the function name in `GDScriptFunctionState` is used, since the script may not be valid by the time the function name is needed for the resume-after-yield error messages.
2020-05-05 10:53:05 +00:00
SelfList<GDScriptFunctionState>::List pending_func_states;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
public:
Abstract some method for script system
2017-10-17 14:35:49 +00:00
virtual Object *get_owner() { return owner; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual bool set(const StringName &p_name, const Variant &p_value);
virtual bool get(const StringName &p_name, Variant &r_ret) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void get_property_list(List<PropertyInfo> *p_properties) const;
Replace NULL with nullptr
2020-04-01 23:20:12 +00:00
virtual Variant::Type get_property_type(const StringName &p_name, bool *r_is_valid = nullptr) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void get_method_list(List<MethodInfo> *p_list) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual bool has_method(const StringName &p_method) const;
Remove VARIANT_ARG* macros * Very old macros from the time Godot was created. * Limited arguments to 5 (then later changed to 8) in many places. * They were replaced by C++11 Variadic Templates. * Renamed methods that take argument pointers to have a "p" suffix. This was used in some places and not in others, so made it standard. * Also added a dereference check for Variant*. Helped catch a couple of bugs.
2022-03-09 13:58:40 +00:00
virtual Variant callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
Variant debug_get_member_by_index(int p_idx) const { return members[p_idx]; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void notification(int p_notification);
Allow overriding how scripted objects are converted to strings solves #26796 - ADD `String to_string()` method to Object which can be overriden by `String _to_string()` in scripts - ADD `String to_string(r_valid)` method to ScriptInstance to allow langauges to control how scripted objects are converted to strings - IMPLEMENT to_string for GDScriptInstance, VisualScriptInstance, and NativeScriptInstance - ADD Documentation about `Object.to_string` and `Object._to_string` - Changed `Variant::operator String` to use `obj->to_string()`
2019-04-10 05:07:40 +00:00
String to_string(bool *r_valid);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual Ref<Script> get_script() const;
virtual ScriptLanguage *get_language();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void set_path(const String &p_path);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
void reload_members();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-12 21:12:42 +00:00
virtual const Variant get_rpc_config() const;
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
GDScriptInstance();
~GDScriptInstance();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
class GDScriptLanguage : public ScriptLanguage {
Fix object leaks caused by unfulfilled yields Now the stack saved in a `GDScriptFunctionState` is cleared as soon as the `yield()` operation is known not to be resumed because either the script, the instance or both are deleted. This clears problems like leaked objects by eliminating cases of circular references between `GDScriptFunctionState`s preventing them and the objects they refer to in their saved stacks from being released. As an example, this makes using `SceneTreeTimer` safer. Furthermore, with this change it's now possible to print early warnings about `yield()`s to released script/instances, as now we know they won't be successfully resumed as the condition for that happens. However, this PR doesn't add such messages, to keep the observed behavior the same for the time being. Also, now a backup of the function name in `GDScriptFunctionState` is used, since the script may not be valid by the time the function name is needed for the resume-after-yield error messages.
2020-05-05 10:53:05 +00:00
friend class GDScriptFunctionState;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static GDScriptLanguage *singleton;
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
Variant *_global_array = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Vector<Variant> global_array;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, int> globals;
HashMap<StringName, Variant> named_globals;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
struct CallLevel {
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
Variant *stack = nullptr;
GDScriptFunction *function = nullptr;
GDScriptInstance *instance = nullptr;
int *ip = nullptr;
int *line = nullptr;
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
int _debug_parse_err_line;
String _debug_parse_err_file;
String _debug_error;
int _debug_call_stack_pos;
int _debug_max_call_stack;
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
CallLevel *_call_stack = nullptr;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
void _add_global(const StringName &p_name, const Variant &p_value);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
friend class GDScriptInstance;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Reimplement Mutex with C++'s <mutex> Main: - It's now implemented thanks to `<mutex>`. No more platform-specific implementations. - `BinaryMutex` (non-recursive) is added, as an alternative for special cases. - Doesn't need allocation/deallocation anymore. It can live in the stack and be part of other classes. - Because of that, it's methods are now `const` and the inner mutex is `mutable` so it can be easily used in `const` contexts. - A no-op implementation is provided if `NO_THREADS` is defined. No more need to add `#ifdef NO_THREADS` just for this. - `MutexLock` now takes a reference. At this point the cases of null `Mutex`es are rare. If you ever need that, just don't use `MutexLock`. - Thread-safe utilities are therefore simpler now. Misc.: - `ScopedMutexLock` is dropped and replaced by `MutexLock`, because they were pretty much the same. - Every case of lock, do-something, unlock is replaced by `MutexLock` (complex cases where it's not straightfoward are kept as as explicit lock and unlock). - `ShaderRD` contained an `std::mutex`, which has been replaced by `Mutex`.
2020-02-26 10:28:13 +00:00
Mutex lock;
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
friend class GDScript;
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
SelfList<GDScript>::List script_list;
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
friend class GDScriptFunction;
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
SelfList<GDScriptFunction>::List function_list;
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
bool profiling;
uint64_t script_frame_time;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<String, ObjectID> orphan_subclasses;
Keep a weak reference to orphan subclasses to reuse on class reload
2020-01-13 23:19:37 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
public:
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
int calls;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
bool debug_break(const String &p_error, bool p_allow_continue = true);
bool debug_break_parse(const String &p_file, int p_line, const String &p_error);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
_FORCE_INLINE_ void enter_function(GDScriptInstance *p_instance, GDScriptFunction *p_function, Variant *p_stack, int *p_ip, int *p_line) {
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (Thread::get_main_id() != Thread::get_caller_id()) {
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
return; //no support for other threads than main for now
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() + 1);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
if (_debug_call_stack_pos >= _debug_max_call_stack) {
//stack overflow
Improve stack overflow error message in GDScript and VisualScript Stack overflow errors are generally the result of infinite recursion within a script.
2022-05-28 21:11:37 +00:00
_debug_error = vformat("Stack overflow (stack size: %s). Check for infinite recursion in your script.", _debug_max_call_stack);
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
EngineDebugger::get_script_debugger()->debug(this);
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
return;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
_call_stack[_debug_call_stack_pos].stack = p_stack;
_call_stack[_debug_call_stack_pos].instance = p_instance;
_call_stack[_debug_call_stack_pos].function = p_function;
_call_stack[_debug_call_stack_pos].ip = p_ip;
_call_stack[_debug_call_stack_pos].line = p_line;
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
_debug_call_stack_pos++;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
_FORCE_INLINE_ void exit_function() {
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (Thread::get_main_id() != Thread::get_caller_id()) {
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
return; //no support for other threads than main for now
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (EngineDebugger::get_script_debugger()->get_lines_left() > 0 && EngineDebugger::get_script_debugger()->get_depth() >= 0) {
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
EngineDebugger::get_script_debugger()->set_depth(EngineDebugger::get_script_debugger()->get_depth() - 1);
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
if (_debug_call_stack_pos == 0) {
_debug_error = "Stack Underflow (Engine Bug)";
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 02:30:20 +00:00
EngineDebugger::get_script_debugger()->debug(this);
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
return;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
_debug_call_stack_pos--;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual Vector<StackInfo> debug_get_current_stack_info() override {
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
if (Thread::get_main_id() != Thread::get_caller_id()) {
Brand new networked multiplayer
2016-08-19 19:48:08 +00:00
return Vector<StackInfo>();
Style: Enforce braces around if blocks and loops Using clang-tidy's `readability-braces-around-statements`. https://clang.llvm.org/extra/clang-tidy/checks/readability-braces-around-statements.html
2020-05-14 14:41:43 +00:00
}
error debugger shows the list of errors that happened during running the game, traces can be analyzed
2015-08-04 12:47:32 +00:00
Vector<StackInfo> csi;
csi.resize(_debug_call_stack_pos);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
for (int i = 0; i < _debug_call_stack_pos; i++) {
Reduce unnecessary COW on Vector by make writing explicit This commit makes operator[] on Vector const and adds a write proxy to it. From now on writes to Vectors need to happen through the .write proxy. So for instance: Vector<int> vec; vec.push_back(10); std::cout << vec[0] << std::endl; vec.write[0] = 20; Failing to use the .write proxy will cause a compilation error. In addition COWable datatypes can now embed a CowData pointer to their data. This means that String, CharString, and VMap no longer use or derive from Vector. _ALWAYS_INLINE_ and _FORCE_INLINE_ are now equivalent for debug and non-debug builds. This is a lot faster for Vector in the editor and while running tests. The reason why this difference used to exist is because force-inlined methods used to give a bad debugging experience. After extensive testing with modern compilers this is no longer the case.
2018-07-25 01:11:03 +00:00
csi.write[_debug_call_stack_pos - i - 1].line = _call_stack[i].line ? *_call_stack[i].line : 0;
Small fixes to static analyzer bugs
2019-04-04 20:00:16 +00:00
if (_call_stack[i].function) {
Reduce unnecessary COW on Vector by make writing explicit This commit makes operator[] on Vector const and adds a write proxy to it. From now on writes to Vectors need to happen through the .write proxy. So for instance: Vector<int> vec; vec.push_back(10); std::cout << vec[0] << std::endl; vec.write[0] = 20; Failing to use the .write proxy will cause a compilation error. In addition COWable datatypes can now embed a CowData pointer to their data. This means that String, CharString, and VMap no longer use or derive from Vector. _ALWAYS_INLINE_ and _FORCE_INLINE_ are now equivalent for debug and non-debug builds. This is a lot faster for Vector in the editor and while running tests. The reason why this difference used to exist is because force-inlined methods used to give a bad debugging experience. After extensive testing with modern compilers this is no longer the case.
2018-07-25 01:11:03 +00:00
csi.write[_debug_call_stack_pos - i - 1].func = _call_stack[i].function->get_name();
Small fixes to static analyzer bugs
2019-04-04 20:00:16 +00:00
csi.write[_debug_call_stack_pos - i - 1].file = _call_stack[i].function->get_script()->get_path();
}
error debugger shows the list of errors that happened during running the game, traces can be analyzed
2015-08-04 12:47:32 +00:00
}
return csi;
}
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
struct {
StringName _init;
StringName _notification;
StringName _set;
StringName _get;
StringName _get_property_list;
-project settings are saved when changed -load() was in the GDScript docs but missing in the scripting-different music for platformer 2D and 3D -fix how documentation is generated, built in doc browser should be always up to date -copypaste, scrolling, etc in builtin doc -built-in scripts get saved now (though debugger may not always work on them) -Theme can be set to controls as a property
2014-02-16 00:16:33 +00:00
StringName _script_source;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
} strings;
_FORCE_INLINE_ int get_global_array_size() const { return global_array.size(); }
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
_FORCE_INLINE_ Variant *get_global_array() { return _global_array; }
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
_FORCE_INLINE_ const HashMap<StringName, int> &get_global_map() const { return globals; }
_FORCE_INLINE_ const HashMap<StringName, Variant> &get_named_globals_map() const { return named_globals; }
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
_FORCE_INLINE_ static GDScriptLanguage *get_singleton() { return singleton; }
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual String get_name() const override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* LANGUAGE FUNCTIONS */
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* EDITOR FUNCTIONS */
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
Add a new HashSet template * Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19 15:00:06 +00:00
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, HashSet<int> *r_safe_lines = nullptr) const override;
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
Add GDExtension support to Script * Ability to create script languages from GDExtension * Some additions to gdnative_extension.h to make this happen * Moved the GDExtension binder to core This now allows creating scripting languages from GDExtension, with the same ease as if it was a module. It replaces the old PluginScript from Godot 3.x. Warning: GodotCPP will need to be updated to support this (it may be a bit of work as ScriptInstance needs to be created over there again).
2022-03-26 15:48:43 +00:00
virtual Error complete_code(const String &p_code, const String &p_path, Object *p_owner, List<ScriptLanguage::CodeCompletionOption> *r_options, bool &r_forced, String &r_call_hint) override;
Fix build for templates
2016-09-13 01:40:46 +00:00
#ifdef TOOLS_ENABLED
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual Error lookup_code(const String &p_code, const String &p_symbol, const String &p_path, Object *p_owner, LookupResult &r_result) override;
Fix build for templates
2016-09-13 01:40:46 +00:00
#endif
Added support for space indentation
2017-04-17 13:24:30 +00:00
virtual String _get_indentation() const;
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
Reworked how autoloads are load to make sure identifiers always exist, please check if this resolves bug #3156
2016-01-13 11:27:14 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* DEBUGGER FUNCTIONS */
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual void reload_all_scripts() override;
virtual void reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) override;
Ability to reload scripts on running game
2016-06-01 23:22:02 +00:00
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual void frame() override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual void get_public_functions(List<MethodInfo> *p_functions) const override;
virtual void get_public_constants(List<Pair<String, Variant>> *p_constants) const override;
Add support for documenting built-in annotations
2022-07-04 15:56:34 +00:00
virtual void get_public_annotations(List<MethodInfo> *p_annotations) const override;
-added kinematic body -added kinematic body demos
2014-02-22 23:28:19 +00:00
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual void profiling_start() override;
virtual void profiling_stop() override;
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
First version of Profiler It is now possible to profile GDScript as well as some parts of Godot internals.
2016-05-22 00:18:16 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/* LOADER FUNCTIONS */
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
virtual void get_recognized_extensions(List<String> *p_extensions) const override;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Global class names (and GDScript support for it)
2018-07-15 22:29:00 +00:00
/* GLOBAL CLASSES */
Improve editor template workflow Co-Authored-By: jmb462 <jmb462@gmail.com>
2021-10-11 09:30:59 +00:00
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;
Global class names (and GDScript support for it)
2018-07-15 22:29:00 +00:00
Keep a weak reference to orphan subclasses to reuse on class reload
2020-01-13 23:19:37 +00:00
void add_orphan_subclass(const String &p_qualified_name, const ObjectID &p_subclass);
Ref<GDScript> get_orphan_subclass(const String &p_qualified_name);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
GDScriptLanguage();
~GDScriptLanguage();
};
class ResourceFormatLoaderGDScript : public ResourceFormatLoader {
public:
Remove `RES` and `REF` typedefs in favor of spelled out `Ref<>` These typedefs don't save much typing compared to the full `Ref<Resource>` and `Ref<RefCounted>`, yet they sometimes introduce confusion among new contributors.
2022-05-02 23:43:50 +00:00
virtual Ref<Resource> load(const String &p_path, const String &p_original_path = "", Error *r_error = nullptr, bool p_use_sub_threads = false, float *r_progress = nullptr, CacheMode p_cache_mode = CACHE_MODE_REUSE);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void get_recognized_extensions(List<String> *p_extensions) const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual bool handles_type(const String &p_type) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_resource_type(const String &p_path) const;
Add a dependency search mode for GDScript parser - This mode avoids loading any other resource. - Search for class_name now uses this mode, to avoid loading in the scan thread. - Implement get_dependencies() for GDScript loader, now exporting dependencies only should include the preloaded resources.
2019-03-03 19:36:42 +00:00
virtual void get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types = false);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
class ResourceFormatSaverGDScript : public ResourceFormatSaver {
public:
Remove `RES` and `REF` typedefs in favor of spelled out `Ref<>` These typedefs don't save much typing compared to the full `Ref<Resource>` and `Ref<RefCounted>`, yet they sometimes introduce confusion among new contributors.
2022-05-02 23:43:50 +00:00
virtual Error save(const String &p_path, const Ref<Resource> &p_resource, uint32_t p_flags = 0);
virtual void get_recognized_extensions(const Ref<Resource> &p_resource, List<String> *p_extensions) const;
virtual bool recognize(const Ref<Resource> &p_resource) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
GDScript: Refactor "GD" class prefix to "GDScript"
2017-11-16 17:38:18 +00:00
#endif // GDSCRIPT_H