2016-06-18 12:46:12 +00:00
/*************************************************************************/
/* core_bind.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
2016-06-18 12:46:12 +00:00
/*************************************************************************/
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). */
2016-06-18 12:46:12 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2018-01-04 23:50:27 +00:00
2014-02-10 01:10:30 +00:00
# include "core_bind.h"
2017-04-28 16:29:15 +00:00
2020-11-07 22:33:38 +00:00
# include "core/config/project_settings.h"
2019-07-11 13:21:47 +00:00
# include "core/crypto/crypto_core.h"
2020-05-18 14:55:49 +00:00
# include "core/debugger/engine_debugger.h"
2018-09-11 16:13:45 +00:00
# include "core/io/file_access_compressed.h"
# include "core/io/file_access_encrypted.h"
# include "core/io/marshalls.h"
2020-05-25 17:20:45 +00:00
# include "core/math/geometry_2d.h"
# include "core/math/geometry_3d.h"
2018-09-11 16:13:45 +00:00
# include "core/os/keyboard.h"
2022-08-05 01:41:48 +00:00
# include "core/variant/typed_array.h"
2016-03-04 06:31:27 +00:00
2021-08-13 14:46:14 +00:00
namespace core_bind {
2020-05-12 15:01:17 +00:00
2021-08-13 14:46:14 +00:00
////// ResourceLoader //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ResourceLoader * ResourceLoader : : singleton = nullptr ;
2021-11-07 17:47:53 +00:00
Error ResourceLoader : : load_threaded_request ( const String & p_path , const String & p_type_hint , bool p_use_sub_threads , CacheMode p_cache_mode ) {
return : : ResourceLoader : : load_threaded_request ( p_path , p_type_hint , p_use_sub_threads , ResourceFormatLoader : : CacheMode ( p_cache_mode ) ) ;
2020-02-28 11:27:04 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
ResourceLoader : : ThreadLoadStatus ResourceLoader : : load_threaded_get_status ( const String & p_path , Array r_progress ) {
2020-02-28 11:27:04 +00:00
float progress = 0 ;
2021-08-13 14:46:14 +00:00
: : ResourceLoader : : ThreadLoadStatus tls = : : ResourceLoader : : load_threaded_get_status ( p_path , & progress ) ;
2020-02-28 11:27:04 +00:00
r_progress . resize ( 1 ) ;
r_progress [ 0 ] = progress ;
return ( ThreadLoadStatus ) tls ;
}
2020-05-14 12:29:06 +00:00
2022-05-02 23:43:50 +00:00
Ref < Resource > ResourceLoader : : load_threaded_get ( const String & p_path ) {
2020-02-28 11:27:04 +00:00
Error error ;
2022-05-02 23:43:50 +00:00
Ref < Resource > res = : : ResourceLoader : : load_threaded_get ( p_path , & error ) ;
2020-02-28 11:27:04 +00:00
return res ;
2014-02-10 01:10:30 +00:00
}
2022-05-02 23:43:50 +00:00
Ref < Resource > ResourceLoader : : load ( const String & p_path , const String & p_type_hint , CacheMode p_cache_mode ) {
2018-01-05 20:35:48 +00:00
Error err = OK ;
2022-05-02 23:43:50 +00:00
Ref < Resource > ret = : : ResourceLoader : : load ( p_path , p_type_hint , ResourceFormatLoader : : CacheMode ( p_cache_mode ) , & err ) ;
2018-01-05 20:35:48 +00:00
2019-08-15 02:57:49 +00:00
ERR_FAIL_COND_V_MSG ( err ! = OK , ret , " Error loading resource: ' " + p_path + " '. " ) ;
2014-02-10 01:10:30 +00:00
return ret ;
}
2021-08-13 14:46:14 +00:00
Vector < String > ResourceLoader : : get_recognized_extensions_for_type ( const String & p_type ) {
2014-02-10 01:10:30 +00:00
List < String > exts ;
2021-08-13 14:46:14 +00:00
: : ResourceLoader : : get_recognized_extensions_for_type ( p_type , & exts ) ;
2020-02-17 21:06:54 +00:00
Vector < String > ret ;
2021-07-24 13:46:25 +00:00
for ( const String & E : exts ) {
2021-07-16 03:45:57 +00:00
ret . push_back ( E ) ;
2014-02-10 01:10:30 +00:00
}
return ret ;
}
2022-05-15 13:42:27 +00:00
void ResourceLoader : : add_resource_format_loader ( Ref < ResourceFormatLoader > p_format_loader , bool p_at_front ) {
: : ResourceLoader : : add_resource_format_loader ( p_format_loader , p_at_front ) ;
}
void ResourceLoader : : remove_resource_format_loader ( Ref < ResourceFormatLoader > p_format_loader ) {
: : ResourceLoader : : remove_resource_format_loader ( p_format_loader ) ;
}
2021-08-13 14:46:14 +00:00
void ResourceLoader : : set_abort_on_missing_resources ( bool p_abort ) {
: : ResourceLoader : : set_abort_on_missing_resources ( p_abort ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
PackedStringArray ResourceLoader : : get_dependencies ( const String & p_path ) {
2014-02-10 01:10:30 +00:00
List < String > deps ;
2021-08-13 14:46:14 +00:00
: : ResourceLoader : : get_dependencies ( p_path , & deps ) ;
2014-02-10 01:10:30 +00:00
2020-02-17 21:06:54 +00:00
PackedStringArray ret ;
2021-07-24 13:46:25 +00:00
for ( const String & E : deps ) {
2021-07-16 03:45:57 +00:00
ret . push_back ( E ) ;
2014-02-10 01:10:30 +00:00
}
return ret ;
2020-05-19 13:46:49 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
bool ResourceLoader : : has_cached ( const String & p_path ) {
2017-07-19 20:00:46 +00:00
String local_path = ProjectSettings : : get_singleton ( ) - > localize_path ( p_path ) ;
2014-02-10 01:10:30 +00:00
return ResourceCache : : has ( local_path ) ;
2018-08-10 18:57:43 +00:00
}
2021-08-13 14:46:14 +00:00
bool ResourceLoader : : exists ( const String & p_path , const String & p_type_hint ) {
return : : ResourceLoader : : exists ( p_path , p_type_hint ) ;
2018-08-10 18:57:43 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ResourceUID : : ID ResourceLoader : : get_resource_uid ( const String & p_path ) {
return : : ResourceLoader : : get_resource_uid ( p_path ) ;
2021-07-30 16:35:19 +00:00
}
2021-08-13 14:46:14 +00:00
void ResourceLoader : : _bind_methods ( ) {
2021-11-07 17:47:53 +00:00
ClassDB : : bind_method ( D_METHOD ( " load_threaded_request " , " path " , " type_hint " , " use_sub_threads " , " cache_mode " ) , & ResourceLoader : : load_threaded_request , DEFVAL ( " " ) , DEFVAL ( false ) , DEFVAL ( CACHE_MODE_REUSE ) ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " load_threaded_get_status " , " path " , " progress " ) , & ResourceLoader : : load_threaded_get_status , DEFVAL ( Array ( ) ) ) ;
ClassDB : : bind_method ( D_METHOD ( " load_threaded_get " , " path " ) , & ResourceLoader : : load_threaded_get ) ;
2020-02-28 11:27:04 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " load " , " path " , " type_hint " , " cache_mode " ) , & ResourceLoader : : load , DEFVAL ( " " ) , DEFVAL ( CACHE_MODE_REUSE ) ) ;
ClassDB : : bind_method ( D_METHOD ( " get_recognized_extensions_for_type " , " type " ) , & ResourceLoader : : get_recognized_extensions_for_type ) ;
2022-05-15 13:42:27 +00:00
ClassDB : : bind_method ( D_METHOD ( " add_resource_format_loader " , " format_loader " , " at_front " ) , & ResourceLoader : : add_resource_format_loader , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " remove_resource_format_loader " , " format_loader " ) , & ResourceLoader : : remove_resource_format_loader ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_abort_on_missing_resources " , " abort " ) , & ResourceLoader : : set_abort_on_missing_resources ) ;
ClassDB : : bind_method ( D_METHOD ( " get_dependencies " , " path " ) , & ResourceLoader : : get_dependencies ) ;
ClassDB : : bind_method ( D_METHOD ( " has_cached " , " path " ) , & ResourceLoader : : has_cached ) ;
ClassDB : : bind_method ( D_METHOD ( " exists " , " path " , " type_hint " ) , & ResourceLoader : : exists , DEFVAL ( " " ) ) ;
ClassDB : : bind_method ( D_METHOD ( " get_resource_uid " , " path " ) , & ResourceLoader : : get_resource_uid ) ;
2020-02-28 11:27:04 +00:00
BIND_ENUM_CONSTANT ( THREAD_LOAD_INVALID_RESOURCE ) ;
BIND_ENUM_CONSTANT ( THREAD_LOAD_IN_PROGRESS ) ;
BIND_ENUM_CONSTANT ( THREAD_LOAD_FAILED ) ;
BIND_ENUM_CONSTANT ( THREAD_LOAD_LOADED ) ;
2021-02-11 17:18:45 +00:00
BIND_ENUM_CONSTANT ( CACHE_MODE_IGNORE ) ;
BIND_ENUM_CONSTANT ( CACHE_MODE_REUSE ) ;
BIND_ENUM_CONSTANT ( CACHE_MODE_REPLACE ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
////// ResourceSaver //////
2014-02-10 01:10:30 +00:00
2022-06-02 23:33:42 +00:00
Error ResourceSaver : : save ( const Ref < Resource > & p_resource , const String & p_path , BitField < SaverFlags > p_flags ) {
ERR_FAIL_COND_V_MSG ( p_resource . is_null ( ) , ERR_INVALID_PARAMETER , " Can't save empty resource to path ' " + p_path + " '. " ) ;
return : : ResourceSaver : : save ( p_resource , p_path , p_flags ) ;
2014-02-10 01:10:30 +00:00
}
2022-05-02 23:43:50 +00:00
Vector < String > ResourceSaver : : get_recognized_extensions ( const Ref < Resource > & p_resource ) {
2020-02-17 21:06:54 +00:00
ERR_FAIL_COND_V_MSG ( p_resource . is_null ( ) , Vector < String > ( ) , " It's not a reference to a valid Resource object. " ) ;
2014-02-10 01:10:30 +00:00
List < String > exts ;
2021-08-13 14:46:14 +00:00
: : ResourceSaver : : get_recognized_extensions ( p_resource , & exts ) ;
2020-02-17 21:06:54 +00:00
Vector < String > ret ;
2021-07-24 13:46:25 +00:00
for ( const String & E : exts ) {
2021-07-16 03:45:57 +00:00
ret . push_back ( E ) ;
2014-02-10 01:10:30 +00:00
}
return ret ;
}
2022-05-15 13:42:27 +00:00
void ResourceSaver : : add_resource_format_saver ( Ref < ResourceFormatSaver > p_format_saver , bool p_at_front ) {
: : ResourceSaver : : add_resource_format_saver ( p_format_saver , p_at_front ) ;
}
void ResourceSaver : : remove_resource_format_saver ( Ref < ResourceFormatSaver > p_format_saver ) {
: : ResourceSaver : : remove_resource_format_saver ( p_format_saver ) ;
}
2021-08-13 14:46:14 +00:00
ResourceSaver * ResourceSaver : : singleton = nullptr ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
void ResourceSaver : : _bind_methods ( ) {
2022-06-02 23:33:42 +00:00
ClassDB : : bind_method ( D_METHOD ( " save " , " resource " , " path " , " flags " ) , & ResourceSaver : : save , DEFVAL ( " " ) , DEFVAL ( ( uint32_t ) FLAG_NONE ) ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_recognized_extensions " , " type " ) , & ResourceSaver : : get_recognized_extensions ) ;
2022-05-15 13:42:27 +00:00
ClassDB : : bind_method ( D_METHOD ( " add_resource_format_saver " , " format_saver " , " at_front " ) , & ResourceSaver : : add_resource_format_saver , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " remove_resource_format_saver " , " format_saver " ) , & ResourceSaver : : remove_resource_format_saver ) ;
2014-05-24 04:35:47 +00:00
2022-06-24 09:16:37 +00:00
BIND_BITFIELD_FLAG ( FLAG_NONE ) ;
BIND_BITFIELD_FLAG ( FLAG_RELATIVE_PATHS ) ;
BIND_BITFIELD_FLAG ( FLAG_BUNDLE_RESOURCES ) ;
BIND_BITFIELD_FLAG ( FLAG_CHANGE_PATH ) ;
BIND_BITFIELD_FLAG ( FLAG_OMIT_EDITOR_PROPERTIES ) ;
BIND_BITFIELD_FLAG ( FLAG_SAVE_BIG_ENDIAN ) ;
BIND_BITFIELD_FLAG ( FLAG_COMPRESS ) ;
BIND_BITFIELD_FLAG ( FLAG_REPLACE_SUBRESOURCE_PATHS ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
////// OS //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
PackedStringArray OS : : get_connected_midi_inputs ( ) {
return : : OS : : get_singleton ( ) - > get_connected_midi_inputs ( ) ;
2018-07-14 12:11:28 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : open_midi_inputs ( ) {
: : OS : : get_singleton ( ) - > open_midi_inputs ( ) ;
2018-08-04 00:17:33 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : close_midi_inputs ( ) {
: : OS : : get_singleton ( ) - > close_midi_inputs ( ) ;
2018-08-04 00:17:33 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : set_use_file_access_save_and_swap ( bool p_enable ) {
2014-08-02 01:10:38 +00:00
FileAccess : : set_backup_save ( p_enable ) ;
}
2021-08-13 14:46:14 +00:00
void OS : : set_low_processor_usage_mode ( bool p_enabled ) {
: : OS : : get_singleton ( ) - > set_low_processor_usage_mode ( p_enabled ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool OS : : is_in_low_processor_usage_mode ( ) const {
return : : OS : : get_singleton ( ) - > is_in_low_processor_usage_mode ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : set_low_processor_usage_mode_sleep_usec ( int p_usec ) {
: : OS : : get_singleton ( ) - > set_low_processor_usage_mode_sleep_usec ( p_usec ) ;
2019-11-08 17:36:06 +00:00
}
2021-08-13 14:46:14 +00:00
int OS : : get_low_processor_usage_mode_sleep_usec ( ) const {
return : : OS : : get_singleton ( ) - > get_low_processor_usage_mode_sleep_usec ( ) ;
2019-11-08 17:36:06 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : alert ( const String & p_alert , const String & p_title ) {
: : OS : : get_singleton ( ) - > alert ( p_alert , p_title ) ;
2021-07-22 16:23:48 +00:00
}
2021-12-03 19:36:47 +00:00
void OS : : crash ( const String & p_message ) {
CRASH_NOW_MSG ( p_message ) ;
}
2022-07-08 12:38:30 +00:00
Vector < String > OS : : get_system_fonts ( ) const {
return : : OS : : get_singleton ( ) - > get_system_fonts ( ) ;
}
String OS : : get_system_font_path ( const String & p_font_name , bool p_bold , bool p_italic ) const {
return : : OS : : get_singleton ( ) - > get_system_font_path ( p_font_name , p_bold , p_italic ) ;
}
2021-08-13 14:46:14 +00:00
String OS : : get_executable_path ( ) const {
return : : OS : : get_singleton ( ) - > get_executable_path ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Error OS : : shell_open ( String p_uri ) {
2020-04-28 17:25:02 +00:00
if ( p_uri . begins_with ( " res:// " ) ) {
WARN_PRINT ( " Attempting to open an URL with the \" res:// \" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_open()`. " ) ;
} else if ( p_uri . begins_with ( " user:// " ) ) {
WARN_PRINT ( " Attempting to open an URL with the \" user:// \" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_open()`. " ) ;
}
2021-08-13 14:46:14 +00:00
return : : OS : : get_singleton ( ) - > shell_open ( p_uri ) ;
2020-05-19 13:46:49 +00:00
}
2014-02-10 01:10:30 +00:00
2021-12-16 13:00:55 +00:00
int OS : : execute ( const String & p_path , const Vector < String > & p_arguments , Array r_output , bool p_read_stderr , bool p_open_console ) {
2014-02-10 01:10:30 +00:00
List < String > args ;
2020-05-14 14:41:43 +00:00
for ( int i = 0 ; i < p_arguments . size ( ) ; i + + ) {
2014-02-10 01:10:30 +00:00
args . push_back ( p_arguments [ i ] ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
String pipe ;
2020-12-18 18:49:13 +00:00
int exitcode = 0 ;
2021-12-16 13:00:55 +00:00
Error err = : : OS : : get_singleton ( ) - > execute ( p_path , args , & pipe , & exitcode , p_read_stderr , nullptr , p_open_console ) ;
2020-12-18 18:49:13 +00:00
r_output . push_back ( pipe ) ;
if ( err ! = OK ) {
return - 1 ;
}
return exitcode ;
}
2021-11-01 09:12:52 +00:00
int OS : : create_instance ( const Vector < String > & p_arguments ) {
List < String > args ;
for ( int i = 0 ; i < p_arguments . size ( ) ; i + + ) {
args . push_back ( p_arguments [ i ] ) ;
}
: : OS : : ProcessID pid = 0 ;
Error err = : : OS : : get_singleton ( ) - > create_instance ( args , & pid ) ;
if ( err ! = OK ) {
return - 1 ;
}
return pid ;
}
2021-12-16 13:00:55 +00:00
int OS : : create_process ( const String & p_path , const Vector < String > & p_arguments , bool p_open_console ) {
2020-12-18 18:49:13 +00:00
List < String > args ;
for ( int i = 0 ; i < p_arguments . size ( ) ; i + + ) {
args . push_back ( p_arguments [ i ] ) ;
}
2021-08-13 14:46:14 +00:00
: : OS : : ProcessID pid = 0 ;
2021-12-16 13:00:55 +00:00
Error err = : : OS : : get_singleton ( ) - > create_process ( p_path , args , & pid , p_open_console ) ;
2020-05-14 14:41:43 +00:00
if ( err ! = OK ) {
2014-02-10 01:10:30 +00:00
return - 1 ;
2020-05-14 14:41:43 +00:00
}
2020-12-18 18:49:13 +00:00
return pid ;
2014-02-10 01:10:30 +00:00
}
2018-05-30 10:18:01 +00:00
2021-08-13 14:46:14 +00:00
Error OS : : kill ( int p_pid ) {
return : : OS : : get_singleton ( ) - > kill ( p_pid ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 03:36:23 +00:00
bool OS : : is_process_running ( int p_pid ) const {
return : : OS : : get_singleton ( ) - > is_process_running ( p_pid ) ;
}
2021-08-13 14:46:14 +00:00
int OS : : get_process_id ( ) const {
return : : OS : : get_singleton ( ) - > get_process_id ( ) ;
2020-05-19 13:46:49 +00:00
}
2014-04-05 15:39:30 +00:00
2021-08-13 14:46:14 +00:00
bool OS : : has_environment ( const String & p_var ) const {
return : : OS : : get_singleton ( ) - > has_environment ( p_var ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
String OS : : get_environment ( const String & p_var ) const {
return : : OS : : get_singleton ( ) - > get_environment ( p_var ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
bool OS : : set_environment ( const String & p_var , const String & p_value ) const {
return : : OS : : get_singleton ( ) - > set_environment ( p_var , p_value ) ;
2021-02-25 11:20:13 +00:00
}
2021-08-13 14:46:14 +00:00
String OS : : get_name ( ) const {
return : : OS : : get_singleton ( ) - > get_name ( ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Vector < String > OS : : get_cmdline_args ( ) {
List < String > cmdline = : : OS : : get_singleton ( ) - > get_cmdline_args ( ) ;
2014-02-10 01:10:30 +00:00
Vector < String > cmdlinev ;
2021-07-24 13:46:25 +00:00
for ( const String & E : cmdline ) {
2021-07-16 03:45:57 +00:00
cmdlinev . push_back ( E ) ;
2014-02-10 01:10:30 +00:00
}
return cmdlinev ;
}
2022-07-29 13:30:52 +00:00
Vector < String > OS : : get_cmdline_user_args ( ) {
List < String > cmdline = : : OS : : get_singleton ( ) - > get_cmdline_user_args ( ) ;
Vector < String > cmdlinev ;
for ( const String & E : cmdline ) {
cmdlinev . push_back ( E ) ;
}
return cmdlinev ;
}
2021-05-12 01:12:59 +00:00
void OS : : set_restart_on_exit ( bool p_restart , const Vector < String > & p_restart_arguments ) {
List < String > args_list ;
for ( const String & restart_argument : p_restart_arguments ) {
args_list . push_back ( restart_argument ) ;
}
: : OS : : get_singleton ( ) - > set_restart_on_exit ( p_restart , args_list ) ;
}
bool OS : : is_restart_on_exit_set ( ) const {
return : : OS : : get_singleton ( ) - > is_restart_on_exit_set ( ) ;
}
Vector < String > OS : : get_restart_on_exit_arguments ( ) const {
List < String > args = : : OS : : get_singleton ( ) - > get_restart_on_exit_arguments ( ) ;
Vector < String > args_vector ;
for ( List < String > : : Element * E = args . front ( ) ; E ; E = E - > next ( ) ) {
args_vector . push_back ( E - > get ( ) ) ;
}
return args_vector ;
}
2021-08-13 14:46:14 +00:00
String OS : : get_locale ( ) const {
return : : OS : : get_singleton ( ) - > get_locale ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-09-16 07:27:56 +00:00
String OS : : get_locale_language ( ) const {
return : : OS : : get_singleton ( ) - > get_locale_language ( ) ;
}
2021-08-13 14:46:14 +00:00
String OS : : get_model_name ( ) const {
return : : OS : : get_singleton ( ) - > get_model_name ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Error OS : : set_thread_name ( const String & p_name ) {
return : : Thread : : set_name ( p_name ) ;
2020-05-19 13:46:49 +00:00
}
2016-01-31 23:22:38 +00:00
2021-08-13 14:46:14 +00:00
: : Thread : : ID OS : : get_thread_caller_id ( ) const {
return : : Thread : : get_caller_id ( ) ;
2020-12-27 15:49:46 +00:00
} ;
2021-11-13 00:10:33 +00:00
: : Thread : : ID OS : : get_main_thread_id ( ) const {
return : : Thread : : get_main_id ( ) ;
} ;
2021-08-13 14:46:14 +00:00
bool OS : : has_feature ( const String & p_feature ) const {
return : : OS : : get_singleton ( ) - > has_feature ( p_feature ) ;
2017-10-02 19:38:39 +00:00
}
2021-08-13 14:46:14 +00:00
uint64_t OS : : get_static_memory_usage ( ) const {
return : : OS : : get_singleton ( ) - > get_static_memory_usage ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
uint64_t OS : : get_static_memory_peak_usage ( ) const {
return : : OS : : get_singleton ( ) - > get_static_memory_peak_usage ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-02-18 20:59:09 +00:00
/** This method uses a signed argument for better error reporting as it's used from the scripting API. */
2021-08-13 14:46:14 +00:00
void OS : : delay_usec ( int p_usec ) const {
2021-02-18 20:59:09 +00:00
ERR_FAIL_COND_MSG (
p_usec < 0 ,
vformat ( " Can't sleep for %d microseconds. The delay provided must be greater than or equal to 0 microseconds. " , p_usec ) ) ;
2021-08-13 14:46:14 +00:00
: : OS : : get_singleton ( ) - > delay_usec ( p_usec ) ;
2014-02-10 01:10:30 +00:00
}
2021-02-18 20:59:09 +00:00
/** This method uses a signed argument for better error reporting as it's used from the scripting API. */
2021-08-13 14:46:14 +00:00
void OS : : delay_msec ( int p_msec ) const {
2021-02-18 20:59:09 +00:00
ERR_FAIL_COND_MSG (
p_msec < 0 ,
vformat ( " Can't sleep for %d milliseconds. The delay provided must be greater than or equal to 0 milliseconds. " , p_msec ) ) ;
2021-08-13 14:46:14 +00:00
: : OS : : get_singleton ( ) - > delay_usec ( int64_t ( p_msec ) * 1000 ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
bool OS : : can_use_threads ( ) const {
return : : OS : : get_singleton ( ) - > can_use_threads ( ) ;
2014-03-14 01:57:24 +00:00
}
2021-08-13 14:46:14 +00:00
bool OS : : is_userfs_persistent ( ) const {
return : : OS : : get_singleton ( ) - > is_userfs_persistent ( ) ;
2017-10-02 14:09:24 +00:00
}
2021-08-13 14:46:14 +00:00
int OS : : get_processor_count ( ) const {
return : : OS : : get_singleton ( ) - > get_processor_count ( ) ;
2014-02-10 01:10:30 +00:00
}
2020-12-27 00:50:21 +00:00
String OS : : get_processor_name ( ) const {
return : : OS : : get_singleton ( ) - > get_processor_name ( ) ;
}
2021-08-13 14:46:14 +00:00
bool OS : : is_stdout_verbose ( ) const {
return : : OS : : get_singleton ( ) - > is_stdout_verbose ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
struct OSCoreBindImg {
2014-02-26 13:08:17 +00:00
String path ;
Size2 size ;
2020-11-23 16:38:46 +00:00
int fmt = 0 ;
2014-02-26 13:08:17 +00:00
ObjectID id ;
2020-11-23 16:38:46 +00:00
int vram = 0 ;
2021-08-13 14:46:14 +00:00
bool operator < ( const OSCoreBindImg & p_img ) const { return vram = = p_img . vram ? id < p_img . id : vram > p_img . vram ; }
2014-02-26 13:08:17 +00:00
} ;
2021-08-13 14:46:14 +00:00
void OS : : print_all_textures_by_size ( ) {
List < OSCoreBindImg > imgs ;
2021-03-05 21:48:11 +00:00
uint64_t total = 0 ;
2014-02-26 13:08:17 +00:00
{
2020-03-17 06:33:00 +00:00
List < Ref < Resource > > rsrc ;
2014-02-26 13:08:17 +00:00
ResourceCache : : get_cached_resources ( & rsrc ) ;
2021-07-26 15:50:35 +00:00
for ( Ref < Resource > & res : rsrc ) {
2021-02-28 11:10:47 +00:00
if ( ! res - > is_class ( " Texture " ) ) {
2014-02-26 13:08:17 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2014-02-26 13:08:17 +00:00
2021-07-26 15:50:35 +00:00
Size2 size = res - > call ( " get_size " ) ;
int fmt = res - > call ( " get_format " ) ;
2014-02-26 13:08:17 +00:00
2021-08-13 14:46:14 +00:00
OSCoreBindImg img ;
2017-03-05 15:44:50 +00:00
img . size = size ;
img . fmt = fmt ;
2021-07-26 15:50:35 +00:00
img . path = res - > get_path ( ) ;
2017-03-05 15:44:50 +00:00
img . vram = Image : : get_image_data_size ( img . size . width , img . size . height , Image : : Format ( img . fmt ) ) ;
2021-07-26 15:50:35 +00:00
img . id = res - > get_instance_id ( ) ;
2017-03-05 15:44:50 +00:00
total + = img . vram ;
2014-02-26 13:08:17 +00:00
imgs . push_back ( img ) ;
}
}
imgs . sort ( ) ;
2021-02-28 11:10:47 +00:00
if ( imgs . size ( ) = = 0 ) {
print_line ( " No textures seem used in this project. " ) ;
} else {
print_line ( " Textures currently in use, sorted by VRAM usage: \n "
" Path - VRAM usage (Dimensions) " ) ;
2014-02-26 13:08:17 +00:00
}
2021-02-28 11:10:47 +00:00
2021-08-13 14:46:14 +00:00
for ( const OSCoreBindImg & img : imgs ) {
2021-02-28 11:10:47 +00:00
print_line ( vformat ( " %s - %s %s " ,
img . path ,
String : : humanize_size ( img . vram ) ,
img . size ) ) ;
}
print_line ( vformat ( " Total VRAM usage: %s. " , String : : humanize_size ( total ) ) ) ;
2014-05-14 04:22:15 +00:00
}
2014-02-26 13:08:17 +00:00
2021-08-13 14:46:14 +00:00
void OS : : print_resources_by_type ( const Vector < String > & p_types ) {
2021-02-28 11:10:47 +00:00
ERR_FAIL_COND_MSG ( p_types . size ( ) = = 0 ,
" At least one type should be provided to print resources by type. " ) ;
print_line ( vformat ( " Resources currently in use for the following types: %s " , p_types ) ) ;
2014-05-14 04:22:15 +00:00
2022-05-13 13:04:37 +00:00
RBMap < String , int > type_count ;
2020-03-17 06:33:00 +00:00
List < Ref < Resource > > resources ;
2014-05-14 04:22:15 +00:00
ResourceCache : : get_cached_resources ( & resources ) ;
2021-07-26 15:50:35 +00:00
for ( const Ref < Resource > & r : resources ) {
2014-05-14 04:22:15 +00:00
bool found = false ;
2017-03-05 15:44:50 +00:00
for ( int i = 0 ; i < p_types . size ( ) ; i + + ) {
2020-05-14 14:41:43 +00:00
if ( r - > is_class ( p_types [ i ] ) ) {
2014-05-14 04:22:15 +00:00
found = true ;
2020-05-14 14:41:43 +00:00
}
2014-05-14 04:22:15 +00:00
}
2020-05-14 14:41:43 +00:00
if ( ! found ) {
2014-05-14 04:22:15 +00:00
continue ;
2020-05-14 14:41:43 +00:00
}
2014-05-14 04:22:15 +00:00
2017-01-03 02:03:46 +00:00
if ( ! type_count . has ( r - > get_class ( ) ) ) {
2017-03-05 15:44:50 +00:00
type_count [ r - > get_class ( ) ] = 0 ;
2014-05-14 04:22:15 +00:00
}
2017-01-03 02:03:46 +00:00
type_count [ r - > get_class ( ) ] + + ;
2021-02-28 11:10:47 +00:00
print_line ( vformat ( " %s: %s " , r - > get_class ( ) , r - > get_path ( ) ) ) ;
List < StringName > metas ;
r - > get_meta_list ( & metas ) ;
for ( const StringName & meta : metas ) {
print_line ( vformat ( " %s: %s " , meta , r - > get_meta ( meta ) ) ) ;
}
}
for ( const KeyValue < String , int > & E : type_count ) {
print_line ( vformat ( " %s count: %d " , E . key , E . value ) ) ;
2014-05-14 04:22:15 +00:00
}
2020-05-19 13:46:49 +00:00
}
2014-02-26 13:08:17 +00:00
2021-08-13 14:46:14 +00:00
void OS : : print_all_resources ( const String & p_to_file ) {
: : OS : : get_singleton ( ) - > print_all_resources ( p_to_file ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : print_resources_in_use ( bool p_short ) {
: : OS : : get_singleton ( ) - > print_resources_in_use ( p_short ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void OS : : dump_resources_to_file ( const String & p_file ) {
: : OS : : get_singleton ( ) - > dump_resources_to_file ( p_file . utf8 ( ) . get_data ( ) ) ;
2014-02-10 01:10:30 +00:00
}
2022-04-26 21:52:20 +00:00
Error OS : : move_to_trash ( const String & p_path ) const {
return : : OS : : get_singleton ( ) - > move_to_trash ( p_path ) ;
}
2021-08-13 14:46:14 +00:00
String OS : : get_user_data_dir ( ) const {
return : : OS : : get_singleton ( ) - > get_user_data_dir ( ) ;
2020-05-19 13:46:49 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
String OS : : get_config_dir ( ) const {
2021-05-07 17:36:32 +00:00
// Exposed as `get_config_dir()` instead of `get_config_path()` for consistency with other exposed OS methods.
2021-08-13 14:46:14 +00:00
return : : OS : : get_singleton ( ) - > get_config_path ( ) ;
2021-05-07 17:36:32 +00:00
}
2021-08-13 14:46:14 +00:00
String OS : : get_data_dir ( ) const {
2021-05-07 17:36:32 +00:00
// Exposed as `get_data_dir()` instead of `get_data_path()` for consistency with other exposed OS methods.
2021-08-13 14:46:14 +00:00
return : : OS : : get_singleton ( ) - > get_data_path ( ) ;
2021-05-07 17:36:32 +00:00
}
2021-08-13 14:46:14 +00:00
String OS : : get_cache_dir ( ) const {
2021-05-07 17:36:32 +00:00
// Exposed as `get_cache_dir()` instead of `get_cache_path()` for consistency with other exposed OS methods.
2021-08-13 14:46:14 +00:00
return : : OS : : get_singleton ( ) - > get_cache_path ( ) ;
2021-05-07 17:36:32 +00:00
}
2021-08-13 14:46:14 +00:00
bool OS : : is_debug_build ( ) const {
2014-11-02 14:31:01 +00:00
# ifdef DEBUG_ENABLED
return true ;
# else
return false ;
# endif
}
2014-12-02 17:02:41 +00:00
2021-08-13 14:46:14 +00:00
String OS : : get_system_dir ( SystemDir p_dir , bool p_shared_storage ) const {
return : : OS : : get_singleton ( ) - > get_system_dir ( : : OS : : SystemDir ( p_dir ) , p_shared_storage ) ;
2014-12-02 17:02:41 +00:00
}
2021-08-13 21:31:57 +00:00
String OS : : get_keycode_string ( Key p_code ) const {
2021-08-13 14:46:14 +00:00
return : : keycode_get_string ( p_code ) ;
2015-05-17 16:11:55 +00:00
}
2018-04-05 17:59:35 +00:00
2021-08-13 21:31:57 +00:00
bool OS : : is_keycode_unicode ( char32_t p_unicode ) const {
return : : keycode_has_unicode ( ( Key ) p_unicode ) ;
2015-05-17 16:11:55 +00:00
}
2018-04-05 17:59:35 +00:00
2021-08-13 21:31:57 +00:00
Key OS : : find_keycode_from_string ( const String & p_code ) const {
2015-05-17 16:11:55 +00:00
return find_keycode ( p_code ) ;
}
2021-08-13 14:46:14 +00:00
bool OS : : request_permission ( const String & p_name ) {
return : : OS : : get_singleton ( ) - > request_permission ( p_name ) ;
2019-03-05 02:06:37 +00:00
}
2021-08-13 14:46:14 +00:00
bool OS : : request_permissions ( ) {
return : : OS : : get_singleton ( ) - > request_permissions ( ) ;
2019-10-06 18:17:44 +00:00
}
2021-08-13 14:46:14 +00:00
Vector < String > OS : : get_granted_permissions ( ) const {
return : : OS : : get_singleton ( ) - > get_granted_permissions ( ) ;
2019-10-06 18:17:44 +00:00
}
2021-08-13 14:46:14 +00:00
String OS : : get_unique_id ( ) const {
return : : OS : : get_singleton ( ) - > get_unique_id ( ) ;
2020-03-03 13:36:29 +00:00
}
2020-05-12 15:01:17 +00:00
2021-08-13 14:46:14 +00:00
OS * OS : : singleton = nullptr ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
void OS : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " get_connected_midi_inputs " ) , & OS : : get_connected_midi_inputs ) ;
ClassDB : : bind_method ( D_METHOD ( " open_midi_inputs " ) , & OS : : open_midi_inputs ) ;
ClassDB : : bind_method ( D_METHOD ( " close_midi_inputs " ) , & OS : : close_midi_inputs ) ;
2018-03-04 17:18:05 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " alert " , " text " , " title " ) , & OS : : alert , DEFVAL ( " Alert! " ) ) ;
2021-12-03 19:36:47 +00:00
ClassDB : : bind_method ( D_METHOD ( " crash " , " message " ) , & OS : : crash ) ;
2021-07-22 16:23:48 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_low_processor_usage_mode " , " enable " ) , & OS : : set_low_processor_usage_mode ) ;
ClassDB : : bind_method ( D_METHOD ( " is_in_low_processor_usage_mode " ) , & OS : : is_in_low_processor_usage_mode ) ;
2017-02-13 11:47:24 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_low_processor_usage_mode_sleep_usec " , " usec " ) , & OS : : set_low_processor_usage_mode_sleep_usec ) ;
ClassDB : : bind_method ( D_METHOD ( " get_low_processor_usage_mode_sleep_usec " ) , & OS : : get_low_processor_usage_mode_sleep_usec ) ;
2019-11-08 17:36:06 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_processor_count " ) , & OS : : get_processor_count ) ;
2020-12-27 00:50:21 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_processor_name " ) , & OS : : get_processor_name ) ;
2017-02-13 11:47:24 +00:00
2022-07-08 12:38:30 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_system_fonts " ) , & OS : : get_system_fonts ) ;
ClassDB : : bind_method ( D_METHOD ( " get_system_font_path " , " font_name " , " bold " , " italic " ) , & OS : : get_system_font_path , DEFVAL ( false ) , DEFVAL ( false ) ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_executable_path " ) , & OS : : get_executable_path ) ;
2021-12-16 13:00:55 +00:00
ClassDB : : bind_method ( D_METHOD ( " execute " , " path " , " arguments " , " output " , " read_stderr " , " open_console " ) , & OS : : execute , DEFVAL ( Array ( ) ) , DEFVAL ( false ) , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " create_process " , " path " , " arguments " , " open_console " ) , & OS : : create_process , DEFVAL ( false ) ) ;
2021-11-01 09:12:52 +00:00
ClassDB : : bind_method ( D_METHOD ( " create_instance " , " arguments " ) , & OS : : create_instance ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " kill " , " pid " ) , & OS : : kill ) ;
ClassDB : : bind_method ( D_METHOD ( " shell_open " , " uri " ) , & OS : : shell_open ) ;
2021-08-13 03:36:23 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_process_running " , " pid " ) , & OS : : is_process_running ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_process_id " ) , & OS : : get_process_id ) ;
2017-02-13 11:47:24 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_environment " , " variable " ) , & OS : : get_environment ) ;
ClassDB : : bind_method ( D_METHOD ( " set_environment " , " variable " , " value " ) , & OS : : set_environment ) ;
ClassDB : : bind_method ( D_METHOD ( " has_environment " , " variable " ) , & OS : : has_environment ) ;
2017-02-13 11:47:24 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_name " ) , & OS : : get_name ) ;
ClassDB : : bind_method ( D_METHOD ( " get_cmdline_args " ) , & OS : : get_cmdline_args ) ;
2022-07-29 13:30:52 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_cmdline_user_args " ) , & OS : : get_cmdline_user_args ) ;
2017-02-13 11:47:24 +00:00
2021-05-12 01:12:59 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_restart_on_exit " , " restart " , " arguments " ) , & OS : : set_restart_on_exit , DEFVAL ( Vector < String > ( ) ) ) ;
ClassDB : : bind_method ( D_METHOD ( " is_restart_on_exit_set " ) , & OS : : is_restart_on_exit_set ) ;
ClassDB : : bind_method ( D_METHOD ( " get_restart_on_exit_arguments " ) , & OS : : get_restart_on_exit_arguments ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " delay_usec " , " usec " ) , & OS : : delay_usec ) ;
ClassDB : : bind_method ( D_METHOD ( " delay_msec " , " msec " ) , & OS : : delay_msec ) ;
ClassDB : : bind_method ( D_METHOD ( " get_locale " ) , & OS : : get_locale ) ;
2021-09-16 07:27:56 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_locale_language " ) , & OS : : get_locale_language ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_model_name " ) , & OS : : get_model_name ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_userfs_persistent " ) , & OS : : is_userfs_persistent ) ;
ClassDB : : bind_method ( D_METHOD ( " is_stdout_verbose " ) , & OS : : is_stdout_verbose ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " can_use_threads " ) , & OS : : can_use_threads ) ;
2014-03-14 01:57:24 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_debug_build " ) , & OS : : is_debug_build ) ;
2014-11-02 14:31:01 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " dump_resources_to_file " , " file " ) , & OS : : dump_resources_to_file ) ;
ClassDB : : bind_method ( D_METHOD ( " print_resources_in_use " , " short " ) , & OS : : print_resources_in_use , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " print_all_resources " , " tofile " ) , & OS : : print_all_resources , DEFVAL ( " " ) ) ;
2017-03-05 15:44:50 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_static_memory_usage " ) , & OS : : get_static_memory_usage ) ;
ClassDB : : bind_method ( D_METHOD ( " get_static_memory_peak_usage " ) , & OS : : get_static_memory_peak_usage ) ;
2017-03-05 15:44:50 +00:00
2022-04-26 21:52:20 +00:00
ClassDB : : bind_method ( D_METHOD ( " move_to_trash " , " path " ) , & OS : : move_to_trash ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_user_data_dir " ) , & OS : : get_user_data_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " get_system_dir " , " dir " , " shared_storage " ) , & OS : : get_system_dir , DEFVAL ( true ) ) ;
ClassDB : : bind_method ( D_METHOD ( " get_config_dir " ) , & OS : : get_config_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " get_data_dir " ) , & OS : : get_data_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " get_cache_dir " ) , & OS : : get_cache_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " get_unique_id " ) , & OS : : get_unique_id ) ;
2017-03-05 15:44:50 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " print_all_textures_by_size " ) , & OS : : print_all_textures_by_size ) ;
ClassDB : : bind_method ( D_METHOD ( " print_resources_by_type " , " types " ) , & OS : : print_resources_by_type ) ;
2017-03-05 15:44:50 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_keycode_string " , " code " ) , & OS : : get_keycode_string ) ;
ClassDB : : bind_method ( D_METHOD ( " is_keycode_unicode " , " code " ) , & OS : : is_keycode_unicode ) ;
ClassDB : : bind_method ( D_METHOD ( " find_keycode_from_string " , " string " ) , & OS : : find_keycode_from_string ) ;
2017-03-05 15:44:50 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_use_file_access_save_and_swap " , " enabled " ) , & OS : : set_use_file_access_save_and_swap ) ;
2017-03-05 15:44:50 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_thread_name " , " name " ) , & OS : : set_thread_name ) ;
ClassDB : : bind_method ( D_METHOD ( " get_thread_caller_id " ) , & OS : : get_thread_caller_id ) ;
2021-11-13 00:10:33 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_main_thread_id " ) , & OS : : get_main_thread_id ) ;
2017-03-05 15:44:50 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " has_feature " , " tag_name " ) , & OS : : has_feature ) ;
2017-10-02 19:38:39 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " request_permission " , " name " ) , & OS : : request_permission ) ;
ClassDB : : bind_method ( D_METHOD ( " request_permissions " ) , & OS : : request_permissions ) ;
ClassDB : : bind_method ( D_METHOD ( " get_granted_permissions " ) , & OS : : get_granted_permissions ) ;
2019-03-05 02:06:37 +00:00
2018-01-11 22:35:12 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " low_processor_usage_mode " ) , " set_low_processor_usage_mode " , " is_in_low_processor_usage_mode " ) ;
2019-11-08 17:36:06 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : INT , " low_processor_usage_mode_sleep_usec " ) , " set_low_processor_usage_mode_sleep_usec " , " get_low_processor_usage_mode_sleep_usec " ) ;
2018-01-11 22:35:12 +00:00
2019-06-30 11:19:00 +00:00
// Those default values need to be specified for the docs generator,
// to avoid using values from the documentation writer's own OS instance.
ADD_PROPERTY_DEFAULT ( " low_processor_usage_mode " , false ) ;
2019-11-08 17:36:06 +00:00
ADD_PROPERTY_DEFAULT ( " low_processor_usage_mode_sleep_usec " , 6900 ) ;
2019-06-30 11:19:00 +00:00
2020-02-13 09:08:52 +00:00
BIND_ENUM_CONSTANT ( VIDEO_DRIVER_VULKAN ) ;
2021-10-26 15:18:39 +00:00
BIND_ENUM_CONSTANT ( VIDEO_DRIVER_OPENGL_3 ) ;
2019-02-16 13:40:52 +00:00
2017-08-20 15:45:01 +00:00
BIND_ENUM_CONSTANT ( DAY_SUNDAY ) ;
BIND_ENUM_CONSTANT ( DAY_MONDAY ) ;
BIND_ENUM_CONSTANT ( DAY_TUESDAY ) ;
BIND_ENUM_CONSTANT ( DAY_WEDNESDAY ) ;
BIND_ENUM_CONSTANT ( DAY_THURSDAY ) ;
BIND_ENUM_CONSTANT ( DAY_FRIDAY ) ;
BIND_ENUM_CONSTANT ( DAY_SATURDAY ) ;
BIND_ENUM_CONSTANT ( MONTH_JANUARY ) ;
BIND_ENUM_CONSTANT ( MONTH_FEBRUARY ) ;
BIND_ENUM_CONSTANT ( MONTH_MARCH ) ;
BIND_ENUM_CONSTANT ( MONTH_APRIL ) ;
BIND_ENUM_CONSTANT ( MONTH_MAY ) ;
BIND_ENUM_CONSTANT ( MONTH_JUNE ) ;
BIND_ENUM_CONSTANT ( MONTH_JULY ) ;
BIND_ENUM_CONSTANT ( MONTH_AUGUST ) ;
BIND_ENUM_CONSTANT ( MONTH_SEPTEMBER ) ;
BIND_ENUM_CONSTANT ( MONTH_OCTOBER ) ;
BIND_ENUM_CONSTANT ( MONTH_NOVEMBER ) ;
BIND_ENUM_CONSTANT ( MONTH_DECEMBER ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_DESKTOP ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_DCIM ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_DOCUMENTS ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_DOWNLOADS ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_MOVIES ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_MUSIC ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_PICTURES ) ;
BIND_ENUM_CONSTANT ( SYSTEM_DIR_RINGTONES ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
////// Geometry2D //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Geometry2D * Geometry2D : : singleton = nullptr ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Geometry2D * Geometry2D : : get_singleton ( ) {
2014-02-10 01:10:30 +00:00
return singleton ;
}
2021-08-13 14:46:14 +00:00
bool Geometry2D : : is_point_in_circle ( const Vector2 & p_point , const Vector2 & p_circle_pos , real_t p_circle_radius ) {
return : : Geometry2D : : is_point_in_circle ( p_point , p_circle_pos , p_circle_radius ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
real_t Geometry2D : : segment_intersects_circle ( const Vector2 & p_from , const Vector2 & p_to , const Vector2 & p_circle_pos , real_t p_circle_radius ) {
return : : Geometry2D : : segment_intersects_circle ( p_from , p_to , p_circle_pos , p_circle_radius ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Variant Geometry2D : : segment_intersects_segment ( const Vector2 & p_from_a , const Vector2 & p_to_a , const Vector2 & p_from_b , const Vector2 & p_to_b ) {
2014-02-10 01:10:30 +00:00
Vector2 result ;
2021-08-13 14:46:14 +00:00
if ( : : Geometry2D : : segment_intersects_segment ( p_from_a , p_to_a , p_from_b , p_to_b , & result ) ) {
2014-02-10 01:10:30 +00:00
return result ;
} else {
return Variant ( ) ;
2020-05-19 13:46:49 +00:00
}
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Variant Geometry2D : : line_intersects_line ( const Vector2 & p_from_a , const Vector2 & p_dir_a , const Vector2 & p_from_b , const Vector2 & p_dir_b ) {
2018-01-21 08:21:02 +00:00
Vector2 result ;
2021-08-13 14:46:14 +00:00
if ( : : Geometry2D : : line_intersects_line ( p_from_a , p_dir_a , p_from_b , p_dir_b , result ) ) {
2018-01-21 08:21:02 +00:00
return result ;
} else {
return Variant ( ) ;
}
}
2021-08-13 14:46:14 +00:00
Vector < Vector2 > Geometry2D : : get_closest_points_between_segments ( const Vector2 & p1 , const Vector2 & q1 , const Vector2 & p2 , const Vector2 & q2 ) {
2014-02-10 01:10:30 +00:00
Vector2 r1 , r2 ;
2021-08-13 14:46:14 +00:00
: : Geometry2D : : get_closest_points_between_segments ( p1 , q1 , p2 , q2 , r1 , r2 ) ;
2022-01-11 15:27:39 +00:00
Vector < Vector2 > r = { r1 , r2 } ;
2014-02-10 01:10:30 +00:00
return r ;
}
2021-08-13 14:46:14 +00:00
Vector2 Geometry2D : : get_closest_point_to_segment ( const Vector2 & p_point , const Vector2 & p_a , const Vector2 & p_b ) {
2017-03-05 15:44:50 +00:00
Vector2 s [ 2 ] = { p_a , p_b } ;
2021-08-13 14:46:14 +00:00
return : : Geometry2D : : get_closest_point_to_segment ( p_point , s ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Vector2 Geometry2D : : get_closest_point_to_segment_uncapped ( const Vector2 & p_point , const Vector2 & p_a , const Vector2 & p_b ) {
2017-03-05 15:44:50 +00:00
Vector2 s [ 2 ] = { p_a , p_b } ;
2021-08-13 14:46:14 +00:00
return : : Geometry2D : : get_closest_point_to_segment_uncapped ( p_point , s ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool Geometry2D : : point_is_inside_triangle ( const Vector2 & s , const Vector2 & a , const Vector2 & b , const Vector2 & c ) const {
return : : Geometry2D : : is_point_in_triangle ( s , a , b , c ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool Geometry2D : : is_polygon_clockwise ( const Vector < Vector2 > & p_polygon ) {
return : : Geometry2D : : is_polygon_clockwise ( p_polygon ) ;
2019-06-26 21:20:22 +00:00
}
2021-08-13 14:46:14 +00:00
bool Geometry2D : : is_point_in_polygon ( const Point2 & p_point , const Vector < Vector2 > & p_polygon ) {
return : : Geometry2D : : is_point_in_polygon ( p_point , p_polygon ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Vector < int > Geometry2D : : triangulate_polygon ( const Vector < Vector2 > & p_polygon ) {
return : : Geometry2D : : triangulate_polygon ( p_polygon ) ;
2019-05-23 13:53:53 +00:00
}
2021-08-13 14:46:14 +00:00
Vector < int > Geometry2D : : triangulate_delaunay ( const Vector < Vector2 > & p_points ) {
return : : Geometry2D : : triangulate_delaunay ( p_points ) ;
2017-11-04 23:46:32 +00:00
}
2021-08-13 14:46:14 +00:00
Vector < Point2 > Geometry2D : : convex_hull ( const Vector < Point2 > & p_points ) {
return : : Geometry2D : : convex_hull ( p_points ) ;
2017-11-04 23:46:32 +00:00
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : merge_polygons ( const Vector < Vector2 > & p_polygon_a , const Vector < Vector2 > & p_polygon_b ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : merge_polygons ( p_polygon_a , p_polygon_b ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : clip_polygons ( const Vector < Vector2 > & p_polygon_a , const Vector < Vector2 > & p_polygon_b ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : clip_polygons ( p_polygon_a , p_polygon_b ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > ret ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : intersect_polygons ( const Vector < Vector2 > & p_polygon_a , const Vector < Vector2 > & p_polygon_b ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : intersect_polygons ( p_polygon_a , p_polygon_b ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : exclude_polygons ( const Vector < Vector2 > & p_polygon_a , const Vector < Vector2 > & p_polygon_b ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : exclude_polygons ( p_polygon_a , p_polygon_b ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : clip_polyline_with_polygon ( const Vector < Vector2 > & p_polyline , const Vector < Vector2 > & p_polygon ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : clip_polyline_with_polygon ( p_polyline , p_polygon ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : intersect_polyline_with_polygon ( const Vector < Vector2 > & p_polyline , const Vector < Vector2 > & p_polygon ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : intersect_polyline_with_polygon ( p_polyline , p_polygon ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : offset_polygon ( const Vector < Vector2 > & p_polygon , real_t p_delta , PolyJoinType p_join_type ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : offset_polygon ( p_polygon , p_delta , : : Geometry2D : : PolyJoinType ( p_join_type ) ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2022-08-05 18:35:08 +00:00
TypedArray < PackedVector2Array > Geometry2D : : offset_polyline ( const Vector < Vector2 > & p_polygon , real_t p_delta , PolyJoinType p_join_type , PolyEndType p_end_type ) {
2021-08-13 14:46:14 +00:00
Vector < Vector < Point2 > > polys = : : Geometry2D : : offset_polyline ( p_polygon , p_delta , : : Geometry2D : : PolyJoinType ( p_join_type ) , : : Geometry2D : : PolyEndType ( p_end_type ) ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
Array ret ;
for ( int i = 0 ; i < polys . size ( ) ; + + i ) {
ret . push_back ( polys [ i ] ) ;
}
return ret ;
}
2021-08-13 14:46:14 +00:00
Dictionary Geometry2D : : make_atlas ( const Vector < Size2 > & p_rects ) {
2014-10-03 03:10:51 +00:00
Dictionary ret ;
Vector < Size2i > rects ;
2017-03-05 15:44:50 +00:00
for ( int i = 0 ; i < p_rects . size ( ) ; i + + ) {
2014-10-03 03:10:51 +00:00
rects . push_back ( p_rects [ i ] ) ;
2020-05-19 13:46:49 +00:00
}
2014-10-03 03:10:51 +00:00
Vector < Point2i > result ;
Size2i size ;
2021-08-13 14:46:14 +00:00
: : Geometry2D : : make_atlas ( rects , result , size ) ;
2014-10-03 03:10:51 +00:00
Size2 r_size = size ;
Vector < Point2 > r_result ;
2017-03-05 15:44:50 +00:00
for ( int i = 0 ; i < result . size ( ) ; i + + ) {
2014-10-03 03:10:51 +00:00
r_result . push_back ( result [ i ] ) ;
2020-05-19 13:46:49 +00:00
}
2014-10-03 03:10:51 +00:00
ret [ " points " ] = r_result ;
ret [ " size " ] = r_size ;
return ret ;
2020-05-19 13:46:49 +00:00
}
2014-10-03 03:10:51 +00:00
2021-08-13 14:46:14 +00:00
void Geometry2D : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " is_point_in_circle " , " point " , " circle_position " , " circle_radius " ) , & Geometry2D : : is_point_in_circle ) ;
2022-08-03 13:36:54 +00:00
ClassDB : : bind_method ( D_METHOD ( " segment_intersects_circle " , " segment_from " , " segment_to " , " circle_position " , " circle_radius " ) , & Geometry2D : : segment_intersects_circle ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " segment_intersects_segment " , " from_a " , " to_a " , " from_b " , " to_b " ) , & Geometry2D : : segment_intersects_segment ) ;
ClassDB : : bind_method ( D_METHOD ( " line_intersects_line " , " from_a " , " dir_a " , " from_b " , " dir_b " ) , & Geometry2D : : line_intersects_line ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_closest_points_between_segments " , " p1 " , " q1 " , " p2 " , " q2 " ) , & Geometry2D : : get_closest_points_between_segments ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_closest_point_to_segment " , " point " , " s1 " , " s2 " ) , & Geometry2D : : get_closest_point_to_segment ) ;
2017-03-04 22:02:27 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_closest_point_to_segment_uncapped " , " point " , " s1 " , " s2 " ) , & Geometry2D : : get_closest_point_to_segment_uncapped ) ;
2014-10-07 04:31:49 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " point_is_inside_triangle " , " point " , " a " , " b " , " c " ) , & Geometry2D : : point_is_inside_triangle ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_polygon_clockwise " , " polygon " ) , & Geometry2D : : is_polygon_clockwise ) ;
ClassDB : : bind_method ( D_METHOD ( " is_point_in_polygon " , " point " , " polygon " ) , & Geometry2D : : is_point_in_polygon ) ;
ClassDB : : bind_method ( D_METHOD ( " triangulate_polygon " , " polygon " ) , & Geometry2D : : triangulate_polygon ) ;
ClassDB : : bind_method ( D_METHOD ( " triangulate_delaunay " , " points " ) , & Geometry2D : : triangulate_delaunay ) ;
ClassDB : : bind_method ( D_METHOD ( " convex_hull " , " points " ) , & Geometry2D : : convex_hull ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " merge_polygons " , " polygon_a " , " polygon_b " ) , & Geometry2D : : merge_polygons ) ;
ClassDB : : bind_method ( D_METHOD ( " clip_polygons " , " polygon_a " , " polygon_b " ) , & Geometry2D : : clip_polygons ) ;
ClassDB : : bind_method ( D_METHOD ( " intersect_polygons " , " polygon_a " , " polygon_b " ) , & Geometry2D : : intersect_polygons ) ;
ClassDB : : bind_method ( D_METHOD ( " exclude_polygons " , " polygon_a " , " polygon_b " ) , & Geometry2D : : exclude_polygons ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " clip_polyline_with_polygon " , " polyline " , " polygon " ) , & Geometry2D : : clip_polyline_with_polygon ) ;
ClassDB : : bind_method ( D_METHOD ( " intersect_polyline_with_polygon " , " polyline " , " polygon " ) , & Geometry2D : : intersect_polyline_with_polygon ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " offset_polygon " , " polygon " , " delta " , " join_type " ) , & Geometry2D : : offset_polygon , DEFVAL ( JOIN_SQUARE ) ) ;
ClassDB : : bind_method ( D_METHOD ( " offset_polyline " , " polyline " , " delta " , " join_type " , " end_type " ) , & Geometry2D : : offset_polyline , DEFVAL ( JOIN_SQUARE ) , DEFVAL ( END_SQUARE ) ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " make_atlas " , " sizes " ) , & Geometry2D : : make_atlas ) ;
Expose 2D polygon boolean operations in Geometry singleton
Clipper 6.4.2 is used internally to perform polypaths clipping, as well
as inflating/deflating polypaths. The following methods were added:
```
Geometry.merge_polygons_2d(poly_a, poly_b) # union
Geometry.clip_polygons_2d(poly_a, poly_b) # difference
Geometry.intersect_polygons_2d(poly_a, poly_b) # intersection
Geometry.exclude_polygons_2d(poly_a, poly_b) # xor
Geometry.clip_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.intersect_polyline_with_polygon_2d(poly_a, poly_b)
Geometry.offset_polygon_2d(polygon, delta) # inflate/deflate
Geometry.offset_polyline_2d(polyline, delta) # returns polygons
// This one helps to implement CSG-like behaviour:
Geometry.transform_points_2d(points, transform)
```
All the methods return an array of polygons/polylines. The resulting
polygons could possibly be holes which could be checked with
`Geometry.is_polygon_clockwise()` which was exposed to scripting as well.
2019-05-18 17:01:42 +00:00
BIND_ENUM_CONSTANT ( OPERATION_UNION ) ;
BIND_ENUM_CONSTANT ( OPERATION_DIFFERENCE ) ;
BIND_ENUM_CONSTANT ( OPERATION_INTERSECTION ) ;
BIND_ENUM_CONSTANT ( OPERATION_XOR ) ;
BIND_ENUM_CONSTANT ( JOIN_SQUARE ) ;
BIND_ENUM_CONSTANT ( JOIN_ROUND ) ;
BIND_ENUM_CONSTANT ( JOIN_MITER ) ;
BIND_ENUM_CONSTANT ( END_POLYGON ) ;
BIND_ENUM_CONSTANT ( END_JOINED ) ;
BIND_ENUM_CONSTANT ( END_BUTT ) ;
BIND_ENUM_CONSTANT ( END_SQUARE ) ;
BIND_ENUM_CONSTANT ( END_ROUND ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
////// Geometry3D //////
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
Geometry3D * Geometry3D : : singleton = nullptr ;
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
Geometry3D * Geometry3D : : get_singleton ( ) {
2020-05-25 17:20:45 +00:00
return singleton ;
}
2022-08-05 18:35:08 +00:00
TypedArray < Plane > Geometry3D : : build_box_planes ( const Vector3 & p_extents ) {
Variant ret = : : Geometry3D : : build_box_planes ( p_extents ) ;
return ret ;
2020-05-25 17:20:45 +00:00
}
2022-08-05 18:35:08 +00:00
TypedArray < Plane > Geometry3D : : build_cylinder_planes ( float p_radius , float p_height , int p_sides , Vector3 : : Axis p_axis ) {
Variant ret = : : Geometry3D : : build_cylinder_planes ( p_radius , p_height , p_sides , p_axis ) ;
return ret ;
2020-05-25 17:20:45 +00:00
}
2022-08-05 18:35:08 +00:00
TypedArray < Plane > Geometry3D : : build_capsule_planes ( float p_radius , float p_height , int p_sides , int p_lats , Vector3 : : Axis p_axis ) {
Variant ret = : : Geometry3D : : build_capsule_planes ( p_radius , p_height , p_sides , p_lats , p_axis ) ;
return ret ;
2020-05-25 17:20:45 +00:00
}
2021-08-13 14:46:14 +00:00
Vector < Vector3 > Geometry3D : : get_closest_points_between_segments ( const Vector3 & p1 , const Vector3 & p2 , const Vector3 & q1 , const Vector3 & q2 ) {
2020-05-25 17:20:45 +00:00
Vector3 r1 , r2 ;
2021-08-13 14:46:14 +00:00
: : Geometry3D : : get_closest_points_between_segments ( p1 , p2 , q1 , q2 , r1 , r2 ) ;
2022-01-11 15:27:39 +00:00
Vector < Vector3 > r = { r1 , r2 } ;
2020-05-25 17:20:45 +00:00
return r ;
}
2021-08-13 14:46:14 +00:00
Vector3 Geometry3D : : get_closest_point_to_segment ( const Vector3 & p_point , const Vector3 & p_a , const Vector3 & p_b ) {
2020-05-25 17:20:45 +00:00
Vector3 s [ 2 ] = { p_a , p_b } ;
2021-08-13 14:46:14 +00:00
return : : Geometry3D : : get_closest_point_to_segment ( p_point , s ) ;
2020-05-25 17:20:45 +00:00
}
2021-08-13 14:46:14 +00:00
Vector3 Geometry3D : : get_closest_point_to_segment_uncapped ( const Vector3 & p_point , const Vector3 & p_a , const Vector3 & p_b ) {
2020-05-25 17:20:45 +00:00
Vector3 s [ 2 ] = { p_a , p_b } ;
2021-08-13 14:46:14 +00:00
return : : Geometry3D : : get_closest_point_to_segment_uncapped ( p_point , s ) ;
2020-05-25 17:20:45 +00:00
}
2021-08-13 14:46:14 +00:00
Variant Geometry3D : : ray_intersects_triangle ( const Vector3 & p_from , const Vector3 & p_dir , const Vector3 & p_v0 , const Vector3 & p_v1 , const Vector3 & p_v2 ) {
2020-05-25 17:20:45 +00:00
Vector3 res ;
2021-08-13 14:46:14 +00:00
if ( : : Geometry3D : : ray_intersects_triangle ( p_from , p_dir , p_v0 , p_v1 , p_v2 , & res ) ) {
2020-05-25 17:20:45 +00:00
return res ;
} else {
return Variant ( ) ;
}
}
2021-08-13 14:46:14 +00:00
Variant Geometry3D : : segment_intersects_triangle ( const Vector3 & p_from , const Vector3 & p_to , const Vector3 & p_v0 , const Vector3 & p_v1 , const Vector3 & p_v2 ) {
2020-05-25 17:20:45 +00:00
Vector3 res ;
2021-08-13 14:46:14 +00:00
if ( : : Geometry3D : : segment_intersects_triangle ( p_from , p_to , p_v0 , p_v1 , p_v2 , & res ) ) {
2020-05-25 17:20:45 +00:00
return res ;
} else {
return Variant ( ) ;
}
}
2021-08-13 14:46:14 +00:00
Vector < Vector3 > Geometry3D : : segment_intersects_sphere ( const Vector3 & p_from , const Vector3 & p_to , const Vector3 & p_sphere_pos , real_t p_sphere_radius ) {
2020-05-25 17:20:45 +00:00
Vector < Vector3 > r ;
Vector3 res , norm ;
2021-08-13 14:46:14 +00:00
if ( ! : : Geometry3D : : segment_intersects_sphere ( p_from , p_to , p_sphere_pos , p_sphere_radius , & res , & norm ) ) {
2020-05-25 17:20:45 +00:00
return r ;
}
r . resize ( 2 ) ;
r . set ( 0 , res ) ;
r . set ( 1 , norm ) ;
return r ;
}
2021-08-13 14:46:14 +00:00
Vector < Vector3 > Geometry3D : : segment_intersects_cylinder ( const Vector3 & p_from , const Vector3 & p_to , float p_height , float p_radius ) {
2020-05-25 17:20:45 +00:00
Vector < Vector3 > r ;
Vector3 res , norm ;
2021-08-13 14:46:14 +00:00
if ( ! : : Geometry3D : : segment_intersects_cylinder ( p_from , p_to , p_height , p_radius , & res , & norm ) ) {
2020-05-25 17:20:45 +00:00
return r ;
}
r . resize ( 2 ) ;
r . set ( 0 , res ) ;
r . set ( 1 , norm ) ;
return r ;
}
2021-08-13 14:46:14 +00:00
Vector < Vector3 > Geometry3D : : segment_intersects_convex ( const Vector3 & p_from , const Vector3 & p_to , const Vector < Plane > & p_planes ) {
2020-05-25 17:20:45 +00:00
Vector < Vector3 > r ;
Vector3 res , norm ;
2021-08-13 14:46:14 +00:00
if ( ! : : Geometry3D : : segment_intersects_convex ( p_from , p_to , p_planes . ptr ( ) , p_planes . size ( ) , & res , & norm ) ) {
2020-05-25 17:20:45 +00:00
return r ;
}
r . resize ( 2 ) ;
r . set ( 0 , res ) ;
r . set ( 1 , norm ) ;
return r ;
}
2021-08-13 14:46:14 +00:00
Vector < Vector3 > Geometry3D : : clip_polygon ( const Vector < Vector3 > & p_points , const Plane & p_plane ) {
return : : Geometry3D : : clip_polygon ( p_points , p_plane ) ;
2020-05-25 17:20:45 +00:00
}
2021-08-13 14:46:14 +00:00
void Geometry3D : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " build_box_planes " , " extents " ) , & Geometry3D : : build_box_planes ) ;
ClassDB : : bind_method ( D_METHOD ( " build_cylinder_planes " , " radius " , " height " , " sides " , " axis " ) , & Geometry3D : : build_cylinder_planes , DEFVAL ( Vector3 : : AXIS_Z ) ) ;
ClassDB : : bind_method ( D_METHOD ( " build_capsule_planes " , " radius " , " height " , " sides " , " lats " , " axis " ) , & Geometry3D : : build_capsule_planes , DEFVAL ( Vector3 : : AXIS_Z ) ) ;
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_closest_points_between_segments " , " p1 " , " p2 " , " q1 " , " q2 " ) , & Geometry3D : : get_closest_points_between_segments ) ;
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_closest_point_to_segment " , " point " , " s1 " , " s2 " ) , & Geometry3D : : get_closest_point_to_segment ) ;
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_closest_point_to_segment_uncapped " , " point " , " s1 " , " s2 " ) , & Geometry3D : : get_closest_point_to_segment_uncapped ) ;
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " ray_intersects_triangle " , " from " , " dir " , " a " , " b " , " c " ) , & Geometry3D : : ray_intersects_triangle ) ;
ClassDB : : bind_method ( D_METHOD ( " segment_intersects_triangle " , " from " , " to " , " a " , " b " , " c " ) , & Geometry3D : : segment_intersects_triangle ) ;
ClassDB : : bind_method ( D_METHOD ( " segment_intersects_sphere " , " from " , " to " , " sphere_position " , " sphere_radius " ) , & Geometry3D : : segment_intersects_sphere ) ;
ClassDB : : bind_method ( D_METHOD ( " segment_intersects_cylinder " , " from " , " to " , " height " , " radius " ) , & Geometry3D : : segment_intersects_cylinder ) ;
ClassDB : : bind_method ( D_METHOD ( " segment_intersects_convex " , " from " , " to " , " planes " ) , & Geometry3D : : segment_intersects_convex ) ;
2020-05-25 17:20:45 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " clip_polygon " , " points " , " plane " ) , & Geometry3D : : clip_polygon ) ;
2020-05-25 17:20:45 +00:00
}
2021-08-13 14:46:14 +00:00
////// File //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Error File : : open_encrypted ( const String & p_path , ModeFlags p_mode_flags , const Vector < uint8_t > & p_key ) {
2017-03-05 15:44:50 +00:00
Error err = open ( p_path , p_mode_flags ) ;
2020-05-14 14:41:43 +00:00
if ( err ) {
2014-04-15 01:43:44 +00:00
return err ;
2020-05-14 14:41:43 +00:00
}
2014-04-15 01:43:44 +00:00
2022-03-23 09:08:58 +00:00
Ref < FileAccessEncrypted > fae ;
fae . instantiate ( ) ;
2017-03-05 15:44:50 +00:00
err = fae - > open_and_parse ( f , p_key , ( p_mode_flags = = WRITE ) ? FileAccessEncrypted : : MODE_WRITE_AES256 : FileAccessEncrypted : : MODE_READ ) ;
2014-04-15 01:43:44 +00:00
if ( err ) {
close ( ) ;
return err ;
}
2017-03-05 15:44:50 +00:00
f = fae ;
2014-04-15 01:43:44 +00:00
return OK ;
}
2021-08-13 14:46:14 +00:00
Error File : : open_encrypted_pass ( const String & p_path , ModeFlags p_mode_flags , const String & p_pass ) {
2017-03-05 15:44:50 +00:00
Error err = open ( p_path , p_mode_flags ) ;
2020-05-14 14:41:43 +00:00
if ( err ) {
2014-04-15 01:43:44 +00:00
return err ;
2020-05-14 14:41:43 +00:00
}
2014-04-15 01:43:44 +00:00
2022-03-23 09:08:58 +00:00
Ref < FileAccessEncrypted > fae ;
fae . instantiate ( ) ;
2017-03-05 15:44:50 +00:00
err = fae - > open_and_parse_password ( f , p_pass , ( p_mode_flags = = WRITE ) ? FileAccessEncrypted : : MODE_WRITE_AES256 : FileAccessEncrypted : : MODE_READ ) ;
2014-04-15 01:43:44 +00:00
if ( err ) {
close ( ) ;
return err ;
}
2017-03-05 15:44:50 +00:00
f = fae ;
2014-04-15 01:43:44 +00:00
return OK ;
}
2021-08-13 14:46:14 +00:00
Error File : : open_compressed ( const String & p_path , ModeFlags p_mode_flags , CompressionMode p_compress_mode ) {
2022-03-23 09:08:58 +00:00
Ref < FileAccessCompressed > fac ;
fac . instantiate ( ) ;
2017-06-19 16:28:00 +00:00
fac - > configure ( " GCPF " , ( Compression : : Mode ) p_compress_mode ) ;
2017-08-21 19:15:36 +00:00
Error err = fac - > _open ( p_path , p_mode_flags ) ;
2017-06-19 16:28:00 +00:00
if ( err ) {
return err ;
}
f = fac ;
return OK ;
}
2021-08-13 14:46:14 +00:00
Error File : : open ( const String & p_path , ModeFlags p_mode_flags ) {
2014-02-10 01:10:30 +00:00
Error err ;
2017-03-05 15:44:50 +00:00
f = FileAccess : : open ( p_path , p_mode_flags , & err ) ;
2022-03-23 09:08:58 +00:00
if ( f . is_valid ( ) ) {
2021-05-20 12:58:03 +00:00
f - > set_big_endian ( big_endian ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
return err ;
}
2021-08-13 14:46:14 +00:00
void File : : flush ( ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before flushing. " ) ;
2020-12-15 14:31:04 +00:00
f - > flush ( ) ;
}
2021-08-13 14:46:14 +00:00
void File : : close ( ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened. " ) ;
2022-04-12 07:12:40 +00:00
f . unref ( ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool File : : is_open ( ) const {
2020-04-01 23:20:12 +00:00
return f ! = nullptr ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
String File : : get_path ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , " " , " File must be opened before use, or is lacking read-write permission. " ) ;
2018-03-09 14:45:21 +00:00
return f - > get_path ( ) ;
}
2021-08-13 14:46:14 +00:00
String File : : get_path_absolute ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , " " , " File must be opened before use, or is lacking read-write permission. " ) ;
2018-03-09 14:45:21 +00:00
return f - > get_path_absolute ( ) ;
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
void File : : seek ( int64_t p_position ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2019-03-26 17:51:13 +00:00
ERR_FAIL_COND_MSG ( p_position < 0 , " Seek position must be a positive integer. " ) ;
2014-02-10 01:10:30 +00:00
f - > seek ( p_position ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
void File : : seek_end ( int64_t p_position ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > seek_end ( p_position ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
uint64_t File : : get_position ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2017-09-10 13:37:49 +00:00
return f - > get_position ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
uint64_t File : : get_length ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2021-05-25 06:58:49 +00:00
return f - > get_length ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
bool File : : eof_reached ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , false , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > eof_reached ( ) ;
}
2021-08-13 14:46:14 +00:00
uint8_t File : : get_8 ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_8 ( ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
uint16_t File : : get_16 ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_16 ( ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
uint32_t File : : get_32 ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_32 ( ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
uint64_t File : : get_64 ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_64 ( ) ;
}
2021-08-13 14:46:14 +00:00
float File : : get_float ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_float ( ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
double File : : get_double ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_double ( ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
real_t File : : get_real ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , 0 , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_real ( ) ;
}
2021-08-13 14:46:14 +00:00
Vector < uint8_t > File : : get_buffer ( int64_t p_length ) const {
2020-02-17 21:06:54 +00:00
Vector < uint8_t > data ;
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , data , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG ( p_length < 0 , data , " Length of buffer cannot be smaller than 0. " ) ;
2020-05-14 14:41:43 +00:00
if ( p_length = = 0 ) {
2014-02-10 01:10:30 +00:00
return data ;
2020-05-14 14:41:43 +00:00
}
2019-07-05 17:08:43 +00:00
2014-02-10 01:10:30 +00:00
Error err = data . resize ( p_length ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG ( err ! = OK , data , " Can't resize data to " + itos ( p_length ) + " elements. " ) ;
2019-07-05 17:08:43 +00:00
2020-02-17 21:06:54 +00:00
uint8_t * w = data . ptrw ( ) ;
2019-03-26 17:51:13 +00:00
int64_t len = f - > get_buffer ( & w [ 0 ] , p_length ) ;
2014-02-10 01:10:30 +00:00
2020-05-14 14:41:43 +00:00
if ( len < p_length ) {
2021-04-11 21:11:13 +00:00
data . resize ( len ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
return data ;
}
2022-07-31 16:46:53 +00:00
String File : : get_as_text ( bool p_skip_cr ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , String ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2016-06-20 21:39:37 +00:00
2019-03-26 17:51:13 +00:00
uint64_t original_pos = f - > get_position ( ) ;
2022-03-23 09:08:58 +00:00
const_cast < FileAccess * > ( * f ) - > seek ( 0 ) ;
2016-06-20 21:39:37 +00:00
2022-07-31 16:46:53 +00:00
String text = f - > get_as_utf8_string ( p_skip_cr ) ;
2014-02-10 01:10:30 +00:00
2022-03-23 09:08:58 +00:00
const_cast < FileAccess * > ( * f ) - > seek ( original_pos ) ;
2016-06-20 21:39:37 +00:00
2014-02-10 01:10:30 +00:00
return text ;
}
2016-02-25 18:25:29 +00:00
2021-08-13 14:46:14 +00:00
String File : : get_md5 ( const String & p_path ) const {
2016-02-25 18:25:29 +00:00
return FileAccess : : get_md5 ( p_path ) ;
}
2021-08-13 14:46:14 +00:00
String File : : get_sha256 ( const String & p_path ) const {
2016-06-17 07:55:16 +00:00
return FileAccess : : get_sha256 ( p_path ) ;
}
2021-08-13 14:46:14 +00:00
String File : : get_line ( ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , String ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
return f - > get_line ( ) ;
}
2021-08-13 14:46:14 +00:00
Vector < String > File : : get_csv_line ( const String & p_delim ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , Vector < String > ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2018-11-13 11:53:24 +00:00
return f - > get_csv_line ( p_delim ) ;
2014-02-10 01:10:30 +00:00
}
2021-03-12 13:35:16 +00:00
/**< use this for files WRITTEN in _big_ endian machines (i.e. amiga/mac)
2014-02-10 01:10:30 +00:00
* It ' s not about the current CPU type but file formats .
2021-03-12 13:35:16 +00:00
* These flags get reset to false ( little endian ) on each open
2014-02-10 01:10:30 +00:00
*/
2021-08-13 14:46:14 +00:00
void File : : set_big_endian ( bool p_big_endian ) {
2021-05-20 12:58:03 +00:00
big_endian = p_big_endian ;
2022-03-23 09:08:58 +00:00
if ( f . is_valid ( ) ) {
2021-05-20 12:58:03 +00:00
f - > set_big_endian ( p_big_endian ) ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool File : : is_big_endian ( ) {
2021-05-20 12:58:03 +00:00
return big_endian ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Error File : : get_error ( ) const {
2022-03-23 09:08:58 +00:00
if ( f . is_null ( ) ) {
2014-02-10 01:10:30 +00:00
return ERR_UNCONFIGURED ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
return f - > get_error ( ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_8 ( uint8_t p_dest ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_8 ( p_dest ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
void File : : store_16 ( uint16_t p_dest ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_16 ( p_dest ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
void File : : store_32 ( uint32_t p_dest ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_32 ( p_dest ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
void File : : store_64 ( uint64_t p_dest ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_64 ( p_dest ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_float ( float p_dest ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_float ( p_dest ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
void File : : store_double ( double p_dest ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_double ( p_dest ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
void File : : store_real ( real_t p_real ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_real ( p_real ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_string ( const String & p_string ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_string ( p_string ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_pascal_string ( const String & p_string ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-03-14 01:57:24 +00:00
f - > store_pascal_string ( p_string ) ;
2020-05-19 13:46:49 +00:00
}
2014-03-14 01:57:24 +00:00
2021-08-13 14:46:14 +00:00
String File : : get_pascal_string ( ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , " " , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-03-14 01:57:24 +00:00
return f - > get_pascal_string ( ) ;
2020-05-19 13:46:49 +00:00
}
2014-03-14 01:57:24 +00:00
2021-08-13 14:46:14 +00:00
void File : : store_line ( const String & p_string ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
f - > store_line ( p_string ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_csv_line ( const Vector < String > & p_values , const String & p_delim ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2018-11-13 11:53:24 +00:00
f - > store_csv_line ( p_values , p_delim ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_buffer ( const Vector < uint8_t > & p_buffer ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
2019-03-26 17:51:13 +00:00
uint64_t len = p_buffer . size ( ) ;
2020-05-14 14:41:43 +00:00
if ( len = = 0 ) {
2014-02-10 01:10:30 +00:00
return ;
2020-05-14 14:41:43 +00:00
}
2014-02-10 01:10:30 +00:00
2020-02-17 21:06:54 +00:00
const uint8_t * r = p_buffer . ptr ( ) ;
2014-02-10 01:10:30 +00:00
2017-03-05 15:44:50 +00:00
f - > store_buffer ( & r [ 0 ] , len ) ;
2014-02-10 01:10:30 +00:00
}
2022-03-19 12:18:52 +00:00
bool File : : file_exists ( const String & p_name ) {
2014-02-10 01:10:30 +00:00
return FileAccess : : exists ( p_name ) ;
}
2021-08-13 14:46:14 +00:00
void File : : store_var ( const Variant & p_var , bool p_full_objects ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_MSG ( f . is_null ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
int len ;
2020-04-01 23:20:12 +00:00
Error err = encode_variant ( p_var , nullptr , len , p_full_objects ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG ( err ! = OK , " Error when trying to encode Variant. " ) ;
2014-02-10 01:10:30 +00:00
2020-02-17 21:06:54 +00:00
Vector < uint8_t > buff ;
2014-02-10 01:10:30 +00:00
buff . resize ( len ) ;
2020-02-17 21:06:54 +00:00
uint8_t * w = buff . ptrw ( ) ;
2019-03-26 15:52:42 +00:00
err = encode_variant ( p_var , & w [ 0 ] , len , p_full_objects ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_MSG ( err ! = OK , " Error when trying to encode Variant. " ) ;
2014-02-10 01:10:30 +00:00
store_32 ( len ) ;
store_buffer ( buff ) ;
}
2021-08-13 14:46:14 +00:00
Variant File : : get_var ( bool p_allow_objects ) const {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( f . is_null ( ) , Variant ( ) , " File must be opened before use, or is lacking read-write permission. " ) ;
2014-02-10 01:10:30 +00:00
uint32_t len = get_32 ( ) ;
2020-02-17 21:06:54 +00:00
Vector < uint8_t > buff = get_buffer ( len ) ;
2017-08-31 21:30:35 +00:00
ERR_FAIL_COND_V ( ( uint32_t ) buff . size ( ) ! = len , Variant ( ) ) ;
2014-02-10 01:10:30 +00:00
2020-02-17 21:06:54 +00:00
const uint8_t * r = buff . ptr ( ) ;
2014-02-10 01:10:30 +00:00
Variant v ;
2020-04-01 23:20:12 +00:00
Error err = decode_variant ( v , & r [ 0 ] , len , nullptr , p_allow_objects ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG ( err ! = OK , Variant ( ) , " Error when trying to encode Variant. " ) ;
2014-02-10 01:10:30 +00:00
return v ;
}
2021-08-13 14:46:14 +00:00
uint64_t File : : get_modified_time ( const String & p_file ) const {
2017-01-23 21:33:02 +00:00
return FileAccess : : get_modified_time ( p_file ) ;
}
2021-08-13 14:46:14 +00:00
void File : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " open_encrypted " , " path " , " mode_flags " , " key " ) , & File : : open_encrypted ) ;
ClassDB : : bind_method ( D_METHOD ( " open_encrypted_with_pass " , " path " , " mode_flags " , " pass " ) , & File : : open_encrypted_pass ) ;
ClassDB : : bind_method ( D_METHOD ( " open_compressed " , " path " , " mode_flags " , " compression_mode " ) , & File : : open_compressed , DEFVAL ( 0 ) ) ;
ClassDB : : bind_method ( D_METHOD ( " open " , " path " , " flags " ) , & File : : open ) ;
ClassDB : : bind_method ( D_METHOD ( " flush " ) , & File : : flush ) ;
ClassDB : : bind_method ( D_METHOD ( " close " ) , & File : : close ) ;
ClassDB : : bind_method ( D_METHOD ( " get_path " ) , & File : : get_path ) ;
ClassDB : : bind_method ( D_METHOD ( " get_path_absolute " ) , & File : : get_path_absolute ) ;
ClassDB : : bind_method ( D_METHOD ( " is_open " ) , & File : : is_open ) ;
ClassDB : : bind_method ( D_METHOD ( " seek " , " position " ) , & File : : seek ) ;
ClassDB : : bind_method ( D_METHOD ( " seek_end " , " position " ) , & File : : seek_end , DEFVAL ( 0 ) ) ;
ClassDB : : bind_method ( D_METHOD ( " get_position " ) , & File : : get_position ) ;
ClassDB : : bind_method ( D_METHOD ( " get_length " ) , & File : : get_length ) ;
ClassDB : : bind_method ( D_METHOD ( " eof_reached " ) , & File : : eof_reached ) ;
ClassDB : : bind_method ( D_METHOD ( " get_8 " ) , & File : : get_8 ) ;
ClassDB : : bind_method ( D_METHOD ( " get_16 " ) , & File : : get_16 ) ;
ClassDB : : bind_method ( D_METHOD ( " get_32 " ) , & File : : get_32 ) ;
ClassDB : : bind_method ( D_METHOD ( " get_64 " ) , & File : : get_64 ) ;
ClassDB : : bind_method ( D_METHOD ( " get_float " ) , & File : : get_float ) ;
ClassDB : : bind_method ( D_METHOD ( " get_double " ) , & File : : get_double ) ;
ClassDB : : bind_method ( D_METHOD ( " get_real " ) , & File : : get_real ) ;
ClassDB : : bind_method ( D_METHOD ( " get_buffer " , " length " ) , & File : : get_buffer ) ;
ClassDB : : bind_method ( D_METHOD ( " get_line " ) , & File : : get_line ) ;
ClassDB : : bind_method ( D_METHOD ( " get_csv_line " , " delim " ) , & File : : get_csv_line , DEFVAL ( " , " ) ) ;
2022-07-31 16:46:53 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_as_text " , " skip_cr " ) , & File : : get_as_text , DEFVAL ( false ) ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_md5 " , " path " ) , & File : : get_md5 ) ;
ClassDB : : bind_method ( D_METHOD ( " get_sha256 " , " path " ) , & File : : get_sha256 ) ;
ClassDB : : bind_method ( D_METHOD ( " is_big_endian " ) , & File : : is_big_endian ) ;
ClassDB : : bind_method ( D_METHOD ( " set_big_endian " , " big_endian " ) , & File : : set_big_endian ) ;
ClassDB : : bind_method ( D_METHOD ( " get_error " ) , & File : : get_error ) ;
ClassDB : : bind_method ( D_METHOD ( " get_var " , " allow_objects " ) , & File : : get_var , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " store_8 " , " value " ) , & File : : store_8 ) ;
ClassDB : : bind_method ( D_METHOD ( " store_16 " , " value " ) , & File : : store_16 ) ;
ClassDB : : bind_method ( D_METHOD ( " store_32 " , " value " ) , & File : : store_32 ) ;
ClassDB : : bind_method ( D_METHOD ( " store_64 " , " value " ) , & File : : store_64 ) ;
ClassDB : : bind_method ( D_METHOD ( " store_float " , " value " ) , & File : : store_float ) ;
ClassDB : : bind_method ( D_METHOD ( " store_double " , " value " ) , & File : : store_double ) ;
ClassDB : : bind_method ( D_METHOD ( " store_real " , " value " ) , & File : : store_real ) ;
ClassDB : : bind_method ( D_METHOD ( " store_buffer " , " buffer " ) , & File : : store_buffer ) ;
ClassDB : : bind_method ( D_METHOD ( " store_line " , " line " ) , & File : : store_line ) ;
ClassDB : : bind_method ( D_METHOD ( " store_csv_line " , " values " , " delim " ) , & File : : store_csv_line , DEFVAL ( " , " ) ) ;
ClassDB : : bind_method ( D_METHOD ( " store_string " , " string " ) , & File : : store_string ) ;
ClassDB : : bind_method ( D_METHOD ( " store_var " , " value " , " full_objects " ) , & File : : store_var , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " store_pascal_string " , " string " ) , & File : : store_pascal_string ) ;
ClassDB : : bind_method ( D_METHOD ( " get_pascal_string " ) , & File : : get_pascal_string ) ;
2022-03-19 12:18:52 +00:00
ClassDB : : bind_static_method ( " File " , D_METHOD ( " file_exists " , " path " ) , & File : : file_exists ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_modified_time " , " file " ) , & File : : get_modified_time ) ;
2017-03-05 15:44:50 +00:00
2021-05-20 12:58:03 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " big_endian " ) , " set_big_endian " , " is_big_endian " ) ;
2018-01-11 22:35:12 +00:00
2017-08-20 15:45:01 +00:00
BIND_ENUM_CONSTANT ( READ ) ;
BIND_ENUM_CONSTANT ( WRITE ) ;
BIND_ENUM_CONSTANT ( READ_WRITE ) ;
BIND_ENUM_CONSTANT ( WRITE_READ ) ;
2017-06-19 16:28:00 +00:00
2017-08-20 15:45:01 +00:00
BIND_ENUM_CONSTANT ( COMPRESSION_FASTLZ ) ;
BIND_ENUM_CONSTANT ( COMPRESSION_DEFLATE ) ;
BIND_ENUM_CONSTANT ( COMPRESSION_ZSTD ) ;
BIND_ENUM_CONSTANT ( COMPRESSION_GZIP ) ;
2017-03-05 15:44:50 +00:00
}
2021-08-13 14:46:14 +00:00
////// Directory //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Error Directory : : open ( const String & p_path ) {
2014-02-10 01:10:30 +00:00
Error err ;
2022-03-23 09:08:58 +00:00
Ref < DirAccess > alt = DirAccess : : open ( p_path , & err ) ;
if ( alt . is_null ( ) ) {
2014-02-10 01:10:30 +00:00
return err ;
2020-05-14 14:41:43 +00:00
}
2017-03-05 15:44:50 +00:00
d = alt ;
2020-07-06 06:17:16 +00:00
dir_open = true ;
2014-02-10 01:10:30 +00:00
return OK ;
}
2021-08-13 14:46:14 +00:00
bool Directory : : is_open ( ) const {
2022-03-23 09:08:58 +00:00
return d . is_valid ( ) & & dir_open ;
2020-07-06 06:17:16 +00:00
}
2020-07-20 17:20:40 +00:00
Error Directory : : list_dir_begin ( ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , ERR_UNCONFIGURED , " Directory must be opened before use. " ) ;
2014-02-10 01:10:30 +00:00
return d - > list_dir_begin ( ) ;
}
2021-08-13 14:46:14 +00:00
String Directory : : get_next ( ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , " " , " Directory must be opened before use. " ) ;
2017-01-16 22:19:43 +00:00
String next = d - > get_next ( ) ;
2020-07-20 17:20:40 +00:00
while ( ! next . is_empty ( ) & & ( ( ! include_navigational & & ( next = = " . " | | next = = " .. " ) ) | | ( ! include_hidden & & d - > current_is_hidden ( ) ) ) ) {
2017-01-16 22:19:43 +00:00
next = d - > get_next ( ) ;
}
return next ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool Directory : : current_is_dir ( ) const {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , false , " Directory must be opened before use. " ) ;
2014-02-10 01:10:30 +00:00
return d - > current_is_dir ( ) ;
}
2021-08-13 14:46:14 +00:00
void Directory : : list_dir_end ( ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_MSG ( ! is_open ( ) , " Directory must be opened before use. " ) ;
2019-07-01 10:59:42 +00:00
d - > list_dir_end ( ) ;
2014-02-10 01:10:30 +00:00
}
2020-07-20 17:20:40 +00:00
PackedStringArray Directory : : get_files ( ) {
return _get_contents ( false ) ;
}
PackedStringArray Directory : : get_directories ( ) {
return _get_contents ( true ) ;
}
PackedStringArray Directory : : _get_contents ( bool p_directories ) {
PackedStringArray ret ;
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , ret , " Directory must be opened before use. " ) ;
list_dir_begin ( ) ;
String s = get_next ( ) ;
while ( ! s . is_empty ( ) ) {
if ( current_is_dir ( ) = = p_directories ) {
ret . append ( s ) ;
}
s = get_next ( ) ;
}
ret . sort ( ) ;
return ret ;
}
void Directory : : set_include_navigational ( bool p_enable ) {
include_navigational = p_enable ;
}
bool Directory : : get_include_navigational ( ) const {
return include_navigational ;
}
void Directory : : set_include_hidden ( bool p_enable ) {
include_hidden = p_enable ;
}
bool Directory : : get_include_hidden ( ) const {
return include_hidden ;
}
2021-08-13 14:46:14 +00:00
int Directory : : get_drive_count ( ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , 0 , " Directory must be opened before use. " ) ;
2014-02-10 01:10:30 +00:00
return d - > get_drive_count ( ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
String Directory : : get_drive ( int p_drive ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , " " , " Directory must be opened before use. " ) ;
2014-02-10 01:10:30 +00:00
return d - > get_drive ( p_drive ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
int Directory : : get_current_drive ( ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , 0 , " Directory must be opened before use. " ) ;
2017-01-14 16:01:43 +00:00
return d - > get_current_drive ( ) ;
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Error Directory : : change_dir ( String p_dir ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( d . is_null ( ) , ERR_UNCONFIGURED , " Directory is not configured properly. " ) ;
2020-07-09 19:23:59 +00:00
Error err = d - > change_dir ( p_dir ) ;
if ( err ! = OK ) {
return err ;
}
dir_open = true ;
return OK ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
String Directory : : get_current_dir ( ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , " " , " Directory must be opened before use. " ) ;
2020-03-17 13:32:03 +00:00
return d - > get_current_dir ( ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Error Directory : : make_dir ( String p_dir ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( d . is_null ( ) , ERR_UNCONFIGURED , " Directory is not configured properly. " ) ;
2021-08-29 23:43:47 +00:00
if ( ! p_dir . is_relative_path ( ) ) {
2022-03-23 09:08:58 +00:00
Ref < DirAccess > da = DirAccess : : create_for_path ( p_dir ) ;
2022-03-10 14:27:09 +00:00
return da - > make_dir ( p_dir ) ;
2016-06-18 15:11:48 +00:00
}
2014-02-10 01:10:30 +00:00
return d - > make_dir ( p_dir ) ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Error Directory : : make_dir_recursive ( String p_dir ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( d . is_null ( ) , ERR_UNCONFIGURED , " Directory is not configured properly. " ) ;
2021-08-29 23:43:47 +00:00
if ( ! p_dir . is_relative_path ( ) ) {
2022-03-23 09:08:58 +00:00
Ref < DirAccess > da = DirAccess : : create_for_path ( p_dir ) ;
2022-03-10 14:27:09 +00:00
return da - > make_dir_recursive ( p_dir ) ;
2016-08-08 21:20:16 +00:00
}
2014-02-10 01:10:30 +00:00
return d - > make_dir_recursive ( p_dir ) ;
}
2021-08-13 14:46:14 +00:00
bool Directory : : file_exists ( String p_file ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( d . is_null ( ) , false , " Directory is not configured properly. " ) ;
2021-08-29 23:43:47 +00:00
if ( ! p_file . is_relative_path ( ) ) {
2016-06-18 15:11:48 +00:00
return FileAccess : : exists ( p_file ) ;
}
2014-02-10 01:10:30 +00:00
return d - > file_exists ( p_file ) ;
}
2021-08-13 14:46:14 +00:00
bool Directory : : dir_exists ( String p_dir ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( d . is_null ( ) , false , " Directory is not configured properly. " ) ;
2021-08-29 23:43:47 +00:00
if ( ! p_dir . is_relative_path ( ) ) {
2022-03-10 14:27:09 +00:00
return DirAccess : : exists ( p_dir ) ;
2016-06-18 15:11:48 +00:00
}
2020-07-09 19:23:59 +00:00
return d - > dir_exists ( p_dir ) ;
2014-05-25 03:34:51 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
uint64_t Directory : : get_space_left ( ) {
2022-03-23 09:08:58 +00:00
ERR_FAIL_COND_V_MSG ( d . is_null ( ) , 0 , " Directory must be opened before use. " ) ;
2019-03-26 17:51:13 +00:00
return d - > get_space_left ( ) / 1024 * 1024 ; // Truncate to closest MiB.
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Error Directory : : copy ( String p_from , String p_to ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , ERR_UNCONFIGURED , " Directory must be opened before use. " ) ;
2017-03-05 15:44:50 +00:00
return d - > copy ( p_from , p_to ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Error Directory : : rename ( String p_from , String p_to ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , ERR_UNCONFIGURED , " Directory must be opened before use. " ) ;
2021-08-17 12:15:51 +00:00
ERR_FAIL_COND_V_MSG ( p_from . is_empty ( ) | | p_from = = " . " | | p_from = = " .. " , ERR_INVALID_PARAMETER , " Invalid path to rename. " ) ;
2021-08-29 23:43:47 +00:00
if ( ! p_from . is_relative_path ( ) ) {
2022-03-23 09:08:58 +00:00
Ref < DirAccess > da = DirAccess : : create_for_path ( p_from ) ;
2022-03-10 14:27:09 +00:00
ERR_FAIL_COND_V_MSG ( ! da - > file_exists ( p_from ) & & ! da - > dir_exists ( p_from ) , ERR_DOES_NOT_EXIST , " File or directory does not exist. " ) ;
return da - > rename ( p_from , p_to ) ;
2016-06-18 15:11:48 +00:00
}
2021-08-17 12:15:51 +00:00
ERR_FAIL_COND_V_MSG ( ! d - > file_exists ( p_from ) & & ! d - > dir_exists ( p_from ) , ERR_DOES_NOT_EXIST , " File or directory does not exist. " ) ;
2017-03-05 15:44:50 +00:00
return d - > rename ( p_from , p_to ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Error Directory : : remove ( String p_name ) {
2020-07-06 06:17:16 +00:00
ERR_FAIL_COND_V_MSG ( ! is_open ( ) , ERR_UNCONFIGURED , " Directory must be opened before use. " ) ;
2021-08-29 23:43:47 +00:00
if ( ! p_name . is_relative_path ( ) ) {
2022-03-23 09:08:58 +00:00
Ref < DirAccess > da = DirAccess : : create_for_path ( p_name ) ;
2022-03-10 14:27:09 +00:00
return da - > remove ( p_name ) ;
2016-06-18 15:11:48 +00:00
}
2014-02-10 01:10:30 +00:00
return d - > remove ( p_name ) ;
}
2021-08-13 14:46:14 +00:00
void Directory : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " open " , " path " ) , & Directory : : open ) ;
2020-07-20 17:20:40 +00:00
ClassDB : : bind_method ( D_METHOD ( " list_dir_begin " ) , & Directory : : list_dir_begin , DEFVAL ( false ) , DEFVAL ( false ) ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_next " ) , & Directory : : get_next ) ;
ClassDB : : bind_method ( D_METHOD ( " current_is_dir " ) , & Directory : : current_is_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " list_dir_end " ) , & Directory : : list_dir_end ) ;
2020-07-20 17:20:40 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_files " ) , & Directory : : get_files ) ;
ClassDB : : bind_method ( D_METHOD ( " get_directories " ) , & Directory : : get_directories ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_drive_count " ) , & Directory : : get_drive_count ) ;
ClassDB : : bind_method ( D_METHOD ( " get_drive " , " idx " ) , & Directory : : get_drive ) ;
ClassDB : : bind_method ( D_METHOD ( " get_current_drive " ) , & Directory : : get_current_drive ) ;
ClassDB : : bind_method ( D_METHOD ( " change_dir " , " todir " ) , & Directory : : change_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " get_current_dir " ) , & Directory : : get_current_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " make_dir " , " path " ) , & Directory : : make_dir ) ;
ClassDB : : bind_method ( D_METHOD ( " make_dir_recursive " , " path " ) , & Directory : : make_dir_recursive ) ;
ClassDB : : bind_method ( D_METHOD ( " file_exists " , " path " ) , & Directory : : file_exists ) ;
ClassDB : : bind_method ( D_METHOD ( " dir_exists " , " path " ) , & Directory : : dir_exists ) ;
ClassDB : : bind_method ( D_METHOD ( " get_space_left " ) , & Directory : : get_space_left ) ;
ClassDB : : bind_method ( D_METHOD ( " copy " , " from " , " to " ) , & Directory : : copy ) ;
ClassDB : : bind_method ( D_METHOD ( " rename " , " from " , " to " ) , & Directory : : rename ) ;
ClassDB : : bind_method ( D_METHOD ( " remove " , " path " ) , & Directory : : remove ) ;
2020-07-20 17:20:40 +00:00
2022-01-07 12:58:28 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_include_navigational " , " enable " ) , & Directory : : set_include_navigational ) ;
2020-07-20 17:20:40 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_include_navigational " ) , & Directory : : get_include_navigational ) ;
2022-01-07 12:58:28 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_include_hidden " , " enable " ) , & Directory : : set_include_hidden ) ;
2020-07-20 17:20:40 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_include_hidden " ) , & Directory : : get_include_hidden ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " include_navigational " ) , " set_include_navigational " , " get_include_navigational " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " include_hidden " ) , " set_include_hidden " , " get_include_hidden " ) ;
2021-08-13 14:46:14 +00:00
}
Directory : : Directory ( ) {
2014-02-10 01:10:30 +00:00
d = DirAccess : : create ( DirAccess : : ACCESS_RESOURCES ) ;
}
2021-08-13 14:46:14 +00:00
////// Marshalls //////
2020-05-12 15:01:17 +00:00
2021-08-13 14:46:14 +00:00
Marshalls * Marshalls : : singleton = nullptr ;
2016-11-05 16:13:04 +00:00
2021-08-13 14:46:14 +00:00
Marshalls * Marshalls : : get_singleton ( ) {
2016-11-05 16:13:04 +00:00
return singleton ;
}
2021-08-13 14:46:14 +00:00
String Marshalls : : variant_to_base64 ( const Variant & p_var , bool p_full_objects ) {
2014-02-10 01:10:30 +00:00
int len ;
2020-04-01 23:20:12 +00:00
Error err = encode_variant ( p_var , nullptr , len , p_full_objects ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG ( err ! = OK , " " , " Error when trying to encode Variant. " ) ;
2014-02-10 01:10:30 +00:00
2020-02-17 21:06:54 +00:00
Vector < uint8_t > buff ;
2014-02-10 01:10:30 +00:00
buff . resize ( len ) ;
2020-02-17 21:06:54 +00:00
uint8_t * w = buff . ptrw ( ) ;
2014-02-10 01:10:30 +00:00
2019-03-26 15:52:42 +00:00
err = encode_variant ( p_var , & w [ 0 ] , len , p_full_objects ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG ( err ! = OK , " " , " Error when trying to encode Variant. " ) ;
2014-02-10 01:10:30 +00:00
2019-07-02 15:47:34 +00:00
String ret = CryptoCore : : b64_encode_str ( & w [ 0 ] , len ) ;
2021-12-09 09:42:46 +00:00
ERR_FAIL_COND_V ( ret . is_empty ( ) , ret ) ;
2014-02-10 01:10:30 +00:00
return ret ;
2020-05-19 13:46:49 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Variant Marshalls : : base64_to_variant ( const String & p_str , bool p_allow_objects ) {
2014-02-10 01:10:30 +00:00
int strlen = p_str . length ( ) ;
CharString cstr = p_str . ascii ( ) ;
2020-02-17 21:06:54 +00:00
Vector < uint8_t > buf ;
2014-06-11 13:41:03 +00:00
buf . resize ( strlen / 4 * 3 + 1 ) ;
2020-02-17 21:06:54 +00:00
uint8_t * w = buf . ptrw ( ) ;
2014-02-10 01:10:30 +00:00
2019-07-02 01:06:52 +00:00
size_t len = 0 ;
ERR_FAIL_COND_V ( CryptoCore : : b64_decode ( & w [ 0 ] , buf . size ( ) , & len , ( unsigned char * ) cstr . get_data ( ) , strlen ) ! = OK , Variant ( ) ) ;
2014-02-10 01:10:30 +00:00
Variant v ;
2020-04-01 23:20:12 +00:00
Error err = decode_variant ( v , & w [ 0 ] , len , nullptr , p_allow_objects ) ;
2019-09-25 08:28:50 +00:00
ERR_FAIL_COND_V_MSG ( err ! = OK , Variant ( ) , " Error when trying to decode Variant. " ) ;
2014-02-10 01:10:30 +00:00
return v ;
2020-05-19 13:46:49 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
String Marshalls : : raw_to_base64 ( const Vector < uint8_t > & p_arr ) {
2020-02-17 21:06:54 +00:00
String ret = CryptoCore : : b64_encode_str ( p_arr . ptr ( ) , p_arr . size ( ) ) ;
2021-12-09 09:42:46 +00:00
ERR_FAIL_COND_V ( ret . is_empty ( ) , ret ) ;
2015-07-28 10:50:52 +00:00
return ret ;
2020-05-19 13:46:49 +00:00
}
2015-07-28 10:50:52 +00:00
2021-08-13 14:46:14 +00:00
Vector < uint8_t > Marshalls : : base64_to_raw ( const String & p_str ) {
2015-07-28 10:50:52 +00:00
int strlen = p_str . length ( ) ;
CharString cstr = p_str . ascii ( ) ;
2019-07-02 01:06:52 +00:00
size_t arr_len = 0 ;
2020-02-17 21:06:54 +00:00
Vector < uint8_t > buf ;
2015-07-28 10:50:52 +00:00
{
buf . resize ( strlen / 4 * 3 + 1 ) ;
2020-02-17 21:06:54 +00:00
uint8_t * w = buf . ptrw ( ) ;
2015-07-28 10:50:52 +00:00
2020-02-17 21:06:54 +00:00
ERR_FAIL_COND_V ( CryptoCore : : b64_decode ( & w [ 0 ] , buf . size ( ) , & arr_len , ( unsigned char * ) cstr . get_data ( ) , strlen ) ! = OK , Vector < uint8_t > ( ) ) ;
2019-07-02 01:06:52 +00:00
}
2015-07-28 10:50:52 +00:00
buf . resize ( arr_len ) ;
return buf ;
2020-05-19 13:46:49 +00:00
}
2015-07-28 10:50:52 +00:00
2021-08-13 14:46:14 +00:00
String Marshalls : : utf8_to_base64 ( const String & p_str ) {
2015-07-28 10:50:52 +00:00
CharString cstr = p_str . utf8 ( ) ;
2019-07-02 15:47:34 +00:00
String ret = CryptoCore : : b64_encode_str ( ( unsigned char * ) cstr . get_data ( ) , cstr . length ( ) ) ;
2021-12-09 09:42:46 +00:00
ERR_FAIL_COND_V ( ret . is_empty ( ) , ret ) ;
2015-07-28 10:50:52 +00:00
return ret ;
2020-05-19 13:46:49 +00:00
}
2015-07-28 10:50:52 +00:00
2021-08-13 14:46:14 +00:00
String Marshalls : : base64_to_utf8 ( const String & p_str ) {
2015-07-28 10:50:52 +00:00
int strlen = p_str . length ( ) ;
CharString cstr = p_str . ascii ( ) ;
2020-02-17 21:06:54 +00:00
Vector < uint8_t > buf ;
2015-07-28 10:50:52 +00:00
buf . resize ( strlen / 4 * 3 + 1 + 1 ) ;
2020-02-17 21:06:54 +00:00
uint8_t * w = buf . ptrw ( ) ;
2015-07-28 10:50:52 +00:00
2019-07-02 01:06:52 +00:00
size_t len = 0 ;
ERR_FAIL_COND_V ( CryptoCore : : b64_decode ( & w [ 0 ] , buf . size ( ) , & len , ( unsigned char * ) cstr . get_data ( ) , strlen ) ! = OK , String ( ) ) ;
2015-07-28 10:50:52 +00:00
w [ len ] = 0 ;
2017-03-05 15:44:50 +00:00
String ret = String : : utf8 ( ( char * ) & w [ 0 ] ) ;
2015-07-28 10:50:52 +00:00
return ret ;
2020-05-19 13:46:49 +00:00
}
2015-07-28 10:50:52 +00:00
2021-08-13 14:46:14 +00:00
void Marshalls : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " variant_to_base64 " , " variant " , " full_objects " ) , & Marshalls : : variant_to_base64 , DEFVAL ( false ) ) ;
ClassDB : : bind_method ( D_METHOD ( " base64_to_variant " , " base64_str " , " allow_objects " ) , & Marshalls : : base64_to_variant , DEFVAL ( false ) ) ;
2015-07-28 10:50:52 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " raw_to_base64 " , " array " ) , & Marshalls : : raw_to_base64 ) ;
ClassDB : : bind_method ( D_METHOD ( " base64_to_raw " , " base64_str " ) , & Marshalls : : base64_to_raw ) ;
2015-07-28 10:50:52 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " utf8_to_base64 " , " utf8_str " ) , & Marshalls : : utf8_to_base64 ) ;
ClassDB : : bind_method ( D_METHOD ( " base64_to_utf8 " , " base64_str " ) , & Marshalls : : base64_to_utf8 ) ;
2020-05-19 13:46:49 +00:00
}
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
////// Semaphore //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
void Semaphore : : wait ( ) {
2020-03-03 08:26:42 +00:00
semaphore . wait ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Error Semaphore : : try_wait ( ) {
2020-03-03 08:26:42 +00:00
return semaphore . try_wait ( ) ? OK : ERR_BUSY ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void Semaphore : : post ( ) {
2020-03-03 08:26:42 +00:00
semaphore . post ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void Semaphore : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " wait " ) , & Semaphore : : wait ) ;
ClassDB : : bind_method ( D_METHOD ( " try_wait " ) , & Semaphore : : try_wait ) ;
ClassDB : : bind_method ( D_METHOD ( " post " ) , & Semaphore : : post ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
////// Mutex //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
void Mutex : : lock ( ) {
2020-02-26 10:28:13 +00:00
mutex . lock ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
Error Mutex : : try_lock ( ) {
2020-02-26 10:28:13 +00:00
return mutex . try_lock ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void Mutex : : unlock ( ) {
2020-02-26 10:28:13 +00:00
mutex . unlock ( ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
void Mutex : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " lock " ) , & Mutex : : lock ) ;
ClassDB : : bind_method ( D_METHOD ( " try_lock " ) , & Mutex : : try_lock ) ;
ClassDB : : bind_method ( D_METHOD ( " unlock " ) , & Mutex : : unlock ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
////// Thread //////
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
void Thread : : _start_func ( void * ud ) {
Ref < Thread > * tud = ( Ref < Thread > * ) ud ;
Ref < Thread > t = * tud ;
2015-05-18 15:45:53 +00:00
memdelete ( tud ) ;
2021-09-25 16:02:51 +00:00
Object * target_instance = t - > target_callable . get_object ( ) ;
if ( ! target_instance ) {
2021-10-06 04:28:24 +00:00
t - > running . clear ( ) ;
2021-09-25 16:02:51 +00:00
ERR_FAIL_MSG ( vformat ( " Could not call function '%s' on previously freed instance to start thread %s. " , t - > target_callable . get_method ( ) , t - > get_id ( ) ) ) ;
}
2022-07-01 10:48:58 +00:00
String func_name = t - > target_callable . is_custom ( ) ? t - > target_callable . get_custom ( ) - > get_as_text ( ) : String ( t - > target_callable . get_method ( ) ) ;
: : Thread : : set_name ( func_name ) ;
2015-12-18 06:06:51 +00:00
2022-06-23 00:15:38 +00:00
Callable : : CallError ce ;
2022-07-28 20:56:41 +00:00
t - > target_callable . callp ( nullptr , 0 , t - > ret , ce ) ;
2020-02-19 19:27:19 +00:00
if ( ce . error ! = Callable : : CallError : : CALL_OK ) {
2021-10-06 04:28:24 +00:00
t - > running . clear ( ) ;
2022-07-01 10:48:58 +00:00
ERR_FAIL_MSG ( " Could not call function ' " + func_name + " ' to start thread " + t - > get_id ( ) + " : " + Variant : : get_callable_error_text ( t - > target_callable , nullptr , 0 , ce ) + " . " ) ;
2014-02-10 01:10:30 +00:00
}
2021-10-06 04:28:24 +00:00
t - > running . clear ( ) ;
2014-02-10 01:10:30 +00:00
}
2022-06-23 00:15:38 +00:00
Error Thread : : start ( const Callable & p_callable , Priority p_priority ) {
2021-10-06 04:28:24 +00:00
ERR_FAIL_COND_V_MSG ( is_started ( ) , ERR_ALREADY_IN_USE , " Thread already started. " ) ;
2022-01-04 13:44:47 +00:00
ERR_FAIL_COND_V ( ! p_callable . is_valid ( ) , ERR_INVALID_PARAMETER ) ;
2019-04-07 16:52:39 +00:00
ERR_FAIL_INDEX_V ( p_priority , PRIORITY_MAX , ERR_INVALID_PARAMETER ) ;
2014-02-10 01:10:30 +00:00
2017-03-05 15:44:50 +00:00
ret = Variant ( ) ;
2021-09-25 13:07:13 +00:00
target_callable = p_callable ;
2021-10-06 04:28:24 +00:00
running . set ( ) ;
2014-02-10 01:10:30 +00:00
2021-08-13 14:46:14 +00:00
Ref < Thread > * ud = memnew ( Ref < Thread > ( this ) ) ;
2015-05-18 15:45:53 +00:00
2021-08-13 14:46:14 +00:00
: : Thread : : Settings s ;
s . priority = ( : : Thread : : Priority ) p_priority ;
2021-01-19 12:29:41 +00:00
thread . start ( _start_func , ud , s ) ;
2014-02-10 01:10:30 +00:00
return OK ;
}
2021-08-13 14:46:14 +00:00
String Thread : : get_id ( ) const {
2021-01-19 12:29:41 +00:00
return itos ( thread . get_id ( ) ) ;
2014-02-10 01:10:30 +00:00
}
2021-10-06 04:28:24 +00:00
bool Thread : : is_started ( ) const {
return thread . is_started ( ) ;
}
bool Thread : : is_alive ( ) const {
return running . is_set ( ) ;
2014-02-10 01:10:30 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Variant Thread : : wait_to_finish ( ) {
2021-10-06 04:28:24 +00:00
ERR_FAIL_COND_V_MSG ( ! is_started ( ) , Variant ( ) , " Thread must have been started to wait for its completion. " ) ;
2021-01-19 12:29:41 +00:00
thread . wait_to_finish ( ) ;
2014-02-10 01:10:30 +00:00
Variant r = ret ;
2021-09-25 13:07:13 +00:00
target_callable = Callable ( ) ;
2014-02-10 01:10:30 +00:00
return r ;
}
2021-08-13 14:46:14 +00:00
void Thread : : _bind_methods ( ) {
2022-06-23 00:15:38 +00:00
ClassDB : : bind_method ( D_METHOD ( " start " , " callable " , " priority " ) , & Thread : : start , DEFVAL ( PRIORITY_NORMAL ) ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_id " ) , & Thread : : get_id ) ;
2021-10-06 04:28:24 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_started " ) , & Thread : : is_started ) ;
ClassDB : : bind_method ( D_METHOD ( " is_alive " ) , & Thread : : is_alive ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " wait_to_finish " ) , & Thread : : wait_to_finish ) ;
2014-02-10 01:10:30 +00:00
2017-08-20 15:45:01 +00:00
BIND_ENUM_CONSTANT ( PRIORITY_LOW ) ;
BIND_ENUM_CONSTANT ( PRIORITY_NORMAL ) ;
BIND_ENUM_CONSTANT ( PRIORITY_HIGH ) ;
2014-02-10 01:10:30 +00:00
}
2021-08-13 14:46:14 +00:00
namespace special {
////// ClassDB //////
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
PackedStringArray ClassDB : : get_class_list ( ) const {
2017-01-03 02:03:46 +00:00
List < StringName > classes ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_class_list ( & classes ) ;
2017-01-03 02:03:46 +00:00
2020-02-17 21:06:54 +00:00
PackedStringArray ret ;
2017-01-03 02:03:46 +00:00
ret . resize ( classes . size ( ) ) ;
2017-03-05 15:44:50 +00:00
int idx = 0 ;
2021-07-24 13:46:25 +00:00
for ( const StringName & E : classes ) {
2021-07-16 03:45:57 +00:00
ret . set ( idx + + , E ) ;
2017-01-03 02:03:46 +00:00
}
return ret ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
PackedStringArray ClassDB : : get_inheriters_from_class ( const StringName & p_class ) const {
2017-01-03 02:03:46 +00:00
List < StringName > classes ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_inheriters_from_class ( p_class , & classes ) ;
2017-01-03 02:03:46 +00:00
2020-02-17 21:06:54 +00:00
PackedStringArray ret ;
2017-01-03 02:03:46 +00:00
ret . resize ( classes . size ( ) ) ;
2017-03-05 15:44:50 +00:00
int idx = 0 ;
2021-07-24 13:46:25 +00:00
for ( const StringName & E : classes ) {
2021-07-16 03:45:57 +00:00
ret . set ( idx + + , E ) ;
2017-01-03 02:03:46 +00:00
}
return ret ;
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
StringName ClassDB : : get_parent_class ( const StringName & p_class ) const {
return : : ClassDB : : get_parent_class ( p_class ) ;
2017-01-03 02:03:46 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool ClassDB : : class_exists ( const StringName & p_class ) const {
return : : ClassDB : : class_exists ( p_class ) ;
2017-01-03 02:03:46 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool ClassDB : : is_parent_class ( const StringName & p_class , const StringName & p_inherits ) const {
return : : ClassDB : : is_parent_class ( p_class , p_inherits ) ;
2017-01-03 02:03:46 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
bool ClassDB : : can_instantiate ( const StringName & p_class ) const {
return : : ClassDB : : can_instantiate ( p_class ) ;
2017-01-03 02:03:46 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Variant ClassDB : : instantiate ( const StringName & p_class ) const {
Object * obj = : : ClassDB : : instantiate ( p_class ) ;
2020-05-14 14:41:43 +00:00
if ( ! obj ) {
2017-01-03 02:03:46 +00:00
return Variant ( ) ;
2020-05-14 14:41:43 +00:00
}
2017-01-03 02:03:46 +00:00
2021-06-04 16:03:15 +00:00
RefCounted * r = Object : : cast_to < RefCounted > ( obj ) ;
2017-01-03 02:03:46 +00:00
if ( r ) {
2022-05-02 23:43:50 +00:00
return Ref < RefCounted > ( r ) ;
2017-01-03 02:03:46 +00:00
} else {
return obj ;
}
}
2021-08-13 14:46:14 +00:00
bool ClassDB : : has_signal ( StringName p_class , StringName p_signal ) const {
return : : ClassDB : : has_signal ( p_class , p_signal ) ;
2017-01-03 02:03:46 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
Dictionary ClassDB : : get_signal ( StringName p_class , StringName p_signal ) const {
2017-01-03 02:03:46 +00:00
MethodInfo signal ;
2021-08-13 14:46:14 +00:00
if ( : : ClassDB : : get_signal ( p_class , p_signal , & signal ) ) {
2017-01-03 02:03:46 +00:00
return signal . operator Dictionary ( ) ;
} else {
return Dictionary ( ) ;
}
}
2020-05-14 12:29:06 +00:00
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > ClassDB : : get_signal_list ( StringName p_class , bool p_no_inheritance ) const {
2017-01-03 02:03:46 +00:00
List < MethodInfo > signals ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_signal_list ( p_class , & signals , p_no_inheritance ) ;
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > ret ;
2017-01-03 02:03:46 +00:00
2021-07-24 13:46:25 +00:00
for ( const MethodInfo & E : signals ) {
2021-07-16 03:45:57 +00:00
ret . push_back ( E . operator Dictionary ( ) ) ;
2017-01-03 02:03:46 +00:00
}
return ret ;
}
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > ClassDB : : get_property_list ( StringName p_class , bool p_no_inheritance ) const {
2017-01-03 02:03:46 +00:00
List < PropertyInfo > plist ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_property_list ( p_class , & plist , p_no_inheritance ) ;
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > ret ;
2021-07-24 13:46:25 +00:00
for ( const PropertyInfo & E : plist ) {
2021-07-16 03:45:57 +00:00
ret . push_back ( E . operator Dictionary ( ) ) ;
2017-01-03 02:03:46 +00:00
}
return ret ;
}
2021-08-13 14:46:14 +00:00
Variant ClassDB : : get_property ( Object * p_object , const StringName & p_property ) const {
2017-04-09 11:26:48 +00:00
Variant ret ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_property ( p_object , p_property , ret ) ;
2017-04-09 11:26:48 +00:00
return ret ;
}
2021-08-13 14:46:14 +00:00
Error ClassDB : : set_property ( Object * p_object , const StringName & p_property , const Variant & p_value ) const {
2017-04-09 11:26:48 +00:00
Variant ret ;
bool valid ;
2021-08-13 14:46:14 +00:00
if ( ! : : ClassDB : : set_property ( p_object , p_property , p_value , & valid ) ) {
2017-04-09 11:26:48 +00:00
return ERR_UNAVAILABLE ;
} else if ( ! valid ) {
return ERR_INVALID_DATA ;
}
return OK ;
}
2021-08-13 14:46:14 +00:00
bool ClassDB : : has_method ( StringName p_class , StringName p_method , bool p_no_inheritance ) const {
return : : ClassDB : : has_method ( p_class , p_method , p_no_inheritance ) ;
2017-01-03 02:03:46 +00:00
}
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > ClassDB : : get_method_list ( StringName p_class , bool p_no_inheritance ) const {
2017-01-03 02:03:46 +00:00
List < MethodInfo > methods ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_method_list ( p_class , & methods , p_no_inheritance ) ;
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > ret ;
2017-01-03 02:03:46 +00:00
2021-07-24 13:46:25 +00:00
for ( const MethodInfo & E : methods ) {
2018-01-04 18:04:05 +00:00
# ifdef DEBUG_METHODS_ENABLED
2021-07-16 03:45:57 +00:00
ret . push_back ( E . operator Dictionary ( ) ) ;
2018-01-04 18:04:05 +00:00
# else
Dictionary dict ;
2021-07-16 03:45:57 +00:00
dict [ " name " ] = E . name ;
2018-01-04 18:04:05 +00:00
ret . push_back ( dict ) ;
# endif
2017-01-03 02:03:46 +00:00
}
return ret ;
}
2021-08-13 14:46:14 +00:00
PackedStringArray ClassDB : : get_integer_constant_list ( const StringName & p_class , bool p_no_inheritance ) const {
2017-01-03 02:03:46 +00:00
List < String > constants ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_integer_constant_list ( p_class , & constants , p_no_inheritance ) ;
2017-01-03 02:03:46 +00:00
2020-02-17 21:06:54 +00:00
PackedStringArray ret ;
2017-01-03 02:03:46 +00:00
ret . resize ( constants . size ( ) ) ;
2017-03-05 15:44:50 +00:00
int idx = 0 ;
2021-07-24 13:46:25 +00:00
for ( const String & E : constants ) {
2021-07-16 03:45:57 +00:00
ret . set ( idx + + , E ) ;
2017-01-03 02:03:46 +00:00
}
return ret ;
}
2021-08-13 14:46:14 +00:00
bool ClassDB : : has_integer_constant ( const StringName & p_class , const StringName & p_name ) const {
2017-01-03 02:03:46 +00:00
bool success ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : get_integer_constant ( p_class , p_name , & success ) ;
2017-01-03 02:03:46 +00:00
return success ;
}
2022-05-09 09:47:10 +00:00
int64_t ClassDB : : get_integer_constant ( const StringName & p_class , const StringName & p_name ) const {
2017-01-03 02:03:46 +00:00
bool found ;
2022-05-09 09:47:10 +00:00
int64_t c = : : ClassDB : : get_integer_constant ( p_class , p_name , & found ) ;
2017-03-05 15:44:50 +00:00
ERR_FAIL_COND_V ( ! found , 0 ) ;
2017-01-03 02:03:46 +00:00
return c ;
}
2020-05-14 12:29:06 +00:00
2021-09-11 12:31:11 +00:00
bool ClassDB : : has_enum ( const StringName & p_class , const StringName & p_name , bool p_no_inheritance ) const {
return : : ClassDB : : has_enum ( p_class , p_name , p_no_inheritance ) ;
}
PackedStringArray ClassDB : : get_enum_list ( const StringName & p_class , bool p_no_inheritance ) const {
List < StringName > enums ;
: : ClassDB : : get_enum_list ( p_class , & enums , p_no_inheritance ) ;
PackedStringArray ret ;
ret . resize ( enums . size ( ) ) ;
int idx = 0 ;
for ( const StringName & E : enums ) {
ret . set ( idx + + , E ) ;
}
return ret ;
}
PackedStringArray ClassDB : : get_enum_constants ( const StringName & p_class , const StringName & p_enum , bool p_no_inheritance ) const {
List < StringName > constants ;
: : ClassDB : : get_enum_constants ( p_class , p_enum , & constants , p_no_inheritance ) ;
PackedStringArray ret ;
ret . resize ( constants . size ( ) ) ;
int idx = 0 ;
for ( const StringName & E : constants ) {
ret . set ( idx + + , E ) ;
}
return ret ;
}
StringName ClassDB : : get_integer_constant_enum ( const StringName & p_class , const StringName & p_name , bool p_no_inheritance ) const {
return : : ClassDB : : get_integer_constant_enum ( p_class , p_name , p_no_inheritance ) ;
}
2021-08-13 14:46:14 +00:00
bool ClassDB : : is_class_enabled ( StringName p_class ) const {
return : : ClassDB : : is_class_enabled ( p_class ) ;
2017-01-03 02:03:46 +00:00
}
2021-08-13 14:46:14 +00:00
void ClassDB : : _bind_methods ( ) {
: : ClassDB : : bind_method ( D_METHOD ( " get_class_list " ) , & ClassDB : : get_class_list ) ;
: : ClassDB : : bind_method ( D_METHOD ( " get_inheriters_from_class " , " class " ) , & ClassDB : : get_inheriters_from_class ) ;
: : ClassDB : : bind_method ( D_METHOD ( " get_parent_class " , " class " ) , & ClassDB : : get_parent_class ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_exists " , " class " ) , & ClassDB : : class_exists ) ;
: : ClassDB : : bind_method ( D_METHOD ( " is_parent_class " , " class " , " inherits " ) , & ClassDB : : is_parent_class ) ;
: : ClassDB : : bind_method ( D_METHOD ( " can_instantiate " , " class " ) , & ClassDB : : can_instantiate ) ;
: : ClassDB : : bind_method ( D_METHOD ( " instantiate " , " class " ) , & ClassDB : : instantiate ) ;
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_has_signal " , " class " , " signal " ) , & ClassDB : : has_signal ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_signal " , " class " , " signal " ) , & ClassDB : : get_signal ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_signal_list " , " class " , " no_inheritance " ) , & ClassDB : : get_signal_list , DEFVAL ( false ) ) ;
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_get_property_list " , " class " , " no_inheritance " ) , & ClassDB : : get_property_list , DEFVAL ( false ) ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_property " , " object " , " property " ) , & ClassDB : : get_property ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_set_property " , " object " , " property " , " value " ) , & ClassDB : : set_property ) ;
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_has_method " , " class " , " method " , " no_inheritance " ) , & ClassDB : : has_method , DEFVAL ( false ) ) ;
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_get_method_list " , " class " , " no_inheritance " ) , & ClassDB : : get_method_list , DEFVAL ( false ) ) ;
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_get_integer_constant_list " , " class " , " no_inheritance " ) , & ClassDB : : get_integer_constant_list , DEFVAL ( false ) ) ;
2017-01-03 02:03:46 +00:00
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_has_integer_constant " , " class " , " name " ) , & ClassDB : : has_integer_constant ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_integer_constant " , " class " , " name " ) , & ClassDB : : get_integer_constant ) ;
2017-01-03 02:03:46 +00:00
2021-09-11 12:31:11 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " class_has_enum " , " class " , " name " , " no_inheritance " ) , & ClassDB : : has_enum , DEFVAL ( false ) ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_enum_list " , " class " , " no_inheritance " ) , & ClassDB : : get_enum_list , DEFVAL ( false ) ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_enum_constants " , " class " , " enum " , " no_inheritance " ) , & ClassDB : : get_enum_constants , DEFVAL ( false ) ) ;
: : ClassDB : : bind_method ( D_METHOD ( " class_get_integer_constant_enum " , " class " , " name " , " no_inheritance " ) , & ClassDB : : get_integer_constant_enum , DEFVAL ( false ) ) ;
2021-08-13 14:46:14 +00:00
: : ClassDB : : bind_method ( D_METHOD ( " is_class_enabled " , " class " ) , & ClassDB : : is_class_enabled ) ;
2017-01-03 02:03:46 +00:00
}
2021-08-13 14:46:14 +00:00
} // namespace special
2017-01-13 15:51:14 +00:00
2021-08-13 14:46:14 +00:00
////// Engine //////
void Engine : : set_physics_ticks_per_second ( int p_ips ) {
: : Engine : : get_singleton ( ) - > set_physics_ticks_per_second ( p_ips ) ;
2017-01-13 15:51:14 +00:00
}
2020-05-14 12:29:06 +00:00
2021-08-13 14:46:14 +00:00
int Engine : : get_physics_ticks_per_second ( ) const {
return : : Engine : : get_singleton ( ) - > get_physics_ticks_per_second ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
void Engine : : set_physics_jitter_fix ( double p_threshold ) {
: : Engine : : get_singleton ( ) - > set_physics_jitter_fix ( p_threshold ) ;
Add hysteresis to physics timestep count per frame
Add new class _TimerSync to manage timestep calculations.
The new class handles the decisions about simulation progression
previously handled by main::iteration(). It is fed the current timer
ticks and determines how many physics updates are to be run and what
the delta argument to the _process() functions should be.
The new class tries to keep the number of physics updates per frame as
constant as possible from frame to frame. Ideally, it would be N steps
every render frame, but even with perfectly regular rendering, the
general case is that N or N+1 steps are required per frame, for some
fixed N. The best guess for N is stored in typical_physics_steps.
When determining the number of steps to take, no restrictions are
imposed between the choice of typical_physics_steps and
typical_physics_steps+1 steps. Should more or less steps than that be
required, the accumulated remaining time (as before, stored in
time_accum) needs to surpass its boundaries by some minimal threshold.
Once surpassed, typical_physics_steps is updated to allow the new step
count for future updates.
Care is taken that the modified calculation of the number of physics
steps is not observable from game code that only checks the delta
parameters to the _process and _physics_process functions; in addition
to modifying the number of steps, the _process argument is modified as
well to stay in expected bounds. Extra care is taken that the accumulated
steps still sum up to roughly the real elapsed time, up to a maximum
tolerated difference.
To allow the hysteresis code to work correctly on higher refresh
monitors, the number of typical physics steps is not only recorded and
kept consistent for single render frames, but for groups of them.
Currently, up to 12 frames are grouped that way.
The engine parameter physics_jitter_fix controls both the maximum
tolerated difference between wall clock time and summed up _process
arguments and the threshold for changing typical_physics_steps. It is
given in units of the real physics frame slice 1/physics_fps. Set
physics_jitter_fix to 0 to disable the effects of the new code here.
It starts to be effective against the random physics jitter at around
0.02 to 0.05. at values greater than 1 it starts having ill effects on
the engine's ability to react sensibly to dropped frames and framerate
changes.
2018-02-10 23:03:31 +00:00
}
2021-08-13 14:46:14 +00:00
double Engine : : get_physics_jitter_fix ( ) const {
return : : Engine : : get_singleton ( ) - > get_physics_jitter_fix ( ) ;
Add hysteresis to physics timestep count per frame
Add new class _TimerSync to manage timestep calculations.
The new class handles the decisions about simulation progression
previously handled by main::iteration(). It is fed the current timer
ticks and determines how many physics updates are to be run and what
the delta argument to the _process() functions should be.
The new class tries to keep the number of physics updates per frame as
constant as possible from frame to frame. Ideally, it would be N steps
every render frame, but even with perfectly regular rendering, the
general case is that N or N+1 steps are required per frame, for some
fixed N. The best guess for N is stored in typical_physics_steps.
When determining the number of steps to take, no restrictions are
imposed between the choice of typical_physics_steps and
typical_physics_steps+1 steps. Should more or less steps than that be
required, the accumulated remaining time (as before, stored in
time_accum) needs to surpass its boundaries by some minimal threshold.
Once surpassed, typical_physics_steps is updated to allow the new step
count for future updates.
Care is taken that the modified calculation of the number of physics
steps is not observable from game code that only checks the delta
parameters to the _process and _physics_process functions; in addition
to modifying the number of steps, the _process argument is modified as
well to stay in expected bounds. Extra care is taken that the accumulated
steps still sum up to roughly the real elapsed time, up to a maximum
tolerated difference.
To allow the hysteresis code to work correctly on higher refresh
monitors, the number of typical physics steps is not only recorded and
kept consistent for single render frames, but for groups of them.
Currently, up to 12 frames are grouped that way.
The engine parameter physics_jitter_fix controls both the maximum
tolerated difference between wall clock time and summed up _process
arguments and the threshold for changing typical_physics_steps. It is
given in units of the real physics frame slice 1/physics_fps. Set
physics_jitter_fix to 0 to disable the effects of the new code here.
It starts to be effective against the random physics jitter at around
0.02 to 0.05. at values greater than 1 it starts having ill effects on
the engine's ability to react sensibly to dropped frames and framerate
changes.
2018-02-10 23:03:31 +00:00
}
2021-08-13 14:46:14 +00:00
double Engine : : get_physics_interpolation_fraction ( ) const {
return : : Engine : : get_singleton ( ) - > get_physics_interpolation_fraction ( ) ;
2019-07-01 16:42:02 +00:00
}
2021-08-13 14:46:14 +00:00
void Engine : : set_target_fps ( int p_fps ) {
: : Engine : : get_singleton ( ) - > set_target_fps ( p_fps ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
int Engine : : get_target_fps ( ) const {
return : : Engine : : get_singleton ( ) - > get_target_fps ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
double Engine : : get_frames_per_second ( ) const {
return : : Engine : : get_singleton ( ) - > get_frames_per_second ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
uint64_t Engine : : get_physics_frames ( ) const {
return : : Engine : : get_singleton ( ) - > get_physics_frames ( ) ;
2020-01-13 16:53:10 +00:00
}
2021-08-13 14:46:14 +00:00
uint64_t Engine : : get_process_frames ( ) const {
return : : Engine : : get_singleton ( ) - > get_process_frames ( ) ;
2020-01-13 16:53:10 +00:00
}
2021-08-13 14:46:14 +00:00
void Engine : : set_time_scale ( double p_scale ) {
: : Engine : : get_singleton ( ) - > set_time_scale ( p_scale ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
double Engine : : get_time_scale ( ) {
return : : Engine : : get_singleton ( ) - > get_time_scale ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
int Engine : : get_frames_drawn ( ) {
return : : Engine : : get_singleton ( ) - > get_frames_drawn ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
MainLoop * Engine : : get_main_loop ( ) const {
// Needs to remain in OS, since it's actually OS that interacts with it, but it's better exposed here
return : : OS : : get_singleton ( ) - > get_main_loop ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
Dictionary Engine : : get_version_info ( ) const {
return : : Engine : : get_singleton ( ) - > get_version_info ( ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
Dictionary Engine : : get_author_info ( ) const {
return : : Engine : : get_singleton ( ) - > get_author_info ( ) ;
2018-05-16 04:54:22 +00:00
}
2022-08-05 01:41:48 +00:00
TypedArray < Dictionary > Engine : : get_copyright_info ( ) const {
2021-08-13 14:46:14 +00:00
return : : Engine : : get_singleton ( ) - > get_copyright_info ( ) ;
2018-05-16 04:54:22 +00:00
}
2021-08-13 14:46:14 +00:00
Dictionary Engine : : get_donor_info ( ) const {
return : : Engine : : get_singleton ( ) - > get_donor_info ( ) ;
2018-05-16 04:54:22 +00:00
}
2021-08-13 14:46:14 +00:00
Dictionary Engine : : get_license_info ( ) const {
return : : Engine : : get_singleton ( ) - > get_license_info ( ) ;
2018-05-16 04:54:22 +00:00
}
2021-08-13 14:46:14 +00:00
String Engine : : get_license_text ( ) const {
return : : Engine : : get_singleton ( ) - > get_license_text ( ) ;
2018-05-16 04:54:22 +00:00
}
2022-07-20 17:05:49 +00:00
String Engine : : get_architecture_name ( ) const {
return : : Engine : : get_singleton ( ) - > get_architecture_name ( ) ;
}
2021-08-13 14:46:14 +00:00
bool Engine : : is_in_physics_frame ( ) const {
return : : Engine : : get_singleton ( ) - > is_in_physics_frame ( ) ;
2017-06-13 15:49:28 +00:00
}
2021-08-24 22:03:10 +00:00
bool Engine : : has_singleton ( const StringName & p_name ) const {
2021-08-13 14:46:14 +00:00
return : : Engine : : get_singleton ( ) - > has_singleton ( p_name ) ;
2017-11-13 20:46:57 +00:00
}
2021-08-24 22:03:10 +00:00
Object * Engine : : get_singleton_object ( const StringName & p_name ) const {
2021-08-13 14:46:14 +00:00
return : : Engine : : get_singleton ( ) - > get_singleton_object ( p_name ) ;
2017-11-13 20:46:57 +00:00
}
2021-08-24 22:03:10 +00:00
void Engine : : register_singleton ( const StringName & p_name , Object * p_object ) {
ERR_FAIL_COND_MSG ( has_singleton ( p_name ) , " Singleton already registered: " + String ( p_name ) ) ;
2021-09-27 21:17:31 +00:00
ERR_FAIL_COND_MSG ( ! String ( p_name ) . is_valid_identifier ( ) , " Singleton name is not a valid identifier: " + p_name ) ;
2021-08-24 22:03:10 +00:00
: : Engine : : Singleton s ;
s . class_name = p_name ;
s . name = p_name ;
s . ptr = p_object ;
s . user_created = true ;
: : Engine : : get_singleton ( ) - > add_singleton ( s ) ;
}
2022-02-16 12:56:32 +00:00
2021-08-24 22:03:10 +00:00
void Engine : : unregister_singleton ( const StringName & p_name ) {
Fix various typos
Found via ` codespell -q 3 -S ./thirdparty,*.po,./DONORS.md -L ackward,ang,ans,ba,beng,cas,childs,childrens,dof,doubleclick,expct,fave,findn,gird,hist,inout,leapyear,lod,nd,numer,ois,ony,paket,seeked,sinc,switchs,te,uint,varn`
Update editor/import/resource_importer_layered_texture.cpp
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Update doc/classes/TileSetScenesCollectionSource.xml
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Update scene/gui/graph_edit.cpp
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Update scene/resources/animation.cpp
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Update scene/resources/animation.cpp
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Update scene/resources/animation.cpp
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Update scene/gui/rich_text_label.cpp
Co-authored-by: Raul Santos <raulsntos@gmail.com>
Revert previously committed change
2022-01-02 06:03:58 +00:00
ERR_FAIL_COND_MSG ( ! has_singleton ( p_name ) , " Attempt to remove unregistered singleton: " + String ( p_name ) ) ;
2021-08-24 22:03:10 +00:00
ERR_FAIL_COND_MSG ( ! : : Engine : : get_singleton ( ) - > is_singleton_user_created ( p_name ) , " Attempt to remove non-user created singleton: " + String ( p_name ) ) ;
: : Engine : : get_singleton ( ) - > remove_singleton ( p_name ) ;
}
Vector < String > Engine : : get_singleton_list ( ) const {
List < : : Engine : : Singleton > singletons ;
: : Engine : : get_singleton ( ) - > get_singletons ( & singletons ) ;
Vector < String > ret ;
for ( List < : : Engine : : Singleton > : : Element * E = singletons . front ( ) ; E ; E = E - > next ( ) ) {
ret . push_back ( E - > get ( ) . name ) ;
}
return ret ;
}
2022-03-26 15:48:43 +00:00
void Engine : : register_script_language ( ScriptLanguage * p_language ) {
ScriptServer : : register_language ( p_language ) ;
}
int Engine : : get_script_language_count ( ) {
return ScriptServer : : get_language_count ( ) ;
}
ScriptLanguage * Engine : : get_script_language ( int p_index ) const {
return ScriptServer : : get_language ( p_index ) ;
}
2021-08-13 14:46:14 +00:00
void Engine : : set_editor_hint ( bool p_enabled ) {
: : Engine : : get_singleton ( ) - > set_editor_hint ( p_enabled ) ;
2017-08-13 14:21:45 +00:00
}
2021-08-13 14:46:14 +00:00
bool Engine : : is_editor_hint ( ) const {
return : : Engine : : get_singleton ( ) - > is_editor_hint ( ) ;
2017-08-13 14:21:45 +00:00
}
2022-06-25 23:38:20 +00:00
String Engine : : get_write_movie_path ( ) const {
return : : Engine : : get_singleton ( ) - > get_write_movie_path ( ) ;
}
2021-08-13 14:46:14 +00:00
void Engine : : set_print_error_messages ( bool p_enabled ) {
: : Engine : : get_singleton ( ) - > set_print_error_messages ( p_enabled ) ;
2021-05-01 21:09:48 +00:00
}
2021-08-13 14:46:14 +00:00
bool Engine : : is_printing_error_messages ( ) const {
return : : Engine : : get_singleton ( ) - > is_printing_error_messages ( ) ;
2021-05-01 21:09:48 +00:00
}
2021-08-13 14:46:14 +00:00
void Engine : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " set_physics_ticks_per_second " , " physics_ticks_per_second " ) , & Engine : : set_physics_ticks_per_second ) ;
ClassDB : : bind_method ( D_METHOD ( " get_physics_ticks_per_second " ) , & Engine : : get_physics_ticks_per_second ) ;
ClassDB : : bind_method ( D_METHOD ( " set_physics_jitter_fix " , " physics_jitter_fix " ) , & Engine : : set_physics_jitter_fix ) ;
ClassDB : : bind_method ( D_METHOD ( " get_physics_jitter_fix " ) , & Engine : : get_physics_jitter_fix ) ;
ClassDB : : bind_method ( D_METHOD ( " get_physics_interpolation_fraction " ) , & Engine : : get_physics_interpolation_fraction ) ;
ClassDB : : bind_method ( D_METHOD ( " set_target_fps " , " target_fps " ) , & Engine : : set_target_fps ) ;
ClassDB : : bind_method ( D_METHOD ( " get_target_fps " ) , & Engine : : get_target_fps ) ;
2017-01-13 15:51:14 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_time_scale " , " time_scale " ) , & Engine : : set_time_scale ) ;
ClassDB : : bind_method ( D_METHOD ( " get_time_scale " ) , & Engine : : get_time_scale ) ;
2017-01-13 15:51:14 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_frames_drawn " ) , & Engine : : get_frames_drawn ) ;
ClassDB : : bind_method ( D_METHOD ( " get_frames_per_second " ) , & Engine : : get_frames_per_second ) ;
ClassDB : : bind_method ( D_METHOD ( " get_physics_frames " ) , & Engine : : get_physics_frames ) ;
ClassDB : : bind_method ( D_METHOD ( " get_process_frames " ) , & Engine : : get_process_frames ) ;
2017-01-13 15:51:14 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_main_loop " ) , & Engine : : get_main_loop ) ;
2017-01-13 15:51:14 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_version_info " ) , & Engine : : get_version_info ) ;
ClassDB : : bind_method ( D_METHOD ( " get_author_info " ) , & Engine : : get_author_info ) ;
ClassDB : : bind_method ( D_METHOD ( " get_copyright_info " ) , & Engine : : get_copyright_info ) ;
ClassDB : : bind_method ( D_METHOD ( " get_donor_info " ) , & Engine : : get_donor_info ) ;
ClassDB : : bind_method ( D_METHOD ( " get_license_info " ) , & Engine : : get_license_info ) ;
ClassDB : : bind_method ( D_METHOD ( " get_license_text " ) , & Engine : : get_license_text ) ;
2017-06-13 15:49:28 +00:00
2022-07-20 17:05:49 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_architecture_name " ) , & Engine : : get_architecture_name ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_in_physics_frame " ) , & Engine : : is_in_physics_frame ) ;
2017-08-13 14:21:45 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " has_singleton " , " name " ) , & Engine : : has_singleton ) ;
ClassDB : : bind_method ( D_METHOD ( " get_singleton " , " name " ) , & Engine : : get_singleton_object ) ;
2017-11-13 20:46:57 +00:00
2021-08-24 22:03:10 +00:00
ClassDB : : bind_method ( D_METHOD ( " register_singleton " , " name " , " instance " ) , & Engine : : register_singleton ) ;
ClassDB : : bind_method ( D_METHOD ( " unregister_singleton " , " name " ) , & Engine : : unregister_singleton ) ;
ClassDB : : bind_method ( D_METHOD ( " get_singleton_list " ) , & Engine : : get_singleton_list ) ;
2022-03-26 15:48:43 +00:00
ClassDB : : bind_method ( D_METHOD ( " register_script_language " , " language " ) , & Engine : : register_script_language ) ;
ClassDB : : bind_method ( D_METHOD ( " get_script_language_count " ) , & Engine : : get_script_language_count ) ;
ClassDB : : bind_method ( D_METHOD ( " get_script_language " , " index " ) , & Engine : : get_script_language ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_editor_hint " ) , & Engine : : is_editor_hint ) ;
2018-01-11 22:35:12 +00:00
2022-06-25 23:38:20 +00:00
ClassDB : : bind_method ( D_METHOD ( " get_write_movie_path " ) , & Engine : : get_write_movie_path ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " set_print_error_messages " , " enabled " ) , & Engine : : set_print_error_messages ) ;
ClassDB : : bind_method ( D_METHOD ( " is_printing_error_messages " ) , & Engine : : is_printing_error_messages ) ;
2021-05-01 21:09:48 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " print_error_messages " ) , " set_print_error_messages " , " is_printing_error_messages " ) ;
2021-08-11 00:35:16 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : INT , " physics_ticks_per_second " ) , " set_physics_ticks_per_second " , " get_physics_ticks_per_second " ) ;
2018-01-11 22:35:12 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : INT , " target_fps " ) , " set_target_fps " , " get_target_fps " ) ;
Variant: Added 64-bit packed arrays, renamed Variant::REAL to FLOAT.
- Renames PackedIntArray to PackedInt32Array.
- Renames PackedFloatArray to PackedFloat32Array.
- Adds PackedInt64Array and PackedFloat64Array.
- Renames Variant::REAL to Variant::FLOAT for consistency.
Packed arrays are for storing large amount of data and creating stuff like
meshes, buffers. textures, etc. Forcing them to be 64 is a huge waste of
memory. That said, many users requested the ability to have 64 bits packed
arrays for their games, so this is just an optional added type.
For Variant, the float datatype is always 64 bits, and exposed as `float`.
We still have `real_t` which is the datatype that can change from 32 to 64
bits depending on a compile flag (not entirely working right now, but that's
the idea). It affects math related datatypes and code only.
Neither Variant nor PackedArray make use of real_t, which is only intended
for math precision, so the term is removed from there to keep only float.
2020-02-24 18:20:53 +00:00
ADD_PROPERTY ( PropertyInfo ( Variant : : FLOAT , " time_scale " ) , " set_time_scale " , " get_time_scale " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : FLOAT , " physics_jitter_fix " ) , " set_physics_jitter_fix " , " get_physics_jitter_fix " ) ;
2017-01-13 15:51:14 +00:00
}
2021-08-13 14:46:14 +00:00
Engine * Engine : : singleton = nullptr ;
2020-05-18 14:55:49 +00:00
2021-08-13 14:46:14 +00:00
////// EngineDebugger //////
2020-05-18 14:55:49 +00:00
2021-08-13 14:46:14 +00:00
bool EngineDebugger : : is_active ( ) {
return : : EngineDebugger : : is_active ( ) ;
2020-05-18 14:55:49 +00:00
}
2022-02-06 00:55:58 +00:00
void EngineDebugger : : register_profiler ( const StringName & p_name , Ref < EngineProfiler > p_profiler ) {
ERR_FAIL_COND ( p_profiler . is_null ( ) ) ;
ERR_FAIL_COND_MSG ( p_profiler - > is_bound ( ) , " Profiler already registered. " ) ;
ERR_FAIL_COND_MSG ( profilers . has ( p_name ) | | has_profiler ( p_name ) , " Profiler name already in use: " + p_name ) ;
Error err = p_profiler - > bind ( p_name ) ;
ERR_FAIL_COND_MSG ( err ! = OK , " Profiler failed to register with error: " + itos ( err ) ) ;
profilers . insert ( p_name , p_profiler ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
void EngineDebugger : : unregister_profiler ( const StringName & p_name ) {
2020-05-18 14:55:49 +00:00
ERR_FAIL_COND_MSG ( ! profilers . has ( p_name ) , " Profiler not registered: " + p_name ) ;
2022-02-06 00:55:58 +00:00
profilers [ p_name ] - > unbind ( ) ;
2020-05-18 14:55:49 +00:00
profilers . erase ( p_name ) ;
}
2021-08-13 14:46:14 +00:00
bool EngineDebugger : : is_profiling ( const StringName & p_name ) {
return : : EngineDebugger : : is_profiling ( p_name ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
bool EngineDebugger : : has_profiler ( const StringName & p_name ) {
return : : EngineDebugger : : has_profiler ( p_name ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
void EngineDebugger : : profiler_add_frame_data ( const StringName & p_name , const Array & p_data ) {
: : EngineDebugger : : profiler_add_frame_data ( p_name , p_data ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
void EngineDebugger : : profiler_enable ( const StringName & p_name , bool p_enabled , const Array & p_opts ) {
if ( : : EngineDebugger : : get_singleton ( ) ) {
: : EngineDebugger : : get_singleton ( ) - > profiler_enable ( p_name , p_enabled , p_opts ) ;
2020-05-18 14:55:49 +00:00
}
}
2021-08-13 14:46:14 +00:00
void EngineDebugger : : register_message_capture ( const StringName & p_name , const Callable & p_callable ) {
2020-05-18 14:55:49 +00:00
ERR_FAIL_COND_MSG ( captures . has ( p_name ) | | has_capture ( p_name ) , " Capture already registered: " + p_name ) ;
captures . insert ( p_name , p_callable ) ;
Callable & c = captures [ p_name ] ;
2021-08-13 14:46:14 +00:00
: : EngineDebugger : : Capture capture ( & c , & EngineDebugger : : call_capture ) ;
: : EngineDebugger : : register_message_capture ( p_name , capture ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
void EngineDebugger : : unregister_message_capture ( const StringName & p_name ) {
2020-05-18 14:55:49 +00:00
ERR_FAIL_COND_MSG ( ! captures . has ( p_name ) , " Capture not registered: " + p_name ) ;
2021-08-13 14:46:14 +00:00
: : EngineDebugger : : unregister_message_capture ( p_name ) ;
2020-05-18 14:55:49 +00:00
captures . erase ( p_name ) ;
}
2021-08-13 14:46:14 +00:00
bool EngineDebugger : : has_capture ( const StringName & p_name ) {
return : : EngineDebugger : : has_capture ( p_name ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
void EngineDebugger : : send_message ( const String & p_msg , const Array & p_data ) {
ERR_FAIL_COND_MSG ( ! : : EngineDebugger : : is_active ( ) , " Can't send message. No active debugger " ) ;
: : EngineDebugger : : get_singleton ( ) - > send_message ( p_msg , p_data ) ;
2020-05-18 14:55:49 +00:00
}
2021-08-13 14:46:14 +00:00
Error EngineDebugger : : call_capture ( void * p_user , const String & p_cmd , const Array & p_data , bool & r_captured ) {
2020-05-18 14:55:49 +00:00
Callable & capture = * ( Callable * ) p_user ;
if ( capture . is_null ( ) ) {
return FAILED ;
}
Variant cmd = p_cmd , data = p_data ;
const Variant * args [ 2 ] = { & cmd , & data } ;
Variant retval ;
Callable : : CallError err ;
2022-07-28 20:56:41 +00:00
capture . callp ( args , 2 , retval , err ) ;
2020-05-18 14:55:49 +00:00
ERR_FAIL_COND_V_MSG ( err . error ! = Callable : : CallError : : CALL_OK , FAILED , " Error calling 'capture' to callable: " + Variant : : get_callable_error_text ( capture , args , 2 , err ) ) ;
ERR_FAIL_COND_V_MSG ( retval . get_type ( ) ! = Variant : : BOOL , FAILED , " Error calling 'capture' to callable: " + String ( capture ) + " . Return type is not bool. " ) ;
r_captured = retval ;
return OK ;
}
2021-08-13 14:46:14 +00:00
EngineDebugger : : ~ EngineDebugger ( ) {
2021-08-09 20:13:42 +00:00
for ( const KeyValue < StringName , Callable > & E : captures ) {
: : EngineDebugger : : unregister_message_capture ( E . key ) ;
2020-05-18 14:55:49 +00:00
}
captures . clear ( ) ;
}
2021-08-13 14:46:14 +00:00
EngineDebugger * EngineDebugger : : singleton = nullptr ;
void EngineDebugger : : _bind_methods ( ) {
ClassDB : : bind_method ( D_METHOD ( " is_active " ) , & EngineDebugger : : is_active ) ;
2022-02-06 00:55:58 +00:00
ClassDB : : bind_method ( D_METHOD ( " register_profiler " , " name " , " profiler " ) , & EngineDebugger : : register_profiler ) ;
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " unregister_profiler " , " name " ) , & EngineDebugger : : unregister_profiler ) ;
2022-02-06 00:55:58 +00:00
2021-08-13 14:46:14 +00:00
ClassDB : : bind_method ( D_METHOD ( " is_profiling " , " name " ) , & EngineDebugger : : is_profiling ) ;
ClassDB : : bind_method ( D_METHOD ( " has_profiler " , " name " ) , & EngineDebugger : : has_profiler ) ;
ClassDB : : bind_method ( D_METHOD ( " profiler_add_frame_data " , " name " , " data " ) , & EngineDebugger : : profiler_add_frame_data ) ;
ClassDB : : bind_method ( D_METHOD ( " profiler_enable " , " name " , " enable " , " arguments " ) , & EngineDebugger : : profiler_enable , DEFVAL ( Array ( ) ) ) ;
ClassDB : : bind_method ( D_METHOD ( " register_message_capture " , " name " , " callable " ) , & EngineDebugger : : register_message_capture ) ;
ClassDB : : bind_method ( D_METHOD ( " unregister_message_capture " , " name " ) , & EngineDebugger : : unregister_message_capture ) ;
ClassDB : : bind_method ( D_METHOD ( " has_capture " , " name " ) , & EngineDebugger : : has_capture ) ;
ClassDB : : bind_method ( D_METHOD ( " send_message " , " message " , " data " ) , & EngineDebugger : : send_message ) ;
}
} // namespace core_bind