64b9f30b92
This commit completely removes the RPC_MODE_MASTER ("master" keyword),
and renames the RPC_MODE_PUPPET to RPC_MODE_AUTHORITY ("auth" keyword).
This commit also renames the "Node.[get|set]_network_master" methods to
"Node.[get|set]_network_authority".
This commit also renames the RPC_MODE_REMOTE constant to RPC_MODE_ANY.
RPC_MODE_MASTER in Godot 3.x meant that a given RPC would be callable by
any puppet peer on the master, while RPC_MODE_PUPPET meant that it would
be callable by the master on any puppet.
Beside proving to be very confusing to the user (referring to where it
could be called instead of who can call it) the RPC_MODE_MASTER is quite
useless. It is almost the same as RPC_MODE_REMOTE (anyone can call) with
the exception that the network master cannot. While this could be useful
to check in some case, in such a function you would anyway need to check
in code who is the caller via get_rpc_sender_id(), so adding the check
there for those rare cases does not warrants a dedicated mode.
233 lines
12 KiB
C++
233 lines
12 KiB
C++
/*************************************************************************/
|
|
/* godot_nativescript.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef GODOT_NATIVESCRIPT_H
|
|
#define GODOT_NATIVESCRIPT_H
|
|
|
|
#include <gdnative/gdnative.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef enum {
|
|
GODOT_METHOD_RPC_MODE_DISABLED,
|
|
GODOT_METHOD_RPC_MODE_ANY,
|
|
GODOT_METHOD_RPC_MODE_AUTHORITY,
|
|
} godot_nativescript_method_rpc_mode;
|
|
|
|
typedef enum {
|
|
GODOT_PROPERTY_HINT_NONE, ///< no hint provided.
|
|
GODOT_PROPERTY_HINT_RANGE, ///< hint_text = "min,max,step,slider; //slider is optional"
|
|
GODOT_PROPERTY_HINT_EXP_RANGE, ///< hint_text = "min,max,step", exponential edit
|
|
GODOT_PROPERTY_HINT_ENUM, ///< hint_text= "val1,val2,val3,etc"
|
|
GODOT_PROPERTY_HINT_EXP_EASING, /// exponential easing function (Math::ease)
|
|
GODOT_PROPERTY_HINT_LENGTH, ///< hint_text= "length" (as integer)
|
|
GODOT_PROPERTY_HINT_KEY_ACCEL, ///< hint_text= "length" (as integer)
|
|
GODOT_PROPERTY_HINT_FLAGS, ///< hint_text= "flag1,flag2,etc" (as bit flags)
|
|
GODOT_PROPERTY_HINT_LAYERS_2D_RENDER,
|
|
GODOT_PROPERTY_HINT_LAYERS_2D_PHYSICS,
|
|
GODOT_PROPERTY_HINT_LAYERS_2D_NAVIGATION,
|
|
GODOT_PROPERTY_HINT_LAYERS_3D_RENDER,
|
|
GODOT_PROPERTY_HINT_LAYERS_3D_PHYSICS,
|
|
GODOT_PROPERTY_HINT_LAYERS_3D_NAVIGATION,
|
|
GODOT_PROPERTY_HINT_FILE, ///< a file path must be passed, hint_text (optionally) is a filter "*.png,*.wav,*.doc,"
|
|
GODOT_PROPERTY_HINT_DIR, ///< a directory path must be passed
|
|
GODOT_PROPERTY_HINT_GLOBAL_FILE, ///< a file path must be passed, hint_text (optionally) is a filter "*.png,*.wav,*.doc,"
|
|
GODOT_PROPERTY_HINT_GLOBAL_DIR, ///< a directory path must be passed
|
|
GODOT_PROPERTY_HINT_RESOURCE_TYPE, ///< a resource object type
|
|
GODOT_PROPERTY_HINT_MULTILINE_TEXT, ///< used for string properties that can contain multiple lines
|
|
GODOT_PROPERTY_HINT_PLACEHOLDER_TEXT, ///< used to set a placeholder text for string properties
|
|
GODOT_PROPERTY_HINT_COLOR_NO_ALPHA, ///< used for ignoring alpha component when editing a color
|
|
GODOT_PROPERTY_HINT_IMAGE_COMPRESS_LOSSY,
|
|
GODOT_PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS,
|
|
GODOT_PROPERTY_HINT_OBJECT_ID,
|
|
GODOT_PROPERTY_HINT_TYPE_STRING, ///< a type string, the hint is the base type to choose
|
|
GODOT_PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE, ///< so something else can provide this (used in scripts)
|
|
GODOT_PROPERTY_HINT_METHOD_OF_VARIANT_TYPE, ///< a method of a type
|
|
GODOT_PROPERTY_HINT_METHOD_OF_BASE_TYPE, ///< a method of a base type
|
|
GODOT_PROPERTY_HINT_METHOD_OF_INSTANCE, ///< a method of an instance
|
|
GODOT_PROPERTY_HINT_METHOD_OF_SCRIPT, ///< a method of a script & base
|
|
GODOT_PROPERTY_HINT_PROPERTY_OF_VARIANT_TYPE, ///< a property of a type
|
|
GODOT_PROPERTY_HINT_PROPERTY_OF_BASE_TYPE, ///< a property of a base type
|
|
GODOT_PROPERTY_HINT_PROPERTY_OF_INSTANCE, ///< a property of an instance
|
|
GODOT_PROPERTY_HINT_PROPERTY_OF_SCRIPT, ///< a property of a script & base
|
|
GODOT_PROPERTY_HINT_MAX,
|
|
} godot_nativescript_property_hint;
|
|
|
|
typedef enum {
|
|
GODOT_PROPERTY_USAGE_STORAGE = 1,
|
|
GODOT_PROPERTY_USAGE_EDITOR = 2,
|
|
GODOT_PROPERTY_USAGE_NETWORK = 4,
|
|
GODOT_PROPERTY_USAGE_EDITOR_HELPER = 8,
|
|
GODOT_PROPERTY_USAGE_CHECKABLE = 16, //used for editing global variables
|
|
GODOT_PROPERTY_USAGE_CHECKED = 32, //used for editing global variables
|
|
GODOT_PROPERTY_USAGE_INTERNATIONALIZED = 64, //hint for internationalized strings
|
|
GODOT_PROPERTY_USAGE_GROUP = 128, //used for grouping props in the editor
|
|
GODOT_PROPERTY_USAGE_CATEGORY = 256,
|
|
GODOT_PROPERTY_USAGE_SUBGROUP = 512,
|
|
GODOT_PROPERTY_USAGE_NO_INSTANCE_STATE = 2048,
|
|
GODOT_PROPERTY_USAGE_RESTART_IF_CHANGED = 4096,
|
|
GODOT_PROPERTY_USAGE_SCRIPT_VARIABLE = 8192,
|
|
GODOT_PROPERTY_USAGE_STORE_IF_NULL = 16384,
|
|
GODOT_PROPERTY_USAGE_ANIMATE_AS_TRIGGER = 32768,
|
|
GODOT_PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED = 65536,
|
|
|
|
GODOT_PROPERTY_USAGE_DEFAULT = GODOT_PROPERTY_USAGE_STORAGE | GODOT_PROPERTY_USAGE_EDITOR | GODOT_PROPERTY_USAGE_NETWORK,
|
|
GODOT_PROPERTY_USAGE_DEFAULT_INTL = GODOT_PROPERTY_USAGE_STORAGE | GODOT_PROPERTY_USAGE_EDITOR | GODOT_PROPERTY_USAGE_NETWORK | GODOT_PROPERTY_USAGE_INTERNATIONALIZED,
|
|
GODOT_PROPERTY_USAGE_NOEDITOR = GODOT_PROPERTY_USAGE_STORAGE | GODOT_PROPERTY_USAGE_NETWORK,
|
|
} godot_nativescript_property_usage_flags;
|
|
|
|
typedef struct {
|
|
godot_nativescript_method_rpc_mode rset_type;
|
|
|
|
godot_int type;
|
|
godot_nativescript_property_hint hint;
|
|
godot_string hint_string;
|
|
godot_nativescript_property_usage_flags usage;
|
|
godot_variant default_value;
|
|
} godot_nativescript_property_attributes;
|
|
|
|
typedef struct {
|
|
// instance pointer, method_data - return user data
|
|
GDCALLINGCONV void *(*create_func)(godot_object *, void *);
|
|
void *method_data;
|
|
GDCALLINGCONV void (*free_func)(void *);
|
|
} godot_nativescript_instance_create_func;
|
|
|
|
typedef struct {
|
|
// instance pointer, method data, user data
|
|
GDCALLINGCONV void (*destroy_func)(godot_object *, void *, void *);
|
|
void *method_data;
|
|
GDCALLINGCONV void (*free_func)(void *);
|
|
} godot_nativescript_instance_destroy_func;
|
|
|
|
void GDAPI godot_nativescript_register_class(void *p_gdnative_handle, const char *p_name, const char *p_base, godot_nativescript_instance_create_func p_create_func, godot_nativescript_instance_destroy_func p_destroy_func);
|
|
|
|
void GDAPI godot_nativescript_register_tool_class(void *p_gdnative_handle, const char *p_name, const char *p_base, godot_nativescript_instance_create_func p_create_func, godot_nativescript_instance_destroy_func p_destroy_func);
|
|
|
|
typedef struct {
|
|
godot_nativescript_method_rpc_mode rpc_type;
|
|
} godot_nativescript_method_attributes;
|
|
|
|
typedef struct {
|
|
godot_string name;
|
|
|
|
godot_variant_type type;
|
|
godot_nativescript_property_hint hint;
|
|
godot_string hint_string;
|
|
} godot_nativescript_method_argument;
|
|
|
|
typedef struct {
|
|
// instance pointer, method data, user data, num args, args - return result as varaint
|
|
GDCALLINGCONV godot_variant (*method)(godot_object *, void *, void *, int, godot_variant **);
|
|
void *method_data;
|
|
GDCALLINGCONV void (*free_func)(void *);
|
|
} godot_nativescript_instance_method;
|
|
|
|
void GDAPI godot_nativescript_register_method(void *p_gdnative_handle, const char *p_name, const char *p_function_name, godot_nativescript_method_attributes p_attr, godot_nativescript_instance_method p_method);
|
|
void GDAPI godot_nativescript_set_method_argument_information(void *p_gdnative_handle, const char *p_name, const char *p_function_name, int p_num_args, const godot_nativescript_method_argument *p_args);
|
|
|
|
typedef struct {
|
|
// instance pointer, method data, user data, value
|
|
GDCALLINGCONV void (*set_func)(godot_object *, void *, void *, godot_variant *);
|
|
void *method_data;
|
|
GDCALLINGCONV void (*free_func)(void *);
|
|
} godot_nativescript_property_set_func;
|
|
|
|
typedef struct {
|
|
// instance pointer, method data, user data, value
|
|
GDCALLINGCONV godot_variant (*get_func)(godot_object *, void *, void *);
|
|
void *method_data;
|
|
GDCALLINGCONV void (*free_func)(void *);
|
|
} godot_nativescript_property_get_func;
|
|
|
|
void GDAPI godot_nativescript_register_property(void *p_gdnative_handle, const char *p_name, const char *p_path, godot_nativescript_property_attributes *p_attr, godot_nativescript_property_set_func p_set_func, godot_nativescript_property_get_func p_get_func);
|
|
|
|
typedef struct {
|
|
godot_string name;
|
|
godot_int type;
|
|
godot_nativescript_property_hint hint;
|
|
godot_string hint_string;
|
|
godot_nativescript_property_usage_flags usage;
|
|
godot_variant default_value;
|
|
} godot_nativescript_signal_argument;
|
|
|
|
typedef struct {
|
|
godot_string name;
|
|
int num_args;
|
|
godot_nativescript_signal_argument *args;
|
|
int num_default_args;
|
|
godot_variant *default_args;
|
|
} godot_nativescript_signal;
|
|
|
|
void GDAPI godot_nativescript_register_signal(void *p_gdnative_handle, const char *p_name, const godot_nativescript_signal *p_signal);
|
|
|
|
void GDAPI *godot_nativescript_get_userdata(godot_object *p_instance);
|
|
|
|
// documentation
|
|
|
|
void GDAPI godot_nativescript_set_class_documentation(void *p_gdnative_handle, const char *p_name, godot_string p_documentation);
|
|
void GDAPI godot_nativescript_set_method_documentation(void *p_gdnative_handle, const char *p_name, const char *p_function_name, godot_string p_documentation);
|
|
void GDAPI godot_nativescript_set_property_documentation(void *p_gdnative_handle, const char *p_name, const char *p_path, godot_string p_documentation);
|
|
void GDAPI godot_nativescript_set_signal_documentation(void *p_gdnative_handle, const char *p_name, const char *p_signal_name, godot_string p_documentation);
|
|
|
|
// type tag API
|
|
|
|
void GDAPI godot_nativescript_set_global_type_tag(int p_idx, const char *p_name, const void *p_type_tag);
|
|
const void GDAPI *godot_nativescript_get_global_type_tag(int p_idx, const char *p_name);
|
|
|
|
void GDAPI godot_nativescript_set_type_tag(void *p_gdnative_handle, const char *p_name, const void *p_type_tag);
|
|
const void GDAPI *godot_nativescript_get_type_tag(const godot_object *p_object);
|
|
|
|
// instance binding API
|
|
|
|
typedef struct {
|
|
GDCALLINGCONV void *(*alloc_instance_binding_data)(void *, const void *, godot_object *);
|
|
GDCALLINGCONV void (*free_instance_binding_data)(void *, void *);
|
|
GDCALLINGCONV void (*refcount_incremented_instance_binding)(void *, godot_object *);
|
|
GDCALLINGCONV bool (*refcount_decremented_instance_binding)(void *, godot_object *);
|
|
void *data;
|
|
GDCALLINGCONV void (*free_func)(void *);
|
|
} godot_nativescript_instance_binding_functions;
|
|
|
|
int GDAPI godot_nativescript_register_instance_binding_data_functions(godot_nativescript_instance_binding_functions p_binding_functions);
|
|
void GDAPI godot_nativescript_unregister_instance_binding_data_functions(int p_idx);
|
|
|
|
void GDAPI *godot_nativescript_get_instance_binding_data(int p_idx, godot_object *p_object);
|
|
|
|
void GDAPI godot_nativescript_profiling_add_data(const char *p_signature, uint64_t p_time);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|