Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

ScriptLanguageExtension¶

Inherits: ScriptLanguage < Object

There is currently no description for this class. Please help us by contributing one!

Methods¶

void	_add_global_constant ( StringName name, Variant value ) virtual
void	_add_named_global_constant ( StringName name, Variant value ) virtual
String	_auto_indent_code ( String code, int from_line, int to_line ) virtual const
bool	_can_inherit_from_file ( ) virtual const
Dictionary	_complete_code ( String code, String path, Object owner ) virtual const
Object	_create_script ( ) virtual const
Dictionary[]	_debug_get_current_stack_info ( ) virtual
String	_debug_get_error ( ) virtual const
Dictionary	_debug_get_globals ( int max_subitems, int max_depth ) virtual
int	_debug_get_stack_level_count ( ) virtual const
String	_debug_get_stack_level_function ( int level ) virtual const
void*	_debug_get_stack_level_instance ( int level ) virtual
int	_debug_get_stack_level_line ( int level ) virtual const
Dictionary	_debug_get_stack_level_locals ( int level, int max_subitems, int max_depth ) virtual
Dictionary	_debug_get_stack_level_members ( int level, int max_subitems, int max_depth ) virtual
String	_debug_parse_stack_level_expression ( int level, String expression, int max_subitems, int max_depth ) virtual
int	_find_function ( String class_name, String function_name ) virtual const
void	_finish ( ) virtual
void	_frame ( ) virtual
Dictionary[]	_get_built_in_templates ( StringName object ) virtual const
PackedStringArray	_get_comment_delimiters ( ) virtual const
String	_get_extension ( ) virtual const
Dictionary	_get_global_class_name ( String path ) virtual const
String	_get_name ( ) virtual const
Dictionary[]	_get_public_annotations ( ) virtual const
Dictionary	_get_public_constants ( ) virtual const
Dictionary[]	_get_public_functions ( ) virtual const
PackedStringArray	_get_recognized_extensions ( ) virtual const
PackedStringArray	_get_reserved_words ( ) virtual const
PackedStringArray	_get_string_delimiters ( ) virtual const
String	_get_type ( ) virtual const
bool	_handles_global_class_type ( String type ) virtual const
bool	_has_named_classes ( ) virtual const
void	_init ( ) virtual
bool	_is_control_flow_keyword ( String keyword ) virtual const
bool	_is_using_templates ( ) virtual
Dictionary	_lookup_code ( String code, String symbol, String path, Object owner ) virtual const
String	_make_function ( String class_name, String function_name, PackedStringArray function_args ) virtual const
Script	_make_template ( String template, String class_name, String base_class_name ) virtual const
Error	_open_in_external_editor ( Script script, int line, int column ) virtual
bool	_overrides_external_editor ( ) virtual
int	_profiling_get_accumulated_data ( ScriptLanguageExtensionProfilingInfo* info_array, int info_max ) virtual
int	_profiling_get_frame_data ( ScriptLanguageExtensionProfilingInfo* info_array, int info_max ) virtual
void	_profiling_start ( ) virtual
void	_profiling_stop ( ) virtual
void	_reload_all_scripts ( ) virtual
void	_reload_tool_script ( Script script, bool soft_reload ) virtual
void	_remove_named_global_constant ( StringName name ) virtual
bool	_supports_builtin_mode ( ) virtual const
bool	_supports_documentation ( ) virtual const
void	_thread_enter ( ) virtual
void	_thread_exit ( ) virtual
Dictionary	_validate ( String script, String path, bool validate_functions, bool validate_errors, bool validate_warnings, bool validate_safe_lines ) virtual const
String	_validate_path ( String path ) virtual const

Enumerations¶

enum LookupResultType:

LookupResultType LOOKUP_RESULT_SCRIPT_LOCATION = 0

LookupResultType LOOKUP_RESULT_CLASS = 1

LookupResultType LOOKUP_RESULT_CLASS_CONSTANT = 2

LookupResultType LOOKUP_RESULT_CLASS_PROPERTY = 3

LookupResultType LOOKUP_RESULT_CLASS_METHOD = 4

LookupResultType LOOKUP_RESULT_CLASS_SIGNAL = 5

LookupResultType LOOKUP_RESULT_CLASS_ENUM = 6

LookupResultType LOOKUP_RESULT_CLASS_TBD_GLOBALSCOPE = 7

LookupResultType LOOKUP_RESULT_CLASS_ANNOTATION = 8

LookupResultType LOOKUP_RESULT_MAX = 9

enum CodeCompletionLocation:

CodeCompletionLocation LOCATION_LOCAL = 0

The option is local to the location of the code completion query - e.g. a local variable.

CodeCompletionLocation LOCATION_PARENT_MASK = 256

The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. 0 for the local class, 1 for the parent, 2 for the grandparent, etc) to store the depth of an option in a the class or a parent class.

CodeCompletionLocation LOCATION_OTHER_USER_CODE = 512

The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).

CodeCompletionLocation LOCATION_OTHER = 1024

The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.

enum CodeCompletionKind:

CodeCompletionKind CODE_COMPLETION_KIND_CLASS = 0

CodeCompletionKind CODE_COMPLETION_KIND_FUNCTION = 1

CodeCompletionKind CODE_COMPLETION_KIND_SIGNAL = 2

CodeCompletionKind CODE_COMPLETION_KIND_VARIABLE = 3

CodeCompletionKind CODE_COMPLETION_KIND_MEMBER = 4

CodeCompletionKind CODE_COMPLETION_KIND_ENUM = 5

CodeCompletionKind CODE_COMPLETION_KIND_CONSTANT = 6

CodeCompletionKind CODE_COMPLETION_KIND_NODE_PATH = 7

CodeCompletionKind CODE_COMPLETION_KIND_FILE_PATH = 8

CodeCompletionKind CODE_COMPLETION_KIND_PLAIN_TEXT = 9

CodeCompletionKind CODE_COMPLETION_KIND_MAX = 10